# Generated by "grunt ignorefiles"
+!/.grunt
*/**/yui/src/*/meta/
*/**/build/
node_modules/
theme/boost/amd/src/bootstrap/carousel.js
theme/boost/amd/src/bootstrap/collapse.js
theme/boost/amd/src/bootstrap/dropdown.js
-theme/boost/amd/src/bootstrap/index.js
theme/boost/amd/src/bootstrap/modal.js
theme/boost/amd/src/bootstrap/popover.js
theme/boost/amd/src/bootstrap/tools/sanitizer.js
theme/boost/amd/src/bootstrap/toast.js
theme/boost/amd/src/bootstrap/tooltip.js
theme/boost/amd/src/bootstrap/util.js
-theme/boost/scss/fontawesome/
\ No newline at end of file
+theme/boost/amd/src/index.js
+theme/boost/scss/fontawesome/
}
},
{
- files: ["**/amd/src/*.js", "**/amd/src/**/*.js", "Gruntfile*.js", "babel-plugin-add-module-to-define.js"],
+ files: ["**/amd/src/*.js", "**/amd/src/**/*.js", "Gruntfile.js", ".grunt/*.js", ".grunt/tasks/*.js"],
// We support es6 now. Woot!
env: {
es6: true
name: Core
-on: [push]
+on:
+ push:
+ branches-ignore:
+ - master
+ - MOODLE_[0-9]+_STABLE
+ tags-ignore:
+ - v[0-9]+.[0-9]+.[0-9]+*
env:
php: 7.4
atlassian-ide-plugin.xml
/node_modules/
/.vscode/
+moodle-plugin-ci.phar
const fs = require('fs');
const path = require('path');
const cwd = process.cwd();
- const ComponentList = require(path.resolve('GruntfileComponents.js'));
+ const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
/**
* Search the list of components that match the given file name
return componentData;
};
+/**
+ * Get the list of component paths.
+ *
+ * @param {string} relativeTo
+ * @returns {array}
+ */
+const getComponentPaths = (relativeTo = '') => fetchComponentData().pathList.map(componentPath => {
+ return componentPath.replace(relativeTo, '');
+});
+
/**
* Get the list of paths to build AMD sources.
*
.sort();
};
+/**
+ * Get the list of thirdparty library paths.
+ *
+ * @returns {array}
+ */
+const getThirdPartyPaths = () => {
+ const DOMParser = require('xmldom').DOMParser;
+ const fs = require('fs');
+ const path = require('path');
+ const xpath = require('xpath');
+
+ const thirdpartyfiles = getThirdPartyLibsList(fs.realpathSync('./'));
+ const libs = ['node_modules/', 'vendor/'];
+
+ const addLibToList = lib => {
+ if (!lib.match('\\*') && fs.statSync(lib).isDirectory()) {
+ // Ensure trailing slash on dirs.
+ lib = lib.replace(/\/?$/, '/');
+ }
+
+ // Look for duplicate paths before adding to array.
+ if (libs.indexOf(lib) === -1) {
+ libs.push(lib);
+ }
+ };
+
+ thirdpartyfiles.forEach(function(file) {
+ const dirname = path.dirname(file);
+
+ const xmlContent = fs.readFileSync(file, 'utf8');
+ const doc = new DOMParser().parseFromString(xmlContent);
+ const nodes = xpath.select("/libraries/library/location/text()", doc);
+
+ nodes.forEach(function(node) {
+ let lib = path.posix.join(dirname, node.toString());
+ addLibToList(lib);
+ });
+ });
+
+ return libs;
+
+};
+
/**
* Find the name of the component matching the specified path.
*
module.exports = {
getAmdSrcGlobList,
getComponentFromPath,
+ getComponentPaths,
getOwningComponentDirectory,
getYuiSrcGlobList,
getThirdPartyLibsList,
+ getThirdPartyPaths,
};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+ const files = grunt.moodleEnv.files;
+
+ // Project configuration.
+ grunt.config.merge({
+ eslint: {
+ // Even though warnings dont stop the build we don't display warnings by default because
+ // at this moment we've got too many core warnings.
+ // To display warnings call: grunt eslint --show-lint-warnings
+ // To fail on warnings call: grunt eslint --max-lint-warnings=0
+ // Also --max-lint-warnings=-1 can be used to display warnings but not fail.
+ options: {
+ quiet: (!grunt.option('show-lint-warnings')) && (typeof grunt.option('max-lint-warnings') === 'undefined'),
+ maxWarnings: ((typeof grunt.option('max-lint-warnings') !== 'undefined') ? grunt.option('max-lint-warnings') : -1)
+ },
+
+ // Check AMD src files.
+ amd: {src: files ? files : grunt.moodleEnv.amdSrc},
+
+ // Check YUI module source files.
+ yui: {src: files ? files : grunt.moodleEnv.yuiSrc},
+ },
+ });
+
+ grunt.loadNpmTasks('grunt-eslint');
+
+ // 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).
+ let changedFiles = Object.create(null);
+ const onChange = grunt.util._.debounce(function() {
+ const files = Object.keys(changedFiles);
+ grunt.config('eslint.amd.src', files);
+ grunt.config('eslint.yui.src', files);
+ changedFiles = Object.create(null);
+ }, 200);
+
+ grunt.event.on('watch', (action, filepath) => {
+ changedFiles[filepath] = action;
+ onChange();
+ });
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+ /**
+ * Get the list of feature files to pass to the gherkin linter.
+ *
+ * @returns {Array}
+ */
+ const getGherkinLintTargets = () => {
+ if (grunt.moodleEnv.files) {
+ // Specific files were requested. Only check these.
+ return grunt.moodleEnv.files;
+ }
+
+ if (grunt.moodleEnv.inComponent) {
+ return [`${grunt.moodleEnv.runDir}/tests/behat/*.feature`];
+ }
+
+ return ['**/tests/behat/*.feature'];
+ };
+
+ const handler = function() {
+ const done = this.async();
+ const options = grunt.config('gherkinlint.options');
+
+ // Grab the gherkin-lint linter and required scaffolding.
+ const linter = require('gherkin-lint/dist/linter.js');
+ const featureFinder = require('gherkin-lint/dist/feature-finder.js');
+ const configParser = require('gherkin-lint/dist/config-parser.js');
+ const formatter = require('gherkin-lint/dist/formatters/stylish.js');
+
+ // Run the linter.
+ return linter.lint(
+ featureFinder.getFeatureFiles(grunt.file.expand(options.files)),
+ configParser.getConfiguration(configParser.defaultConfigFileName)
+ )
+ .then(results => {
+ // Print the results out uncondtionally.
+ formatter.printResults(results);
+
+ return results;
+ })
+ .then(results => {
+ // Report on the results.
+ // The done function takes a bool whereby a falsey statement causes the task to fail.
+ return results.every(result => result.errors.length === 0);
+ })
+ .then(done); // eslint-disable-line promise/no-callback-in-promise
+ };
+
+ grunt.registerTask('gherkinlint', 'Run gherkinlint against the current directory', handler);
+
+ grunt.config.set('gherkinlint', {
+ options: {
+ files: getGherkinLintTargets(),
+ }
+ });
+
+ grunt.config.merge({
+ watch: {
+ gherkinlint: {
+ files: [grunt.moodleEnv.inComponent ? 'tests/behat/*.feature' : '**/tests/behat/*.feature'],
+ tasks: ['gherkinlint'],
+ },
+ },
+ });
+
+ return handler;
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+ /**
+ * Generate ignore files (utilising thirdpartylibs.xml data)
+ */
+ const handler = function() {
+ const path = require('path');
+ const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
+
+ // An array of paths to third party directories.
+ const thirdPartyPaths = ComponentList.getThirdPartyPaths();
+
+ // Generate .eslintignore.
+ const eslintIgnores = [
+ '# Generated by "grunt ignorefiles"',
+ // Do not ignore the .grunt directory.
+ '!/.grunt',
+
+ // Ignore all yui/src meta directories and build directories.
+ '*/**/yui/src/*/meta/',
+ '*/**/build/',
+ ].concat(thirdPartyPaths);
+ grunt.file.write('.eslintignore', eslintIgnores.join('\n'));
+
+ // Generate .stylelintignore.
+ const stylelintIgnores = [
+ '# Generated by "grunt ignorefiles"',
+ '**/yui/build/*',
+ 'theme/boost/style/moodle.css',
+ 'theme/classic/style/moodle.css',
+ ].concat(thirdPartyPaths);
+ grunt.file.write('.stylelintignore', stylelintIgnores.join('\n'));
+ };
+
+ grunt.registerTask('ignorefiles', 'Generate ignore files for linters', handler);
+
+ return handler;
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Function to generate the destination for the uglify task
+ * (e.g. build/file.min.js). This function will be passed to
+ * the rename property of files array when building dynamically:
+ * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
+ *
+ * @param {String} destPath the current destination
+ * @param {String} srcPath the matched src path
+ * @return {String} The rewritten destination path.
+ */
+const babelRename = function(destPath, srcPath) {
+ destPath = srcPath.replace('src', 'build');
+ destPath = destPath.replace('.js', '.min.js');
+ return destPath;
+};
+
+module.exports = grunt => {
+ // Load the Shifter tasks.
+ require('./shifter')(grunt);
+
+ // Load ESLint.
+ require('./eslint')(grunt);
+
+ const path = require('path');
+
+ // Register JS tasks.
+ grunt.registerTask('yui', ['eslint:yui', 'shifter']);
+ grunt.registerTask('amd', ['eslint:amd', 'babel']);
+ grunt.registerTask('js', ['amd', 'yui']);
+
+ // Register NPM tasks.
+ grunt.loadNpmTasks('grunt-contrib-uglify');
+ grunt.loadNpmTasks('grunt-contrib-watch');
+
+ // Load the Babel tasks and config.
+ grunt.loadNpmTasks('grunt-babel');
+ grunt.config.merge({
+ babel: {
+ options: {
+ sourceMaps: true,
+ comments: false,
+ plugins: [
+ 'transform-es2015-modules-amd-lazy',
+ 'system-import-transformer',
+ // This plugin modifies the Babel transpiling for "export default"
+ // so that if it's used then only the exported value is returned
+ // by the generated AMD module.
+ //
+ // It also adds the Moodle plugin name to the AMD module definition
+ // so that it can be imported as expected in other modules.
+ path.resolve('.grunt/babel-plugin-add-module-to-define.js'),
+ '@babel/plugin-syntax-dynamic-import',
+ '@babel/plugin-syntax-import-meta',
+ ['@babel/plugin-proposal-class-properties', {'loose': false}],
+ '@babel/plugin-proposal-json-strings'
+ ],
+ presets: [
+ ['minify', {
+ // This minification plugin needs to be disabled because it breaks the
+ // source map generation and causes invalid source maps to be output.
+ simplify: false,
+ builtIns: false
+ }],
+ ['@babel/preset-env', {
+ targets: {
+ browsers: [
+ ">0.25%",
+ "last 2 versions",
+ "not ie <= 10",
+ "not op_mini all",
+ "not Opera > 0",
+ "not dead"
+ ]
+ },
+ modules: false,
+ useBuiltIns: false
+ }]
+ ]
+ },
+ dist: {
+ files: [{
+ expand: true,
+ src: grunt.moodleEnv.files ? grunt.moodleEnv.files : grunt.moodleEnv.amdSrc,
+ rename: babelRename
+ }]
+ }
+ },
+ });
+
+ grunt.config.merge({
+ watch: {
+ amd: {
+ files: grunt.moodleEnv.inComponent
+ ? ['amd/src/*.js', 'amd/src/**/*.js']
+ : ['**/amd/src/**/*.js'],
+ tasks: ['amd']
+ },
+ },
+ });
+
+ // 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).
+ let changedFiles = Object.create(null);
+ const onChange = grunt.util._.debounce(function() {
+ const files = Object.keys(changedFiles);
+ grunt.config('babel.dist.files', [{expand: true, src: files, rename: babelRename}]);
+ changedFiles = Object.create(null);
+ }, 200);
+
+ grunt.event.on('watch', function(action, filepath) {
+ changedFiles[filepath] = action;
+ onChange();
+ });
+
+ return {
+ babelRename,
+ };
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+ grunt.loadNpmTasks('grunt-sass');
+
+ grunt.config.merge({
+ sass: {
+ dist: {
+ files: {
+ "theme/boost/style/moodle.css": "theme/boost/scss/preset/default.scss",
+ "theme/classic/style/moodle.css": "theme/classic/scss/classicgrunt.scss"
+ }
+ },
+ options: {
+ implementation: require('node-sass'),
+ includePaths: ["theme/boost/scss/", "theme/classic/scss/"]
+ }
+ },
+ });
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/* eslint-env node */
+
+module.exports = grunt => {
+ /**
+ * Shifter task. Is configured with a path to a specific file or a directory,
+ * in the case of a specific file it will work out the right module to be built.
+ *
+ * Note that this task runs the invidiaul shifter jobs async (becase it spawns
+ * so be careful to to call done().
+ */
+ const handler = function() {
+ const done = this.async();
+ const options = grunt.config('shifter.options');
+ const async = require('async');
+ const path = require('path');
+
+ // Run the shifter processes one at a time to avoid confusing output.
+ async.eachSeries(options.paths, function(src, filedone) {
+ var args = [];
+ args.push(path.normalize(process.cwd() + '/node_modules/shifter/bin/shifter'));
+
+ // Always ignore the node_modules directory.
+ args.push('--excludes', 'node_modules');
+
+ // Determine the most appropriate options to run with based upon the current location.
+ if (grunt.file.isMatch('**/yui/**/*.js', src)) {
+ // When passed a JS file, build our containing module (this happen with
+ // watch).
+ grunt.log.debug('Shifter passed a specific JS file');
+ src = path.dirname(path.dirname(src));
+ options.recursive = false;
+ } else if (grunt.file.isMatch('**/yui/src', src)) {
+ // When in a src directory --walk all modules.
+ grunt.log.debug('In a src directory');
+ args.push('--walk');
+ options.recursive = false;
+ } else if (grunt.file.isMatch('**/yui/src/*', src)) {
+ // When in module, only build our module.
+ grunt.log.debug('In a module directory');
+ options.recursive = false;
+ } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
+ // When in module src, only build our module.
+ grunt.log.debug('In a source directory');
+ src = path.dirname(src);
+ options.recursive = false;
+ }
+
+ if (grunt.option('watch')) {
+ grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
+ }
+
+ // Add the stderr option if appropriate
+ if (grunt.option('verbose')) {
+ args.push('--lint-stderr');
+ }
+
+ if (grunt.option('no-color')) {
+ args.push('--color=false');
+ }
+
+ var execShifter = function() {
+
+ grunt.log.ok("Running shifter on " + src);
+ grunt.util.spawn({
+ cmd: "node",
+ args: args,
+ opts: {cwd: src, stdio: 'inherit', env: process.env}
+ }, function(error, result, code) {
+ if (code) {
+ grunt.fail.fatal('Shifter failed with code: ' + code);
+ } else {
+ grunt.log.ok('Shifter build complete.');
+ filedone();
+ }
+ });
+ };
+
+ // Actually run shifter.
+ if (!options.recursive) {
+ execShifter();
+ } else {
+ // Check that there are yui modules otherwise shifter ends with exit code 1.
+ if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
+ args.push('--recursive');
+ execShifter();
+ } else {
+ grunt.log.ok('No YUI modules to build.');
+ filedone();
+ }
+ }
+ }, done);
+ };
+
+ // Register the shifter task.
+ grunt.registerTask('shifter', 'Run Shifter against the current directory', handler);
+
+ // Configure it.
+ grunt.config.set('shifter', {
+ options: {
+ recursive: true,
+ // Shifter takes a relative path.
+ paths: grunt.moodleEnv.files ? grunt.moodleEnv.files : [grunt.moodleEnv.runDir]
+ }
+ });
+
+ grunt.config.merge({
+ watch: {
+ yui: {
+ files: grunt.moodleEnv.inComponent
+ ? ['yui/src/*.json', 'yui/src/**/*.js']
+ : ['**/yui/src/**/*.js'],
+ tasks: ['yui']
+ },
+ },
+ });
+
+ // 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).
+ let changedFiles = Object.create(null);
+ const onChange = grunt.util._.debounce(function() {
+ const files = Object.keys(changedFiles);
+ grunt.config('shifter.options.paths', files);
+ changedFiles = Object.create(null);
+ }, 200);
+
+ grunt.event.on('watch', (action, filepath) => {
+ changedFiles[filepath] = action;
+ onChange();
+ });
+
+ return handler;
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+ /**
+ * Generate ignore files (utilising thirdpartylibs.xml data)
+ */
+ const handler = function() {
+ const path = require('path');
+
+ // Are we in a YUI directory?
+ if (path.basename(path.resolve(grunt.moodleEnv.cwd, '../../')) == 'yui') {
+ grunt.task.run('yui');
+ // Are we in an AMD directory?
+ } 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');
+ }
+ };
+
+ // Register the startup task.
+ grunt.registerTask('startup', 'Run the correct tasks for the current directory', handler);
+
+ return handler;
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+ // Load the Style Lint tasks.
+ require('./stylelint')(grunt);
+
+ // Load the SASS tasks.
+ require('./sass')(grunt);
+};
--- /dev/null
+// 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 */
+
+/**
+ * @copyright 2021 Andrew Nicols
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+module.exports = grunt => {
+
+ const getCssConfigForFiles = files => {
+ return {
+ stylelint: {
+ css: {
+ // Use a fully-qualified path.
+ src: files,
+ options: {
+ configOverrides: {
+ rules: {
+ // These rules have to be disabled in .stylelintrc for scss compat.
+ "at-rule-no-unknown": true,
+ }
+ }
+ }
+ },
+ },
+ };
+ };
+
+ const getScssConfigForFiles = files => {
+ return {
+ stylelint: {
+ scss: {
+ options: {syntax: 'scss'},
+ src: files,
+ },
+ },
+ };
+ };
+
+ /**
+ * Register any stylelint tasks.
+ *
+ * @param {Object} grunt
+ * @param {Array} files
+ * @param {String} fullRunDir
+ */
+ const registerStyleLintTasks = () => {
+ const glob = require('glob');
+
+ // The stylelinters do not handle the case where a configuration was provided but no files were included.
+ // Keep track of whether any files were found.
+ let hasCss = false;
+ let hasScss = false;
+
+ // The stylelint processors do not take a path argument. They always check all provided values.
+ // As a result we must check through each glob and determine if any files match the current directory.
+ const scssFiles = [];
+ const cssFiles = [];
+
+ const requestedFiles = grunt.moodleEnv.files;
+ if (requestedFiles) {
+ // Grunt was called with a files argument.
+ // Check whether each of the requested files matches either the CSS or SCSS source file list.
+
+ requestedFiles.forEach(changedFilePath => {
+ let matchesGlob;
+
+ // Check whether this watched path matches any watched SCSS file.
+ matchesGlob = grunt.moodleEnv.scssSrc.some(watchedPathGlob => {
+ return glob.sync(watchedPathGlob).indexOf(changedFilePath) !== -1;
+ });
+ if (matchesGlob) {
+ scssFiles.push(changedFilePath);
+ hasScss = true;
+ }
+
+ // Check whether this watched path matches any watched CSS file.
+ matchesGlob = grunt.moodleEnv.cssSrc.some(watchedPathGlob => {
+ return glob.sync(watchedPathGlob).indexOf(changedFilePath) !== -1;
+ });
+ if (matchesGlob) {
+ cssFiles.push(changedFilePath);
+ hasCss = true;
+ }
+ });
+ } else {
+ // Grunt was called without a list of files.
+ // The start directory (runDir) may be a child dir of the project.
+ // Check each scssSrc file to see if it's in the start directory.
+ // This means that we can lint just mod/*/styles.css if started in the mod directory.
+
+ grunt.moodleEnv.scssSrc.forEach(path => {
+ if (path.startsWith(grunt.moodleEnv.runDir)) {
+ scssFiles.push(path);
+ hasScss = true;
+ }
+ });
+
+ grunt.moodleEnv.cssSrc.forEach(path => {
+ if (path.startsWith(grunt.moodleEnv.runDir)) {
+ cssFiles.push(path);
+ hasCss = true;
+ }
+ });
+ }
+
+ // Register the tasks.
+ const scssTasks = ['sass'];
+ if (hasScss) {
+ grunt.config.merge(getScssConfigForFiles(scssFiles));
+ scssTasks.unshift('stylelint:scss');
+ }
+
+ const cssTasks = [];
+ if (hasCss) {
+ grunt.config.merge(getCssConfigForFiles(cssFiles));
+ cssTasks.push('stylelint:css');
+ }
+
+ // The tasks must be registered, even if empty to ensure a consistent command list.
+ // They jsut won't run anything.
+ grunt.registerTask('scss', scssTasks);
+ grunt.registerTask('rawcss', cssTasks);
+ };
+
+ // Register CSS tasks.
+ grunt.loadNpmTasks('grunt-stylelint');
+
+ // Register the style lint tasks.
+ registerStyleLintTasks();
+ grunt.registerTask('css', ['scss', 'rawcss']);
+
+ const getCoreThemeMatches = () => {
+ const scssMatch = 'scss/**/*.scss';
+
+ if (grunt.moodleEnv.inTheme) {
+ return [scssMatch];
+ }
+
+ if (grunt.moodleEnv.runDir.startsWith('theme')) {
+ return [`*/${scssMatch}`];
+ }
+
+ return [`theme/*/${scssMatch}`];
+ };
+
+ // Add the watch configuration for rawcss, and scss.
+ grunt.config.merge({
+ watch: {
+ rawcss: {
+ files: [
+ '**/*.css',
+ ],
+ excludes: [
+ '**/moodle.css',
+ '**/editor.css',
+ ],
+ tasks: ['rawcss']
+ },
+ scss: {
+ files: getCoreThemeMatches(),
+ tasks: ['scss']
+ },
+ },
+ });
+};
--- /dev/null
+/**
+ * This is a wrapper task to handle the grunt watch command. It attempts to use
+ * Watchman to monitor for file changes, if it's installed, because it's much faster.
+ *
+ * If Watchman isn't installed then it falls back to the grunt-contrib-watch file
+ * watcher for backwards compatibility.
+ */
+
+/* eslint-env node */
+
+module.exports = grunt => {
+ /**
+ * This is a wrapper task to handle the grunt watch command. It attempts to use
+ * Watchman to monitor for file changes, if it's installed, because it's much faster.
+ *
+ * If Watchman isn't installed then it falls back to the grunt-contrib-watch file
+ * watcher for backwards compatibility.
+ */
+ const watchHandler = function() {
+ const async = require('async');
+ const watchTaskDone = this.async();
+ let watchInitialised = false;
+ let watchTaskQueue = {};
+ let processingQueue = false;
+
+ const watchman = require('fb-watchman');
+ const watchmanClient = new watchman.Client();
+
+ // Grab the tasks and files that have been queued up and execute them.
+ var processWatchTaskQueue = function() {
+ if (!Object.keys(watchTaskQueue).length || processingQueue) {
+ // If there is nothing in the queue or we're already processing then wait.
+ return;
+ }
+
+ processingQueue = true;
+
+ // Grab all tasks currently in the queue.
+ var queueToProcess = watchTaskQueue;
+ // Reset the queue.
+ watchTaskQueue = {};
+
+ async.forEachSeries(
+ Object.keys(queueToProcess),
+ function(task, next) {
+ var files = queueToProcess[task];
+ var filesOption = '--files=' + files.join(',');
+ grunt.log.ok('Running task ' + task + ' for files ' + filesOption);
+
+ // Spawn the task in a child process so that it doesn't kill this one
+ // if it failed.
+ grunt.util.spawn(
+ {
+ // Spawn with the grunt bin.
+ grunt: true,
+ // Run from current working dir and inherit stdio from process.
+ opts: {
+ cwd: grunt.moodleEnv.fullRunDir,
+ stdio: 'inherit'
+ },
+ args: [task, filesOption]
+ },
+ function(err, res, code) {
+ if (code !== 0) {
+ // The grunt task failed.
+ grunt.log.error(err);
+ }
+
+ // Move on to the next task.
+ next();
+ }
+ );
+ },
+ function() {
+ // No longer processing.
+ processingQueue = false;
+ // Once all of the tasks are done then recurse just in case more tasks
+ // were queued while we were processing.
+ processWatchTaskQueue();
+ }
+ );
+ };
+
+ const originalWatchConfig = grunt.config.get(['watch']);
+ const watchConfig = Object.keys(originalWatchConfig).reduce(function(carry, key) {
+ if (key == 'options') {
+ return carry;
+ }
+
+ const value = originalWatchConfig[key];
+
+ const taskNames = value.tasks;
+ const files = value.files;
+ let excludes = [];
+ if (value.excludes) {
+ excludes = value.excludes;
+ }
+
+ taskNames.forEach(function(taskName) {
+ carry[taskName] = {
+ files,
+ excludes,
+ };
+ });
+
+ return carry;
+ }, {});
+
+ watchmanClient.on('error', function(error) {
+ // We have to add an error handler here and parse the error string because the
+ // example way from the docs to check if Watchman is installed doesn't actually work!!
+ // See: https://github.com/facebook/watchman/issues/509
+ if (error.message.match('Watchman was not found')) {
+ // If watchman isn't installed then we should fallback to the other watch task.
+ grunt.log.ok('It is recommended that you install Watchman for better performance using the "watch" command.');
+
+ // Fallback to the old grunt-contrib-watch task.
+ grunt.renameTask('watch-grunt', 'watch');
+ grunt.task.run(['watch']);
+ // This task is finished.
+ watchTaskDone(0);
+ } else {
+ grunt.log.error(error);
+ // Fatal error.
+ watchTaskDone(1);
+ }
+ });
+
+ watchmanClient.on('subscription', function(resp) {
+ if (resp.subscription !== 'grunt-watch') {
+ return;
+ }
+
+ resp.files.forEach(function(file) {
+ grunt.log.ok('File changed: ' + file.name);
+
+ var fullPath = grunt.moodleEnv.fullRunDir + '/' + file.name;
+ Object.keys(watchConfig).forEach(function(task) {
+
+ const fileGlobs = watchConfig[task].files;
+ var match = fileGlobs.some(function(fileGlob) {
+ return grunt.file.isMatch(`**/${fileGlob}`, fullPath);
+ });
+
+ if (match) {
+ // If we are watching a subdirectory then the file.name will be relative
+ // to that directory. However the grunt tasks expect the file paths to be
+ // relative to the Gruntfile.js location so let's normalise them before
+ // adding them to the queue.
+ var relativePath = fullPath.replace(grunt.moodleEnv.gruntFilePath + '/', '');
+ if (task in watchTaskQueue) {
+ if (!watchTaskQueue[task].includes(relativePath)) {
+ watchTaskQueue[task] = watchTaskQueue[task].concat(relativePath);
+ }
+ } else {
+ watchTaskQueue[task] = [relativePath];
+ }
+ }
+ });
+ });
+
+ processWatchTaskQueue();
+ });
+
+ process.on('SIGINT', function() {
+ // Let the user know that they may need to manually stop the Watchman daemon if they
+ // no longer want it running.
+ if (watchInitialised) {
+ grunt.log.ok('The Watchman daemon may still be running and may need to be stopped manually.');
+ }
+
+ process.exit();
+ });
+
+ // Initiate the watch on the current directory.
+ watchmanClient.command(['watch-project', grunt.moodleEnv.fullRunDir], function(watchError, watchResponse) {
+ if (watchError) {
+ grunt.log.error('Error initiating watch:', watchError);
+ watchTaskDone(1);
+ return;
+ }
+
+ if ('warning' in watchResponse) {
+ grunt.log.error('warning: ', watchResponse.warning);
+ }
+
+ var watch = watchResponse.watch;
+ var relativePath = watchResponse.relative_path;
+ watchInitialised = true;
+
+ watchmanClient.command(['clock', watch], function(clockError, clockResponse) {
+ if (clockError) {
+ grunt.log.error('Failed to query clock:', clockError);
+ watchTaskDone(1);
+ return;
+ }
+
+ // Generate the expression query used by watchman.
+ // Documentation is limited, but see https://facebook.github.io/watchman/docs/expr/allof.html for examples.
+ // We generate an expression to match any value in the files list of all of our tasks, but excluding
+ // all value in the excludes list of that task.
+ //
+ // [anyof, [
+ // [allof, [
+ // [anyof, [
+ // ['match', validPath, 'wholename'],
+ // ['match', validPath, 'wholename'],
+ // ],
+ // [not,
+ // [anyof, [
+ // ['match', invalidPath, 'wholename'],
+ // ['match', invalidPath, 'wholename'],
+ // ],
+ // ],
+ // ],
+ var matchWholeName = fileGlob => ['match', fileGlob, 'wholename'];
+ var matches = Object.keys(watchConfig).map(function(task) {
+ const matchAll = [];
+ matchAll.push(['anyof'].concat(watchConfig[task].files.map(matchWholeName)));
+
+ if (watchConfig[task].excludes.length) {
+ matchAll.push(['not', ['anyof'].concat(watchConfig[task].excludes.map(matchWholeName))]);
+ }
+
+ return ['allof'].concat(matchAll);
+ });
+
+ matches = ['anyof'].concat(matches);
+
+ var sub = {
+ expression: matches,
+ // Which fields we're interested in.
+ fields: ["name", "size", "type"],
+ // Add our time constraint.
+ since:&
