@1024pix/eslint-plugin 1.3.0 → 2.0.0

package/.github/workflows/check-node-version-availability-on-scalingo.yaml

@@ -0,0 +1,12 @@
+name: Check node version availability on Scalingo
+
+on: [push]
+
+jobs:
+  check-node-compatibility:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - uses: 1024pix/pix-actions/check-node-version-availability-on-scalingo@v0

package/.nvmrc

@@ -1 +1 @@
-20.13.0
+20.18.1

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# [2.0.0](https://github.com/1024pix/eslint-plugin/compare/v1.3.0...v2.0.0) (2024-12-19)
+
+### :boom: BREAKING CHANGE
+
+- [#13](https://github.com/1024pix/eslint-plugin/pull/13) Montée de version d'ESLint en V9 
+
+### :rewind: Retour en arrière
+
+- [#33](https://github.com/1024pix/eslint-plugin/pull/33) Update dependency node to v20.17.0
+
+### :arrow_up: Montée de version
+
+- [#31](https://github.com/1024pix/eslint-plugin/pull/31) Lock file maintenance 
+- [#43](https://github.com/1024pix/eslint-plugin/pull/43) Lock file maintenance (dossier racine) 
+- [#42](https://github.com/1024pix/eslint-plugin/pull/42) Lock file maintenance (dossier racine) 
+- [#40](https://github.com/1024pix/eslint-plugin/pull/40) Lock file maintenance (dossier racine) 
+- [#39](https://github.com/1024pix/eslint-plugin/pull/39) Lock file maintenance (dossier racine) 
+- [#37](https://github.com/1024pix/eslint-plugin/pull/37) Lock file maintenance (dossier racine) 
+- [#30](https://github.com/1024pix/eslint-plugin/pull/30) Update dependency node to v20.16.0 
+- [#34](https://github.com/1024pix/eslint-plugin/pull/34) Update dependency node to v20.17.0 
+- [#32](https://github.com/1024pix/eslint-plugin/pull/32) Update dependency node to v20.17.0 
+- [#36](https://github.com/1024pix/eslint-plugin/pull/36) Update dependency node to v20.18.0 
+- [#41](https://github.com/1024pix/eslint-plugin/pull/41) Update Node.js to v20.18.1
+
 # [1.3.0](https://github.com/1024pix/eslint-plugin/compare/v1.2.2...v1.3.0) (2024-07-16)
 
 ### :rocket: Amélioration

package/config.js

@@ -87,7 +87,6 @@ module.exports = [
         },
       ],
       '@1024pix/no-sinon-stub-with-args-oneliner': 'error',
-      '@1024pix/no-column-migration-without-comment': 'error',
     },
   },
 ];

package/index.js

@@ -1,7 +1,5 @@
-'use strict';
-const noSinonStubWithArgsOneliner = require('./rules/no-sinon-stub-with-args-oneliner.js');
-const noColumnMigrationWithoutComment = require('./rules/no-column-migration-without-comment.js');
+import noSinonStubWithArgsOneliner from './rules/no-sinon-stub-with-args-oneliner.js';
 
-module.exports = {
-  rules: { 'no-sinon-stub-with-args-oneliner': noSinonStubWithArgsOneliner, 'no-column-migration-without-comment': noColumnMigrationWithoutComment },
+export default {
+  rules: { 'no-sinon-stub-with-args-oneliner': noSinonStubWithArgsOneliner },
 };

package/package.json

@@ -1,24 +1,30 @@
 {
   "name": "@1024pix/eslint-plugin",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Des règles de lint pour les projets 1024pix",
+  "type": "module",
+  "engines": {
+    "node": "^20 || ^22"
+  },
   "exports": {
     ".": "./index.js",
     "./config": "./config.js"
   },
   "scripts": {
-    "test": "node rules/*.test.js"
+    "test": "ava"
   },
   "dependencies": {
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
-    "eslint-plugin-simple-import-sort": "^12.1.0",
-    "eslint-plugin-yml": "^1.14.0"
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-yml": "^1.16.0"
   },
   "devDependencies": {
-    "eslint": "^8.57.0"
+    "ava": "^6.2.0",
+    "eslint": "^9.17.0",
+    "eslint-ava-rule-tester": "^5.0.1"
   },
   "peerDependencies": {
-    "eslint": ">=8.56.0"
+    "eslint": ">=9.17.0"
   },
   "repository": {
     "type": "git",

package/readme.md

@@ -7,7 +7,7 @@
 ### Install
 
 ```bash
-npm install --save-dev eslint@^8 @1024pix/eslint-plugin
+npm install --save-dev eslint@^9 @1024pix/eslint-plugin
 ```
 
 ### Config `eslint.config.cjs`

package/rules/no-sinon-stub-with-args-oneliner.js

@@ -1,5 +1,3 @@
-'use strict';
-
 function report(context, node) {
   context.report({
     node: node,
@@ -7,36 +5,32 @@ function report(context, node) {
   });
 }
 
-module.exports = {
+export default {
   meta: {
     type: 'problem',
     docs: {
-      description:
-        'Do not chain `sinon.stub()` with the `withArgs()` method in a one-liner',
+      description: 'Do not chain `sinon.stub()` with the `withArgs()` method in a one-liner',
     },
     messages: {
-      chainError:
-        '`sinon.stub()` should not be chained with the `withArgs` method.',
+      chainError: '`sinon.stub()` should not be chained with the `withArgs` method.',
     },
   },
-  create: function (context) {
-    return {
-      'VariableDeclarator > CallExpression > MemberExpression[property.name="returns"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
-        function (node) {
-          report(context, node);
-        },
-      'VariableDeclarator > CallExpression > MemberExpression[property.name="throws"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
-        function (node) {
-          report(context, node);
-        },
-      'VariableDeclarator > CallExpression > MemberExpression[property.name="resolves"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
-        function (node) {
-          report(context, node);
-        },
-      'VariableDeclarator > CallExpression > MemberExpression[property.name="rejects"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
-        function (node) {
-          report(context, node);
-        },
-    };
-  },
+  create: (context) => ({
+    'VariableDeclarator > CallExpression > MemberExpression[property.name="returns"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+      (node) => {
+        report(context, node);
+      },
+    'VariableDeclarator > CallExpression > MemberExpression[property.name="throws"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+      (node) => {
+        report(context, node);
+      },
+    'VariableDeclarator > CallExpression > MemberExpression[property.name="resolves"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+      (node) => {
+        report(context, node);
+      },
+    'VariableDeclarator > CallExpression > MemberExpression[property.name="rejects"] > CallExpression > MemberExpression[property.name="withArgs"] > CallExpression > MemberExpression[property.name="stub"][object.name="sinon"]':
+      (node) => {
+        report(context, node);
+      },
+  }),
 };

package/rules/no-sinon-stub-with-args-oneliner.test.js

@@ -1,11 +1,9 @@
-'use strict';
+import test from 'ava';
+import AvaRuleTester from 'eslint-ava-rule-tester';
 
-const rule = require('./no-sinon-stub-with-args-oneliner.js'),
-  RuleTester = require('eslint').RuleTester;
+import rule from './no-sinon-stub-with-args-oneliner.js';
 
-const ruleTester = new RuleTester({
-  parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
-});
+const ruleTester = new AvaRuleTester(test);
 
 ruleTester.run('no-sinon-stub-with-args-oneliner', rule, {
   valid: [

package/rules/no-column-migration-without-comment.js

@@ -1,83 +0,0 @@
-'use strict';
-
-function report(context, node) {
-  context.report({
-    node: node,
-    messageId: 'chainError',
-  });
-}
-
-
-function getIdentifierName(node, stackName = []) {
-  switch (node.type) {
-    case 'Identifier':
-      return { identifier: node.name, callStack: stackName };
-    case 'MemberExpression':
-      return getIdentifierName(node.object, [...stackName, node.property.name])
-    case 'CallExpression':
-      return getIdentifierName(node.callee, stackName);
-    case 'AwaitExpression':
-      return getIdentifierName(node.argument, stackName);
-  }
-}
-
-const VALID_MEMBER_EXPRESSIONS = ['dropColumn', 'foreign', 'unique', 'index', 'dropUnique', 'dropIndex'];
-
-module.exports = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description:
-        'All columns should have a comment explaining their purpose',
-    },
-    messages: {
-      chainError:
-        '`table.column()` should have a comment explaining its purpose',
-    },
-  },
-  create: function(context) {
-    return {
-      CallExpression(node) {
-        const { callee } = node;
-
-        if (
-          callee.type === 'MemberExpression' &&
-          callee.object &&
-          callee.object.object &&
-          callee.object.object.name === 'knex' &&
-          callee.object.property &&
-          callee.object.property.name === 'schema' &&
-          ['alterTable', 'createTable', 'table'].includes(callee.property.name)
-        ) {
-          const callback = node.arguments[1];
-
-          if (callback && callback.type === 'ArrowFunctionExpression') {
-            const tableParam = callback.params[0];
-
-            if (tableParam && tableParam.type === 'Identifier') {
-
-              const body = callback.body.body ?? [{ expression: callback.body }];
-
-              body.forEach(statement => {
-                const columnExpression = statement.expression;
-
-                const { identifier: identifierName, callStack } = getIdentifierName(columnExpression);
-
-                if (!callStack.some((call) => VALID_MEMBER_EXPRESSIONS.includes(call))) {
-                  if (identifierName === tableParam.name) {
-                    const hasComment = callStack.includes('comment');
-
-                    if (!hasComment) {
-                      report(context, node);
-                    }
-                  }
-                }
-
-              });
-            }
-          }
-        }
-      }
-    };
-  }
-};

package/rules/no-column-migration-without-comment.test.js

@@ -1,260 +0,0 @@
-'use strict';
-
-const rule = require('./no-column-migration-without-comment.js'),
-  RuleTester = require('eslint').RuleTester;
-
-const ruleTester = new RuleTester({
-  parserOptions: { ecmaVersion: 2021, sourceType: 'module' },
-});
-
-ruleTester.run('no-column-migration-without-comment', rule, {
-  valid: [
-    // createTable
-    {
-      name: 'With comment',
-      code: `
-      const up = function (knex) {
-          return knex.schema.createTable(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).comment('This is a comment');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'Without using table callback',
-      code: `
-      const up = function (knex) {
-          return knex.schema.createTable(TABLE_NAME, (table) => {
-            toto.maFunction();
-          });
-        };
-      `,
-    },
-
-    // alterTable
-    {
-      name: 'With comment',
-      code: `
-      const up = function (knex) {
-          return knex.schema.alterTable(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).comment('This is a comment');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'Without using table callback',
-      code: `
-      const up = function (knex) {
-          return knex.schema.alterTable(TABLE_NAME, (table) => {
-            toto.maFunction();
-          });
-        };
-      `,
-    },
-
-    // table
-
-    {
-      name: 'With comment',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).comment('This is a comment');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'Without using table callback',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            toto.maFunction();
-          });
-        };
-      `,
-    },
-
-
-    {
-      name: 'With down function',
-      code: `
-      const down = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.boolean('toto').comment('This is a comment');
-          });
-        };
-      `,
-    },
-
-
-    {
-      name: 'With dropColumn',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.dropColumn('toto');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'With foreign',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.foreign('toto');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'With unique',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.unique('toto');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'With index',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.index('toto');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'With dropUnique',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.dropUnique('toto');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'With dropIndex',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.dropIndex('toto');
-          });
-        };
-      `,
-    },
-
-    {
-      name: 'With oneliner',
-      code: `
-      const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => table.boolean('toto').comment('comment'));
-        };
-      `,
-    },
-
-    {
-      name: 'With await',
-      code: `
-      const up = async function (knex) {
-        return knex.schema.alterTable(TABLE_NAME, async (table) => {
-           await table.decimal(COLUMN, 5, 2).notNullable().alter().comment('toto');
-        });
-      };
-      `,
-    },
-  ],
-
-  invalid: [
-
-    // CreateTable
-    {
-      name: 'Create column without comment',
-      code: `
-        const up = function (knex) {
-          return knex.schema.createTable(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).defaultTo(false);
-          });
-        };
-      `,
-      errors: [{ messageId: 'chainError' }],
-    },
-    {
-      name: 'Create column without comment',
-      code: `
-        const up = function (knex) {
-          return knex.schema.createTable(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).defaultTo(false).comment('toto');
-            table.boolean(COLUMN_NAME_2).defaultTo(false);
-          });
-        };
-      `,
-      errors: [{ messageId: 'chainError' }],
-    },
-
-    // AlterTable
-
-    {
-      name: 'Create column without comment',
-      code: `
-        const up = function (knex) {
-          return knex.schema.alterTable(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).defaultTo(false);
-          });
-        };
-      `,
-      errors: [{ messageId: 'chainError' }],
-    },
-    {
-      name: 'Create column without comment',
-      code: `
-        const up = function (knex) {
-          return knex.schema.alterTable(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).defaultTo(false).comment('toto');
-            table.boolean(COLUMN_NAME_2).defaultTo(false);
-          });
-        };
-      `,
-      errors: [{ messageId: 'chainError' }],
-    },
-
-    // table
-    {
-      name: 'Create column without comment',
-      code: `
-        const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).defaultTo(false);
-          });
-        };
-      `,
-      errors: [{ messageId: 'chainError' }],
-    },
-    {
-      name: 'Create column without comment',
-      code: `
-        const up = function (knex) {
-          return knex.schema.table(TABLE_NAME, (table) => {
-            table.boolean(COLUMN_NAME).defaultTo(false).comment('toto');
-            table.boolean(COLUMN_NAME_2).defaultTo(false);
-          });
-        };
-      `,
-      errors: [{ messageId: 'chainError' }],
-    },
-  ],
-});