Merge pull request #272 from magento-gl/AC-13683-v1

AC-13683::Investigate latest major version of grunt-eslint

Author: sidolov

.github/workflows/php.yml

@@ -25,7 +25,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '16'
+        node-version: '21'
 
     - uses: actions/checkout@v2
 
@@ -65,7 +65,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v2
         with:
-          node-version: '16'
+          node-version: '21'
 
       - uses: actions/checkout@v2
 
@@ -82,7 +82,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v2
         with:
-          node-version: '16'
+          node-version: '21'
 
       - uses: actions/checkout@v2
 

eslint/.eslintrc

@@ -1,14 +1,14 @@
 {
     "ignorePatterns": ["**/vendor/**/*.js", "**/node_modules/**/*.js"],
     "rules": {
-        "jquery-no-andSelf": 2,
-        "jquery-no-bind-unbind": 2,
-        "jquery-no-input-event-shorthand": 2,
-        "jquery-no-delegate-undelegate": 2,
-        "jquery-no-event-shorthand": 2,
-        "jquery-no-size": 2,
-        "jquery-no-trim": 2,
-        "jquery-no-misc-deprecated-functions": 2,
-        "jquery-no-deprecated-expr": 2
+        "magento-coding-standard-eslint-plugin/jquery-no-andSelf": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-bind-unbind": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-input-event-shorthand": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-delegate-undelegate": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-event-shorthand": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-size": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-trim": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-misc-deprecated-functions": 2,
+        "magento-coding-standard-eslint-plugin/jquery-no-deprecated-expr": 2
     }
 }

eslint/.eslintrc-jquery

@@ -0,0 +1,33 @@
+/**
+ * ESLint Configuration for Magento Project
+ *
+ * This configuration extends Magento, jQuery, and reset ESLint rules,
+ * while enforcing Magento coding standards using the `magento-coding-standard-eslint-plugin`.
+ * It uses FlatCompat to handle multiple config files in a modular way.
+ */
+
+import { defineConfig } from "eslint/config";
+import magentoCodingStandardEslintPlugin from "magento-coding-standard-eslint-plugin";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+export default defineConfig([{
+    extends: compat.extends(
+        "./.eslintrc-reset", // Resets all rules before applying custom ones
+        "./.eslintrc-magento", // Magento-specific coding standards
+        "./.eslintrc-jquery", // jQuery-related ESLint Rules
+        "./.eslintrc-misc", // Miscellaneous Rules
+    ),
+    plugins: {
+        "magento-coding-standard-eslint-plugin": magentoCodingStandardEslintPlugin,  // This is in flat config format (object)
+    }
+}]);

eslint/eslint.config.mjs

@@ -0,0 +1,27 @@
+/**
+ * ESLint Plugin for jQuery Deprecation Rules
+ * This module aggregates individual jQuery-related rules into a single .
+ */
+import jqueryNoAndSelf from './rules/jquery-no-andSelf.js';
+import jqueryNoBindUnbind from './rules/jquery-no-bind-unbind.js';
+import jqueryNoDelegateUndelegate from './rules/jquery-no-delegate-undelegate.js';
+import jqueryNoDeprecatedExpr from './rules/jquery-no-deprecated-expr.js';
+import jqueryNoEventShorthand from './rules/jquery-no-event-shorthand.js';
+import jqueryNoInputEventShorthand from './rules/jquery-no-input-event-shorthand.js';
+import jqueryNoMiscDeprecatedFunctions from './rules/jquery-no-misc-deprecated-functions.js';
+import jqueryNoSize from './rules/jquery-no-size.js';
+import jqueryNoTrim from './rules/jquery-no-trim.js';
+
+export default {
+    rules: {
+        'jquery-no-andSelf': jqueryNoAndSelf,
+        'jquery-no-bind-unbind': jqueryNoBindUnbind,
+        'jquery-no-delegate-undelegate': jqueryNoDelegateUndelegate,
+        'jquery-no-deprecated-expr': jqueryNoDeprecatedExpr,
+        'jquery-no-event-shorthand': jqueryNoEventShorthand,
+        'jquery-no-input-event-shorthand': jqueryNoInputEventShorthand,
+        'jquery-no-misc-deprecated-functions': jqueryNoMiscDeprecatedFunctions,
+        'jquery-no-size': jqueryNoSize,
+        'jquery-no-trim': jqueryNoTrim
+    }
+};

eslint/index.js

@@ -0,0 +1,12 @@
+{
+  "name": "magento-coding-standard-eslint-plugin",
+  "version": "1.0.0",
+  "main": "index.js",
+  "resolutions": {
+    "eslint": "~9.22.0"
+  },
+  "eslintConfig": {
+    "plugins": ["magento-coding-standard-eslint-plugin"]
+  },
+  "type": "module"
+}

eslint/package.json

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -20,10 +23,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if andSelf is used in the node and reports it.

eslint/rules/jquery-no-andSelf.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -20,10 +23,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if bind and unbind are used in the node and reports it.

eslint/rules/jquery-no-bind-unbind.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -20,10 +23,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if delegate and undelegate are used in the node and reports it.

eslint/rules/jquery-no-delegate-undelegate.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -17,10 +20,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks for jQuery.expr[':']

eslint/rules/jquery-no-deprecated-expr.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -17,10 +20,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if shorthand event methods are used.

eslint/rules/jquery-no-event-shorthand.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -17,10 +20,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if shortcuts are used to trigger events and reports it.

eslint/rules/jquery-no-input-event-shorthand.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -17,10 +20,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if deprecated methods are used and reports it.

eslint/rules/jquery-no-misc-deprecated-functions.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -20,10 +23,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if size method is used and reports it.

eslint/rules/jquery-no-size.js

@@ -1,4 +1,7 @@
-module.exports = {
+// Import utils using ES module syntax
+import utils from './utils.js';
+
+export default {
     meta: {
         type: 'suggestion',
         docs: {
@@ -20,10 +23,6 @@ module.exports = {
      * @returns {Object}
      */
     create: function (context) {
-        'use strict';
-
-        var utils = require('./utils.js');
-
         return {
             /**
              * Checks if trim method is used and reports it.

eslint/rules/jquery-no-trim.js

@@ -4,7 +4,6 @@
  * @returns object
  */
 function define(node) {
-    'use strict';
     var defineStmt, args;
 
     defineStmt = node.body.find(function (stmt) {
@@ -36,7 +35,6 @@ function define(node) {
  * @returns {null|*}
  */
 function getJqueryName(defineObject) {
-    'use strict';
 
     var jQueryPathIndex;
 
@@ -57,7 +55,6 @@ function getJqueryName(defineObject) {
  * Get Root Program node
  */
 function getProgramNode(node) {
-    'use strict';
     if (!node.parent) {
         return node;
     }
@@ -71,7 +68,6 @@ function getProgramNode(node) {
  * @returns {Object|Null}
  */
 function getExpressionId(node) {
-    'use strict';
 
     while (node) {
         switch (node.type) {
@@ -102,7 +98,6 @@ function getExpressionId(node) {
  */
 
 function isjQuery(node) {
-    'use strict';
     var parentNode, defineNode, jQueryId, id;
 
     parentNode = getProgramNode(node);
@@ -116,7 +111,7 @@ function isjQuery(node) {
     return id && jQueryId && id.name === jQueryId.name;
 }
 
-module.exports = {
+export default {
     traverse: getExpressionId,
     isjQuery: isjQuery
 };