[1.1.8] Implement an opt-in improved JS framework (Snowboard)

.github/workflows/code-quality.yaml

@@ -37,3 +37,24 @@ jobs:
       - name: Run code quality checks (on pull request)
         if: github.event_name == 'pull_request'
         run: ./.github/workflows/utilities/phpcs-pr ${{ github.base_ref }}
+  codeQualityJS:
+    runs-on: ubuntu-latest
+    name: JavaScript
+    steps:
+      - name: Checkout changes
+        uses: actions/checkout@v2
+        with:
+            fetch-depth: 0
+
+      - name: Install Node
+        uses: actions/setup-node@v1
+        with:
+            node-version: 12
+
+      - name: Install Node dependencies
+        working-directory: ./modules/system/assets/js/snowboard
+        run: npm install
+
+      - name: Run code quality checks
+        working-directory: ./modules/system/assets/js/snowboard
+        run: npx eslint .

.github/workflows/tests.yml

@@ -24,9 +24,11 @@ jobs:
             node-version: 12
 
       - name: Install Node dependencies
+        working-directory: ./tests/js
         run: npm install
 
       - name: Run tests
+        working-directory: ./tests/js
         run: npm run test
   phpUnitTests:
     strategy:

.gitpod.yml

@@ -27,10 +27,10 @@ vscode:
 
 github:
   prebuilds:
-    master: true
+    master: false
     branches: false
-    pullRequests: true
+    pullRequests: false
     pullRequestsFromForks: false
-    addCheck: true
+    addCheck: false
     addComment: false
     addBadge: true

composer.json

@@ -83,5 +83,11 @@
             "replace": false,
             "merge-dev": false
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "wikimedia/composer-merge-plugin": true
+        }
     }
 }

modules/cms/twig/Extension.php

@@ -73,6 +73,7 @@ public function getTokenParsers()
             new PlaceholderTokenParser,
             new DefaultTokenParser,
             new FrameworkTokenParser,
+            new SnowboardTokenParser,
             new ComponentTokenParser,
             new FlashTokenParser,
             new ScriptsTokenParser,

modules/cms/twig/SnowboardNode.php

@@ -0,0 +1,65 @@
+<?php namespace Cms\Twig;
+
+use Config;
+use Request;
+use System\Models\Parameter;
+use System\Classes\CombineAssets;
+use Twig\Node\Node as TwigNode;
+use Twig\Compiler as TwigCompiler;
+
+/**
+ * Represents a "snowboard" node
+ *
+ * @package winter\wn-cms-module
+ * @author Winter CMS
+ */
+class SnowboardNode extends TwigNode
+{
+    /**
+     * @var bool Indicates if the base Snowboard framework is already loaded, in case of multiple uses of this tag.
+     */
+    public static $baseLoaded = false;
+
+    public function __construct(array $modules, $lineno, $tag = 'snowboard')
+    {
+        parent::__construct([], ['modules' => $modules], $lineno, $tag);
+    }
+
+    /**
+     * Compiles the node to PHP.
+     *
+     * @param TwigCompiler $compiler A TwigCompiler instance
+     */
+    public function compile(TwigCompiler $compiler)
+    {
+        $build = Parameter::get('system::core.build', 'winter');
+        $cacheBust = '?v=' . $build;
+        $modules = $this->getAttribute('modules');
+
+        $compiler
+            ->addDebugInfo($this)
+            ->write("\$_minify = ".CombineAssets::class."::instance()->useMinify;" . PHP_EOL);
+
+        $moduleMap = [
+            'base' => (Config::get('app.debug', false) === true) ? 'snowboard.base.debug' : 'snowboard.base',
+            'request' => 'snowboard.request',
+            'attr' => 'snowboard.data-attr',
+            'extras' => 'snowboard.extras',
+        ];
+        $basePath = Request::getBasePath() . '/modules/system/assets/js/snowboard/build/';
+
+        if (!static::$baseLoaded) {
+            // Add base script
+            $baseJs = $moduleMap['base'];
+            $compiler
+                ->write("echo '<script src=\"${basePath}${baseJs}.js${cacheBust}\"></script>'.PHP_EOL;" . PHP_EOL);
+            static::$baseLoaded = true;
+        }
+
+        foreach ($modules as $module) {
+            $moduleJs = $moduleMap[$module];
+            $compiler
+                ->write("echo '<script src=\"${basePath}${moduleJs}.js${cacheBust}\"></script>'.PHP_EOL;" . PHP_EOL);
+        }
+    }
+}

modules/cms/twig/SnowboardTokenParser.php

@@ -0,0 +1,60 @@
+<?php namespace Cms\Twig;
+
+use Twig\Token as TwigToken;
+use Twig\TokenParser\AbstractTokenParser as TwigTokenParser;
+
+/**
+ * Parser for the `{% snowboard %}` Twig tag.
+ *
+ * @package winter\wn-cms-module
+ * @author Winter CMS
+ */
+class SnowboardTokenParser extends TwigTokenParser
+{
+    /**
+     * @inheritDoc
+     */
+    public function parse(TwigToken $token)
+    {
+        $lineno = $token->getLine();
+        $stream = $this->parser->getStream();
+
+        $modules = [];
+
+        do {
+            $token = $stream->next();
+
+            if ($token->getType() === TwigToken::NAME_TYPE) {
+                $modules[] = $token->getValue();
+            }
+        } while ($token->getType() !== TwigToken::BLOCK_END_TYPE);
+
+        // Filter out invalid types
+        $modules = array_filter(
+            array_map(function ($item) {
+                return strtolower($item);
+            }, $modules),
+            function ($item) {
+                return in_array($item, ['request', 'attr', 'extras', 'all']);
+            }
+        );
+
+        if (in_array('all', $modules)) {
+            $modules = [
+                'request',
+                'attr',
+                'extras',
+            ];
+        }
+
+        return new SnowboardNode($modules, $lineno, $this->getTag());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getTag()
+    {
+        return 'snowboard';
+    }
+}

modules/system/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');
         });
     }
 

modules/system/assets/js/snowboard/.eslintignore

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