@1024pix/eslint-plugin 1.3.0 → 1.3.1

package/.idea/eslint-plugin.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/eslint-plugin.iml" filepath="$PROJECT_DIR$/.idea/eslint-plugin.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

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,6 @@
 'use strict';
 const noSinonStubWithArgsOneliner = require('./rules/no-sinon-stub-with-args-oneliner.js');
-const noColumnMigrationWithoutComment = require('./rules/no-column-migration-without-comment.js');
 
 module.exports = {
-  rules: { 'no-sinon-stub-with-args-oneliner': noSinonStubWithArgsOneliner, 'no-column-migration-without-comment': noColumnMigrationWithoutComment },
+  rules: { 'no-sinon-stub-with-args-oneliner': noSinonStubWithArgsOneliner },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1024pix/eslint-plugin",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Des règles de lint pour les projets 1024pix",
   "exports": {
     ".": "./index.js",

package/release.config.cjs

@@ -1,48 +0,0 @@
-module.exports = {
-  "branches": [
-    "main",
-    "dev"
-  ],
-  "plugins": [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        "config": "@1024pix/conventional-changelog-pix",
-        "releaseRules": [
-          { revert: true, release: "patch" },
-          { tag: "BUGFIX", pr: '*', release: "patch" },
-          { tag: "BUMP", pr: '*', release: "patch" },
-          { tag: "DOC", pr: '*', release: "patch" },
-          { tag: "TECH", pr: '*', release: "patch" },
-          { tag: "FEATURE", pr: '*', release: "minor" },
-          { tag: "BREAKING", pr: '*', release: "major" },
-        ],
-      }
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        "config": "@1024pix/conventional-changelog-pix"
-      }
-    ],
-    "@semantic-release/changelog",
-    "@semantic-release/github",
-    [
-      "@semantic-release/npm",
-      {
-        "npmPublish": process.env.NPM_PUBLISH === "true",
-      }
-    ],
-    [
-      "@semantic-release/git",
-      {
-        "assets": [
-          "CHANGELOG.md",
-          "package.json",
-          "package-lock.json",
-        ],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ]
-  ]
-}

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' }],
-    },
-  ],
-});