@croct/eslint-plugin 0.2.3 → 0.3.0

package/configs/index.d.ts

@@ -205,6 +205,7 @@ export declare const configs: {
             '@croct/complex-expression-spacing': string;
             '@croct/newline-per-chained-call': string;
             '@croct/min-chained-call-depth': string;
+            '@croct/parameter-destructuring': string;
             'eslint-comments/disable-enable-pair': (string | {
                 allowWholeFile: boolean;
             })[];
@@ -298,6 +299,9 @@ export declare const configs: {
                 next: string;
             })[];
             'no-useless-escape': string;
+            'newline-destructuring/newline': (string | {
+                maxLength: number;
+            })[];
         };
         overrides: {
             files: string[];

package/configs/javascript.d.ts

@@ -6,6 +6,7 @@ export declare const javascript: {
         '@croct/complex-expression-spacing': string;
         '@croct/newline-per-chained-call': string;
         '@croct/min-chained-call-depth': string;
+        '@croct/parameter-destructuring': string;
         'eslint-comments/disable-enable-pair': (string | {
             allowWholeFile: boolean;
         })[];
@@ -99,6 +100,9 @@ export declare const javascript: {
             next: string;
         })[];
         'no-useless-escape': string;
+        'newline-destructuring/newline': (string | {
+            maxLength: number;
+        })[];
     };
     overrides: {
         files: string[];

package/configs/javascript.js

@@ -12,6 +12,7 @@ exports.javascript = {
         'import',
         'no-smart-quotes',
         'import-newlines',
+        'newline-destructuring',
         '@croct',
     ],
     rules: {
@@ -19,6 +20,7 @@ exports.javascript = {
         '@croct/complex-expression-spacing': 'error',
         '@croct/newline-per-chained-call': 'error',
         '@croct/min-chained-call-depth': 'error',
+        '@croct/parameter-destructuring': 'error',
         'eslint-comments/disable-enable-pair': [
             'error',
             {
@@ -214,6 +216,9 @@ exports.javascript = {
             },
         ],
         'no-useless-escape': 'error',
+        'newline-destructuring/newline': ['error', {
+                maxLength: 100,
+            }],
     },
     overrides: [
         {

package/index.d.ts

@@ -1,27 +1,30 @@
 declare const configuration: {
     rules: {
         'argument-spacing': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing", never[], {
-            CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression | import("@typescript-eslint/types/dist/ast-spec").NewExpression) => void;
-            NewExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression | import("@typescript-eslint/types/dist/ast-spec").NewExpression) => void;
+            CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression | import("@typescript-eslint/types/dist/generated/ast-spec").NewExpression) => void;
+            NewExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression | import("@typescript-eslint/types/dist/generated/ast-spec").NewExpression) => void;
         }>;
         'jsx-attribute-spacing': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing", never[], {
-            JSXAttribute: (node: import("@typescript-eslint/types/dist/ast-spec").JSXAttribute) => void;
+            JSXAttribute: (node: import("@typescript-eslint/types/dist/generated/ast-spec").JSXAttribute) => void;
         }>;
         'complex-expression-spacing': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing", never[], {
-            ArrowFunctionExpression: (node: import("@typescript-eslint/types/dist/ast-spec").ArrowFunctionExpression) => void;
-            IfStatement: (node: import("@typescript-eslint/types/dist/ast-spec").IfStatement) => void;
+            ArrowFunctionExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").ArrowFunctionExpression) => void;
+            IfStatement: (node: import("@typescript-eslint/types/dist/generated/ast-spec").IfStatement) => void;
         }>;
         'newline-per-chained-call': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"expectedLineBreak", {
             ignoreChainWithDepth: number;
         }[], {
-            CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression) => void;
-            MemberExpression: (node: import("@typescript-eslint/types/dist/ast-spec").MemberExpression) => void;
+            CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression) => void;
+            MemberExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").MemberExpression) => void;
         }>;
         'min-chained-call-depth': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"unexpectedLineBreak", {
             maxLineLength: number;
         }[], {
-            CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression) => void;
-            MemberExpression: (node: import("@typescript-eslint/types/dist/ast-spec").MemberExpression) => void;
+            CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression) => void;
+            MemberExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").MemberExpression) => void;
+        }>;
+        'parameter-destructuring': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"unexpectedDestructuring", never[], {
+            ObjectPattern: (node: import("@typescript-eslint/types/dist/generated/ast-spec").ObjectPattern) => void;
         }>;
     };
     configs: {
@@ -231,6 +234,7 @@ declare const configuration: {
                 '@croct/complex-expression-spacing': string;
                 '@croct/newline-per-chained-call': string;
                 '@croct/min-chained-call-depth': string;
+                '@croct/parameter-destructuring': string;
                 'eslint-comments/disable-enable-pair': (string | {
                     allowWholeFile: boolean;
                 })[];
@@ -324,6 +328,9 @@ declare const configuration: {
                     next: string;
                 })[];
                 'no-useless-escape': string;
+                'newline-destructuring/newline': (string | {
+                    maxLength: number;
+                })[];
             };
             overrides: {
                 files: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/eslint-plugin",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "ESLint rules and presets applied to all Croct JavaScript projects.",
   "license": "MIT",
   "author": {
@@ -48,6 +48,7 @@
     "eslint-plugin-jest": "^26.1",
     "eslint-plugin-jest-dom": "^4.0",
     "eslint-plugin-jsx-a11y": "^6.5",
+    "eslint-plugin-newline-destructuring": "^1.0.1",
     "eslint-plugin-no-smart-quotes": "^1.3",
     "eslint-plugin-react": "^7.28",
     "eslint-plugin-react-hooks": "^4.3",

package/rules/index.d.ts

@@ -1,25 +1,28 @@
 export declare const rules: {
     'argument-spacing': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing", never[], {
-        CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression | import("@typescript-eslint/types/dist/ast-spec").NewExpression) => void;
-        NewExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression | import("@typescript-eslint/types/dist/ast-spec").NewExpression) => void;
+        CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression | import("@typescript-eslint/types/dist/generated/ast-spec").NewExpression) => void;
+        NewExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression | import("@typescript-eslint/types/dist/generated/ast-spec").NewExpression) => void;
     }>;
     'jsx-attribute-spacing': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing", never[], {
