Merge branch 'MDL-61460-master-4' of git://github.com/bmbrands/moodle

.gitignore

@@ -51,3 +51,5 @@ moodle-plugin-ci.phar
 .eslintignore
 .stylelintignore
 /jsdoc
+/admin/tool/componentlibrary/docs
+/admin/tool/componentlibrary/hugo/site/data/my-index.json

.grunt/tasks/componentlibrary.js

@@ -0,0 +1,140 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+/* jshint node: true, browser: false */
+/* eslint-env node */
+
+/**
+ * Component Library build tasks.
+ *
+ * @copyright  2021 Andrew Nicols
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+
+    /**
+     * Get a child path of the component library.
+     *
+     * @param   {string} path
+     * @returns {string}
+     */
+    const getCLPath = path => `admin/tool/componentlibrary/${path}`;
+
+    /**
+     * Get a spawn handler.
+     *
+     * This is a generic function to write the spawn output, and then to exit if required and mark the async task as
+     * complete.
+     *
+     * @param   {Promise} done
+     * @returns {function}
+     */
+    const getSpawnHandler = done => (error, result, code) => {
+        grunt.log.write(result);
+
+        if (error) {
+            process.exit(code);
+        }
+        done();
+    };
+
+    /**
+     * Spawn a function against Node with the provided args.
+     *
+     * @param   {array} args
+     * @returns {object}
+     */
+    const spawnNodeCall = args => grunt.util.spawn({
+        cmd: 'node',
+        args,
+    }, getSpawnHandler(grunt.task.current.async()));
+
+    /**
+     * Build the docs using Hugo.
+     *
+     * @returns {Object} Reference to the spawned task
+     */
+    const docsBuild = () => spawnNodeCall([
+        'node_modules/.bin/hugo',
+        '--config', getCLPath('config.yml'),
+        '--cleanDestinationDir',
+    ]);
+
+    /**
+     * Build the docs index using the hugo-lunr-indexer.
+     *
+     * @returns {Object} Reference to the spawned task
+     */
+    const indexBuild = () => spawnNodeCall([
+        'node_modules/hugo-lunr-indexer/bin/hli.js',
+        '-i', getCLPath('content/**'),
+        '-o', getCLPath('hugo/site/data/my-index.json'),
+        '-l', 'yaml',
+        '-d', '---',
+    ]);
+
+    /**
+     * Build the hugo CSS.
+     *
+     * @returns {Object} Reference to the spawned task
+     */
+    const cssBuild = () => spawnNodeCall([
+        'node_modules/.bin/node-sass',
+        '--output-style', 'expanded',
+        '--source-map', true,
+        '--source-map-contents', true,
+        '--precision', 6,
+        getCLPath('hugo/scss/docs.scss'),
+        '-o', getCLPath('hugo/dist/css/'),
+    ]);
+
+    // Register the various component library tasks.
+    grunt.registerTask('componentlibrary:docsBuild', 'Build the component library', docsBuild);
+    grunt.registerTask('componentlibrary:cssBuild', 'Build the component library', cssBuild);
+    grunt.registerTask('componentlibrary:indexBuild', 'Build the component library', indexBuild);
+    grunt.registerTask('componentlibrary', 'Build the component library', [
+        'componentlibrary:docsBuild',
+        'componentlibrary:cssBuild',
+        'componentlibrary:indexBuild',
+    ]);
+
+    grunt.config.merge({
+        watch: {
+            componentLibraryDocs: {
+                files: [
+                    getCLPath('content/**/*.md'),
+                    getCLPath('hugo'),
+                ],
+                tasks: ['componentlibrary:docsBuild', 'componentlibrary:indexBuild'],
+            },
+            componentLibraryCSS: {
+                files: [
+                    getCLPath('hugo/scss/**/*.scss'),
+                    'hugo',
+                ],
+                tasks: ['componentlibrary:cssBuild'],
+            },
+        },
+    });
+
+    // Add the 'componentlibrary' task as a startup task.
+    grunt.moodleEnv.startupTasks.push('componentlibrary');
+
+    return {
+        docsBuild,
+        cssBuild,
+        indexBuild,
+    };
+};

.grunt/tasks/gherkinlint.js

@@ -85,5 +85,8 @@ module.exports = grunt => {
         },
     });
 
+    // Add the 'gherkinlint' task as a startup task.
+    grunt.moodleEnv.startupTasks.push('gherkinlint');
+
     return handler;
 };

.grunt/tasks/ignorefiles.js

@@ -50,6 +50,7 @@ module.exports = grunt => {
             'theme/boost/style/moodle.css',
             'theme/classic/style/moodle.css',
             'jsdoc/styles/*.css',
+            'admin/tool/componentlibrary/hugo/dist/css/docs.css',
         ].concat(thirdPartyPaths);
         grunt.file.write('.stylelintignore', stylelintIgnores.join('\n') + '\n');
     };

.grunt/tasks/javascript.js

@@ -126,6 +126,9 @@ module.exports = grunt => {
         },
     });
 
+    // Add the 'js' task as a startup task.
+    grunt.moodleEnv.startupTasks.push('js');
+
     // On watch, we dynamically modify config to build only affected files. This
     // method is slightly complicated to deal with multiple changed files at once (copied
     // from the grunt-contrib-watch readme).

.grunt/tasks/startup.js

@@ -34,10 +34,8 @@ module.exports = grunt => {
         } else if (grunt.moodleEnv.inAMD) {
             grunt.task.run('amd');
         } else {
-            // Run them all!.
-            grunt.task.run('css');
-            grunt.task.run('js');
-            grunt.task.run('gherkinlint');
+            // Run all of the requested startup tasks.
+            grunt.moodleEnv.startupTasks.forEach(taskName => grunt.task.run(taskName));
         }
     };
 

.grunt/tasks/style.js

@@ -29,4 +29,7 @@ module.exports = grunt => {
 
     // Load the SASS tasks.
     require('./sass')(grunt);
+
+    // Add the 'css' task as a startup task.
+    grunt.moodleEnv.startupTasks.push('css');
 };

Gruntfile.js

@@ -246,13 +246,16 @@ module.exports = function(grunt) {
         require(path.resolve(`./.grunt/tasks/${name}.js`))(grunt);
     };
 
+    // Startup tasks.
+    grunt.moodleEnv.startupTasks = [];
 
     // Add Moodle task configuration.
     addTask('gherkinlint', grunt);
     addTask('ignorefiles', grunt);
 
     addTask('javascript', grunt);
     addTask('style', grunt);
+    addTask('componentlibrary', grunt);
 
     addTask('watch', grunt);
     addTask('startup', grunt);