Mdl 58266 master

.eslintrc

@@ -2,6 +2,7 @@
   'plugins': [
     'babel',
     'promise',
+    'jsdoc',
   ],
   'env': {
     'browser': true,
@@ -191,7 +192,6 @@
         'property': 'str',
         'message': 'Use AMD module "core/str" or M.util.get_string()'
     }],
-
   },
   overrides: [
     {
@@ -200,7 +200,23 @@
       rules: {
         'no-undef': 'off',
         'no-unused-vars': 'off',
-        'no-unused-expressions': 'off'
+        'no-unused-expressions': 'off',
+
+        // === JSDocs ===
+        "jsdoc/check-access": 'off',
+        "jsdoc/check-alignment": 'off',
+        "jsdoc/check-param-names": 'off',
+        "jsdoc/check-property-names": 'off',
+        "jsdoc/empty-tags": 'off',
+        "jsdoc/implements-on-classes": 'off',
+        "jsdoc/multiline-blocks": 'off',
+        "jsdoc/require-jsdoc": 'off',
+        "jsdoc/require-param": 'off',
+        "jsdoc/require-param-name": 'off',
+        "jsdoc/require-param-type": 'off',
+        "jsdoc/require-property": 'off',
+        "jsdoc/require-property-name": 'off',
+        "jsdoc/require-property-type": 'off',
       }
     },
     {
@@ -211,7 +227,7 @@
       },
       // We're using babel transpiling so use their parser
       // for linting.
-      parser: 'babel-eslint',
+      parser: '@babel/eslint-parser',
       // Check AMD with some slightly stricter rules.
       rules: {
         'no-unused-vars': 'error',
@@ -238,11 +254,54 @@
         // === Promises ===
         // We have Promise now that we're using ES6.
         'promise/no-native': 'off',
-        'promise/avoid-new': 'off'
+        'promise/avoid-new': 'off',
+
+        // === JSDocs ===
+        "jsdoc/check-access": [
+          'error',
+        ],
+        "jsdoc/check-alignment": 1, // Recommended.
+        "jsdoc/check-param-names": [
+          'error',
+        ],
+        "jsdoc/check-property-names": [
+          'error',
+        ],
+        "jsdoc/empty-tags": [
+          'error',
+        ],
+        "jsdoc/implements-on-classes": [
+          'error',
+        ],
+        "jsdoc/multiline-blocks": [
+          'error',
+        ],
+        "jsdoc/require-jsdoc": [
+          'error',
+        ],
+        "jsdoc/require-param": [
+          'error',
+        ],
+        "jsdoc/require-param-name": [
+          'error',
+        ],
+        "jsdoc/require-param-type": [
+          'error',
+        ],
+        "jsdoc/require-property": [
+          'error',
+        ],
+        "jsdoc/require-property-name": [
+          'error',
+        ],
+        "jsdoc/require-property-type": [
+          'error',
+        ],
       },
       parserOptions: {
         'ecmaVersion': 9,
-        'sourceType': 'module'
+        'sourceType': 'module',
+        'requireConfigFile': false,
       }
     }
   ]

.github/workflows/push.yml

@@ -20,8 +20,9 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Configuring node & npm
-        shell: bash -l {0}
-        run: nvm install
+        uses: actions/setup-node@v2
+        with:
+          node-version-file: '.nvmrc'
 
       - name: Installing node stuff
         run: npm install

.gitignore

@@ -53,3 +53,5 @@ moodle-plugin-ci.phar
 /jsdoc
 /admin/tool/componentlibrary/docs
 /admin/tool/componentlibrary/hugo/site/data/my-index.json
+.hugo_build.lock
+.phpcs.xml

.grunt/babel-plugin-add-module-to-define.js

@@ -111,8 +111,22 @@ module.exports = ({template, types}) => {
                             if (!this.seenDefine && path.get('callee').isIdentifier({name: 'define'})) {
                                 // We only want to modify the first instance of define that we find.
                                 this.seenDefine = true;
+
                                 // Get the Moodle component for the file being processed.
                                 var moduleName = getModuleNameFromFileName(this.file.opts.filename);
+
+                                // The function signature of `define()` is:
+                                // define = function (name, deps, callback) {...}
+                                // Ensure that if the moduel supplied its own name that it is replaced.
+                                if (path.node.arguments.length > 0) {
+                                    // Ensure that there is only one name.
+                                    if (path.node.arguments[0].type === 'StringLiteral') {
+                                        // eslint-disable-next-line
+                                        console.log(`Replacing module name '${path.node.arguments[0].extra.rawValue}' with ${moduleName}`);
+                                        path.node.arguments.shift();
+                                    }
+                                }
+
                                 // Add the module name as the first argument to the define function.
                                 path.node.arguments.unshift(types.stringLiteral(moduleName));
                                 // Add a space after the define function in the built file so that previous versions

.grunt/tasks/ignorefiles.js

@@ -21,6 +21,43 @@
  */
 
 module.exports = grunt => {
+
+    /**
+     * Generate the PHPCS configuration.
+     *
+     * @param {Object} thirdPartyPaths
+     */
+    const phpcsIgnore = (thirdPartyPaths) => {
+        const {toXML} = require('jstoxml');
+
+        const config = {
+            _name: 'ruleset',
+            _attrs: {
+                name: "MoodleCore",
+            },
+            _content: [
+                {
+                    rule: {
+                        _attrs: {
+                            ref: './.phpcs.xml.dist',
+                        },
+                    },
+                },
+            ],
+        };
+
+        thirdPartyPaths.forEach(library => {
+            config._content.push({
+                'exclude-pattern': library,
+            });
+        });
+
+        grunt.file.write('.phpcs.xml', toXML(config, {
+            header: true,
+            indent: '  ',
+        }) + "\n");
+    };
+
     /**
      * Generate ignore files (utilising thirdpartylibs.xml data)
      */
@@ -53,6 +90,8 @@ module.exports = grunt => {
             'admin/tool/componentlibrary/hugo/dist/css/docs.css',
         ].concat(thirdPartyPaths);
         grunt.file.write('.stylelintignore', stylelintIgnores.join('\n') + '\n');
+
+        phpcsIgnore(thirdPartyPaths);
     };
 
     grunt.registerTask('ignorefiles', 'Generate ignore files for linters', handler);