-        JSXAttribute: (node: import("@typescript-eslint/types/dist/ast-spec").JSXAttribute) => void;
+        JSXAttribute: (node: import("@typescript-eslint/types/dist/generated/ast-spec").JSXAttribute) => void;
     }>;
     'complex-expression-spacing': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing", never[], {
-        ArrowFunctionExpression: (node: import("@typescript-eslint/types/dist/ast-spec").ArrowFunctionExpression) => void;
-        IfStatement: (node: import("@typescript-eslint/types/dist/ast-spec").IfStatement) => void;
+        ArrowFunctionExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").ArrowFunctionExpression) => void;
+        IfStatement: (node: import("@typescript-eslint/types/dist/generated/ast-spec").IfStatement) => void;
     }>;
     'newline-per-chained-call': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"expectedLineBreak", {
         ignoreChainWithDepth: number;
     }[], {
-        CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression) => void;
-        MemberExpression: (node: import("@typescript-eslint/types/dist/ast-spec").MemberExpression) => void;
+        CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression) => void;
+        MemberExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").MemberExpression) => void;
     }>;
     'min-chained-call-depth': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"unexpectedLineBreak", {
         maxLineLength: number;
     }[], {
-        CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression) => void;
-        MemberExpression: (node: import("@typescript-eslint/types/dist/ast-spec").MemberExpression) => void;
+        CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression) => void;
+        MemberExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").MemberExpression) => void;
+    }>;
+    'parameter-destructuring': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"unexpectedDestructuring", never[], {
+        ObjectPattern: (node: import("@typescript-eslint/types/dist/generated/ast-spec").ObjectPattern) => void;
     }>;
 };

