Merge pull request #401 from wintercms/wip/snowboard

[1.1.8] Implement an opt-in improved JS framework (Snowboard). Documented by wintercms/docs#45

ServiceProvider.php

@@ -32,6 +32,7 @@
 use Winter\Storm\Router\Helper as RouterHelper;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Facades\Schema;
+use System\Classes\MixAssets;
 
 class ServiceProvider extends ModuleServiceProvider
 {
@@ -251,32 +252,37 @@ protected function registerConsole()
  /*
  * Register console commands
  */
- $this->registerConsoleCommand('winter.up', 'System\Console\WinterUp');
- $this->registerConsoleCommand('winter.down', 'System\Console\WinterDown');
- $this->registerConsoleCommand('winter.update', 'System\Console\WinterUpdate');
- $this->registerConsoleCommand('winter.util', 'System\Console\WinterUtil');
- $this->registerConsoleCommand('winter.mirror', 'System\Console\WinterMirror');
- $this->registerConsoleCommand('winter.fresh', 'System\Console\WinterFresh');
- $this->registerConsoleCommand('winter.env', 'System\Console\WinterEnv');
- $this->registerConsoleCommand('winter.install', 'System\Console\WinterInstall');
- $this->registerConsoleCommand('winter.passwd', 'System\Console\WinterPasswd');
- $this->registerConsoleCommand('winter.version', 'System\Console\WinterVersion');
- $this->registerConsoleCommand('winter.manifest', 'System\Console\WinterManifest');
- $this->registerConsoleCommand('winter.test', 'System\Console\WinterTest');
-
- $this->registerConsoleCommand('plugin.install', 'System\Console\PluginInstall');
- $this->registerConsoleCommand('plugin.remove', 'System\Console\PluginRemove');
- $this->registerConsoleCommand('plugin.disable', 'System\Console\PluginDisable');
- $this->registerConsoleCommand('plugin.enable', 'System\Console\PluginEnable');
- $this->registerConsoleCommand('plugin.refresh', 'System\Console\PluginRefresh');
- $this->registerConsoleCommand('plugin.rollback', 'System\Console\PluginRollback');
- $this->registerConsoleCommand('plugin.list', 'System\Console\PluginList');
-
- $this->registerConsoleCommand('theme.install', 'System\Console\ThemeInstall');
- $this->registerConsoleCommand('theme.remove', 'System\Console\ThemeRemove');
- $this->registerConsoleCommand('theme.list', 'System\Console\ThemeList');
- $this->registerConsoleCommand('theme.use', 'System\Console\ThemeUse');
- $this->registerConsoleCommand('theme.sync', 'System\Console\ThemeSync');
+ $this->registerConsoleCommand('winter.up', \System\Console\WinterUp::class);
+ $this->registerConsoleCommand('winter.down', \System\Console\WinterDown::class);
+ $this->registerConsoleCommand('winter.update', \System\Console\WinterUpdate::class);
+ $this->registerConsoleCommand('winter.util', \System\Console\WinterUtil::class);
+ $this->registerConsoleCommand('winter.mirror', \System\Console\WinterMirror::class);
+ $this->registerConsoleCommand('winter.fresh', \System\Console\WinterFresh::class);
+ $this->registerConsoleCommand('winter.env', \System\Console\WinterEnv::class);
+ $this->registerConsoleCommand('winter.install', \System\Console\WinterInstall::class);
+ $this->registerConsoleCommand('winter.passwd', \System\Console\WinterPasswd::class);
+ $this->registerConsoleCommand('winter.version', \System\Console\WinterVersion::class);
+ $this->registerConsoleCommand('winter.manifest', \System\Console\WinterManifest::class);
+ $this->registerConsoleCommand('winter.test', \System\Console\WinterTest::class);
+
+ $this->registerConsoleCommand('plugin.install', \System\Console\PluginInstall::class);
+ $this->registerConsoleCommand('plugin.remove', \System\Console\PluginRemove::class);
+ $this->registerConsoleCommand('plugin.disable', \System\Console\PluginDisable::class);
+ $this->registerConsoleCommand('plugin.enable', \System\Console\PluginEnable::class);
+ $this->registerConsoleCommand('plugin.refresh', \System\Console\PluginRefresh::class);
+ $this->registerConsoleCommand('plugin.rollback', \System\Console\PluginRollback::class);
+ $this->registerConsoleCommand('plugin.list', \System\Console\PluginList::class);
+
+ $this->registerConsoleCommand('theme.install', \System\Console\ThemeInstall::class);
+ $this->registerConsoleCommand('theme.remove', \System\Console\ThemeRemove::class);
+ $this->registerConsoleCommand('theme.list', \System\Console\ThemeList::class);
+ $this->registerConsoleCommand('theme.use', \System\Console\ThemeUse::class);
+ $this->registerConsoleCommand('theme.sync', \System\Console\ThemeSync::class);
+
+ $this->registerConsoleCommand('mix.install', \System\Console\MixInstall::class);
+ $this->registerConsoleCommand('mix.list', \System\Console\MixList::class);
+ $this->registerConsoleCommand('mix.compile', \System\Console\MixCompile::class);
+ $this->registerConsoleCommand('mix.watch', \System\Console\MixWatch::class);
  }
 
  /*
@@ -560,6 +566,11 @@ protected function registerAssetBundles()
  $combiner->registerBundle('~/modules/system/assets/js/framework.js');
  $combiner->registerBundle('~/modules/system/assets/js/framework.combined.js');
  $combiner->registerBundle('~/modules/system/assets/less/framework.extras.less');
+ $combiner->registerBundle('~/modules/system/assets/less/snowboard.extras.less');
+ });
+
+ MixAssets::registerCallback(function ($mix) {
+ $mix->registerPackage('snowboard', '~/modules/system/assets/js/snowboard/winter.mix.js');
  });
  }
 

assets/js/snowboard/.eslintignore

@@ -0,0 +1,2 @@
+**/node_modules/**
+build/*.js

assets/js/snowboard/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+ "env": {
+ "es6": true,
+ "browser": true
+ },
+ "globals": {
+ "Snowboard": "writable"
+ },
+ "extends": "airbnb-base",
+ "rules": {
+ "class-methods-use-this": ["off"],
+ "indent": ["error", 4, {
+ "SwitchCase": 1
+ }],
+ "max-len": ["off"],
+ "new-cap": ["error", { "properties": false }],
+ "no-alert": ["off"],
+ "no-param-reassign": ["error", {
+ "props": false
+ }]
+ }
+}

assets/js/snowboard/.gitignore

@@ -0,0 +1,3 @@
+# Ignore packages
+node_modules
+package-lock.json

assets/js/snowboard/abstracts/PluginBase.js

@@ -0,0 +1,48 @@
+/**
+ * Plugin base abstract.
+ *
+ * This class provides the base functionality for all plugins.
+ *
+ * @copyright 2021 Winter.
+ * @author Ben Thomson <[email protected]>
+ */
+export default class PluginBase {
+ /**
+ * Constructor.
+ *
+ * The constructor is provided the Snowboard framework instance.
+ *
+ * @param {Snowboard} snowboard
+ */
+ constructor(snowboard) {
+ this.snowboard = snowboard;
+ }
+
+ /**
+ * Defines the required plugins for this specific module to work.
+ *
+ * @returns {string[]} An array of plugins required for this module to work, as strings.
+ */
+ dependencies() {
+ return [];
+ }
+
+ /**
+ * Defines the listener methods for global events.
+ *
+ * @returns {Object}
+ */
+ listens() {
+ return {};
+ }
+
+ /**
+ * Destructor.
+ *
+ * Fired when this plugin is removed.
+ */
+ destructor() {
+ this.detach();
+ delete this.snowboard;
+ }
+}

assets/js/snowboard/abstracts/Singleton.js

@@ -0,0 +1,15 @@
+import PluginBase from './PluginBase';
+
+/**
+ * Singleton plugin abstract.
+ *
+ * This is a special definition class that the Snowboard framework will use to interpret the current plugin as a
+ * "singleton". This will ensure that only one instance of the plugin class is used across the board.
+ *
+ * Singletons are initialised on the "domReady" event by default.
+ *
+ * @copyright 2021 Winter.
+ * @author Ben Thomson <[email protected]>
+ */
+export default class Singleton extends PluginBase {
+}