package/rules/index.js

@@ -6,10 +6,12 @@ const jsx_attribute_spacing_1 = require("./jsx-attribute-spacing");
 const complex_expression_spacing_1 = require("./complex-expression-spacing");
 const newline_per_chained_call_1 = require("./newline-per-chained-call");
 const min_chained_call_depth_1 = require("./min-chained-call-depth");
+const parameter_destructuring_1 = require("./parameter-destructuring");
 exports.rules = {
     'argument-spacing': argument_spacing_1.argumentSpacing,
     'jsx-attribute-spacing': jsx_attribute_spacing_1.jsxAttributeSpacing,
     'complex-expression-spacing': complex_expression_spacing_1.complexExpressionSpacing,
     'newline-per-chained-call': newline_per_chained_call_1.newlinePerChainedCall,
     'min-chained-call-depth': min_chained_call_depth_1.minChainedCallDepth,
+    'parameter-destructuring': parameter_destructuring_1.parameterDestructuring,
 };

package/rules/parameter-destructuring/index.d.ts

@@ -0,0 +1,3 @@
+export declare const parameterDestructuring: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"unexpectedDestructuring", never[], {
+    ObjectPattern: (node: import("@typescript-eslint/types/dist/generated/ast-spec").ObjectPattern) => void;
+}>;

package/rules/parameter-destructuring/index.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parameterDestructuring = void 0;
+/*
+ eslint-disable @typescript-eslint/no-non-null-assertion
+ --
+ Disable the rule to reduce the number of branches
+ */
+const types_1 = require("@typescript-eslint/types");
+const createRule_1 = require("../createRule");
+exports.parameterDestructuring = (0, createRule_1.createRule)({
+    name: 'parameter-destructuring',
+    meta: {
+        type: 'layout',
+        docs: {
+            description: 'Prevent noisy destructuring on parameters',
+            recommended: 'error',
+        },
+        hasSuggestions: true,
+        schema: [],
+        messages: {
+            unexpectedDestructuring: ('Destructuring should not be done in the parameters. '
+                + 'Bind to a variable and destructure inside the function.'),
+        },
+    },
+    defaultOptions: [],
+    create: context => {
+        const sourceCode = context.getSourceCode();
+        return {
+            ObjectPattern: function checkObjectPattern(node) {
+                const { parent } = node;
+                // Skip for destructuring in contexts unrelated to function parameters
+                if ((parent === null || parent === void 0 ? void 0 : parent.type) !== types_1.AST_NODE_TYPES.FunctionExpression
+                    && (parent === null || parent === void 0 ? void 0 : parent.type) !== types_1.AST_NODE_TYPES.FunctionDeclaration
+                    && (parent === null || parent === void 0 ? void 0 : parent.type) !== types_1.AST_NODE_TYPES.ArrowFunctionExpression) {
+                    return;
+                }
+                // Allow one-line destructuring
+                if (node.loc.start.line === node.loc.end.line) {
+                    return;
+                }
+                const { body } = parent;
+                context.report({
+                    node: node,
+                    messageId: 'unexpectedDestructuring',
+                    suggest: body.type === types_1.AST_NODE_TYPES.BlockStatement
+                        ? [
+                            {
+                                messageId: 'unexpectedDestructuring',
+                                fix: (fixer) => [
+                                    // Replace the destructuring with a variable declaration
+                                    fixer.replaceText(node, 'value'),
+                                    // Add the destructuring inside the body
+                                    fixer.insertTextAfter(
+                                    // Null safety: a block expression always have the `{` token
+                                    // opening the body of the function.
+                                    sourceCode.getFirstToken(body), `\nconst ${sourceCode.getText(node)} = value;\n`),
+                                ],
+                            },
+                        ]
+                        : null,
+                });
+            },
+        };
+    },
+});