@croct/eslint-plugin 0.2.0 → 0.2.3-rc.1

package/configs/index.d.ts

@@ -74,6 +74,12 @@ export declare const configs: {
                 };
             })[];
         };
+        overrides: {
+            files: string[];
+            rules: {
+                'sort-keys-fix/sort-keys-fix': string;
+            };
+        }[];
     };
     typescript: {
         extends: string[];
@@ -142,6 +148,10 @@ export declare const configs: {
                     };
                 })[];
                 'no-undef': string;
+                '@typescript-eslint/no-namespace': string;
+                '@typescript-eslint/no-redeclare': (string | {
+                    ignoreDeclarationMerge: boolean;
+                })[];
                 'no-new-object'?: undefined;
             };
             plugins?: undefined;
@@ -178,6 +188,8 @@ export declare const configs: {
                 '@typescript-eslint/object-curly-spacing'?: undefined;
                 '@typescript-eslint/member-delimiter-style'?: undefined;
                 'no-undef'?: undefined;
+                '@typescript-eslint/no-namespace'?: undefined;
+                '@typescript-eslint/no-redeclare'?: undefined;
             };
             env: {
                 jest: boolean;
@@ -192,6 +204,11 @@ export declare const configs: {
             '@croct/argument-spacing': string;
             '@croct/complex-expression-spacing': string;
             '@croct/newline-per-chained-call': string;
+            '@croct/min-chained-call-depth': string;
+            'eslint-comments/disable-enable-pair': (string | {
+                allowWholeFile: boolean;
+            })[];
+            'eslint-comments/require-description': string;
             'newline-per-chained-call': string;
             'no-plusplus': string;
             'array-bracket-newline': string[];
@@ -280,6 +297,7 @@ export declare const configs: {
                 prev: string[];
                 next: string;
             })[];
+            'no-useless-escape': string;
         };
         overrides: {
             files: string[];

package/configs/javascript.d.ts

@@ -5,6 +5,11 @@ export declare const javascript: {
         '@croct/argument-spacing': string;
         '@croct/complex-expression-spacing': string;
         '@croct/newline-per-chained-call': string;
+        '@croct/min-chained-call-depth': string;
+        'eslint-comments/disable-enable-pair': (string | {
+            allowWholeFile: boolean;
+        })[];
+        'eslint-comments/require-description': string;
         'newline-per-chained-call': string;
         'no-plusplus': string;
         'array-bracket-newline': string[];
@@ -93,6 +98,7 @@ export declare const javascript: {
             prev: string[];
             next: string;
         })[];
+        'no-useless-escape': string;
     };
     overrides: {
         files: string[];

package/configs/javascript.js

@@ -5,6 +5,7 @@ exports.javascript = {
     extends: [
         'plugin:jest/recommended',
         'airbnb-base',
+        'plugin:eslint-comments/recommended',
     ],
     plugins: [
         'jest',
@@ -17,6 +18,14 @@ exports.javascript = {
         '@croct/argument-spacing': 'error',
         '@croct/complex-expression-spacing': 'error',
         '@croct/newline-per-chained-call': 'error',
+        '@croct/min-chained-call-depth': 'error',
+        'eslint-comments/disable-enable-pair': [
+            'error',
+            {
+                allowWholeFile: true,
+            },
+        ],
+        'eslint-comments/require-description': 'error',
         'newline-per-chained-call': 'off',
         'no-plusplus': 'off',
         'array-bracket-newline': [
@@ -204,6 +213,7 @@ exports.javascript = {
                 ],
             },
         ],
+        'no-useless-escape': 'error',
     },
     overrides: [
         {

package/configs/react.d.ts

@@ -60,4 +60,10 @@ export declare const react: {
             };
         })[];
     };
+    overrides: {
+        files: string[];
+        rules: {
+            'sort-keys-fix/sort-keys-fix': string;
+        };
+    }[];
 };

package/configs/react.js

@@ -17,6 +17,7 @@ exports.react = {
         'testing-library',
         'jest-dom',
         '@croct',
+        'sort-keys-fix',
     ],
     rules: {
         '@croct/jsx-attribute-spacing': 'error',
@@ -120,4 +121,12 @@ exports.react = {
             },
         ],
     },
+    overrides: [
+        {
+            files: ['**/styles.ts'],
+            rules: {
+                'sort-keys-fix/sort-keys-fix': 'error',
+            },
+        },
+    ],
 };

package/configs/typescript.d.ts

@@ -65,6 +65,10 @@ export declare const typescript: {
                 };
             })[];
             'no-undef': string;
+            '@typescript-eslint/no-namespace': string;
+            '@typescript-eslint/no-redeclare': (string | {
+                ignoreDeclarationMerge: boolean;
+            })[];
             'no-new-object'?: undefined;
         };
         plugins?: undefined;
@@ -101,6 +105,8 @@ export declare const typescript: {
             '@typescript-eslint/object-curly-spacing'?: undefined;
             '@typescript-eslint/member-delimiter-style'?: undefined;
             'no-undef'?: undefined;
+            '@typescript-eslint/no-namespace'?: undefined;
+            '@typescript-eslint/no-redeclare'?: undefined;
         };
         env: {
             jest: boolean;

package/configs/typescript.js

@@ -77,6 +77,10 @@ exports.typescript = {
                         },
                     }],
                 'no-undef': 'off',
+                '@typescript-eslint/no-namespace': 'off',
+                '@typescript-eslint/no-redeclare': ['error', {
+                        ignoreDeclarationMerge: true,
+                    }],
             },
         },
         {

package/index.d.ts

@@ -17,6 +17,12 @@ declare const configuration: {
             CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression) => void;
             MemberExpression: (node: import("@typescript-eslint/types/dist/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;
+        }>;
     };
     configs: {
         cypress: {
@@ -94,6 +100,12 @@ declare const configuration: {
                     };
                 })[];
             };
+            overrides: {
+                files: string[];
+                rules: {
+                    'sort-keys-fix/sort-keys-fix': string;
+                };
+            }[];
         };
         typescript: {
             extends: string[];
@@ -162,6 +174,10 @@ declare const configuration: {
                         };
                     })[];
                     'no-undef': string;
+                    '@typescript-eslint/no-namespace': string;
+                    '@typescript-eslint/no-redeclare': (string | {
+                        ignoreDeclarationMerge: boolean;
+                    })[];
                     'no-new-object'?: undefined;
                 };
                 plugins?: undefined;
@@ -198,6 +214,8 @@ declare const configuration: {
                     '@typescript-eslint/object-curly-spacing'?: undefined;
                     '@typescript-eslint/member-delimiter-style'?: undefined;
                     'no-undef'?: undefined;
+                    '@typescript-eslint/no-namespace'?: undefined;
+                    '@typescript-eslint/no-redeclare'?: undefined;
                 };
                 env: {
                     jest: boolean;
@@ -212,6 +230,11 @@ declare const configuration: {
                 '@croct/argument-spacing': string;
                 '@croct/complex-expression-spacing': string;
                 '@croct/newline-per-chained-call': string;
+                '@croct/min-chained-call-depth': string;
+                'eslint-comments/disable-enable-pair': (string | {
+                    allowWholeFile: boolean;
+                })[];
+                'eslint-comments/require-description': string;
                 'newline-per-chained-call': string;
                 'no-plusplus': string;
                 'array-bracket-newline': string[];
@@ -300,6 +323,7 @@ declare const configuration: {
                     prev: string[];
                     next: string;
                 })[];
+                'no-useless-escape': string;
             };
             overrides: {
                 files: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/eslint-plugin",
-  "version": "0.2.0",
+  "version": "0.2.3-rc.1",
   "description": "ESLint rules and presets applied to all Croct JavaScript projects.",
   "license": "MIT",
   "author": {
@@ -42,6 +42,7 @@
     "eslint-config-airbnb": "^19.0",
     "eslint-config-airbnb-base": "^15.0",
     "eslint-plugin-cypress": "^2.12",
+    "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.25",
     "eslint-plugin-import-newlines": "^1.1",
     "eslint-plugin-jest": "^26.1",
@@ -61,6 +62,7 @@
     "eslint": "^8.8",
     "eslint-plugin-eslint-plugin": "^4.1.0",
     "eslint-plugin-self": "^1.2.1",
+    "eslint-plugin-sort-keys-fix": "^1.1.2",
     "jest": "^27.5",
     "ts-jest": "^27.1",
     "typescript": "^4.5"

package/rules/index.d.ts

@@ -16,4 +16,10 @@ export declare const rules: {
         CallExpression: (node: import("@typescript-eslint/types/dist/ast-spec").CallExpression) => void;
         MemberExpression: (node: import("@typescript-eslint/types/dist/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;
+    }>;
 };

package/rules/index.js

@@ -5,9 +5,11 @@ const argument_spacing_1 = require("./argument-spacing");
 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");
 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,
 };

package/rules/min-chained-call-depth/index.d.ts

@@ -0,0 +1,7 @@
+import { TSESTree } from '@typescript-eslint/experimental-utils';
+export declare const minChainedCallDepth: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"unexpectedLineBreak", {
+    maxLineLength: number;
+}[], {
+    CallExpression: (node: TSESTree.CallExpression) => void;
+    MemberExpression: (node: TSESTree.MemberExpression) => void;
+}>;

package/rules/min-chained-call-depth/index.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.minChainedCallDepth = void 0;
+const ast_utils_1 = require("@typescript-eslint/utils/dist/ast-utils");
+const createRule_1 = require("../createRule");
+exports.minChainedCallDepth = (0, createRule_1.createRule)({
+    name: 'min-chained-call-depth',
+    meta: {
+        type: 'layout',
+        docs: {
+            description: 'Enforces a minimum depth for multiline chained calls.',
+            recommended: 'error',
+        },
+        fixable: 'whitespace',
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    maxLineLength: {
+                        type: 'integer',
+                        minimum: 1,
+                        default: 100,
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            unexpectedLineBreak: 'Unexpected line break.',
+        },
+    },
+    defaultOptions: [
+        {
+            maxLineLength: 100,
+        },
+    ],
+    create: context => {
+        const sourceCode = context.getSourceCode();
+        function getDepth(node) {
+            let depth = 0;
+            let currentNode = node;
+            while (currentNode.type === 'CallExpression'
+                || currentNode.type === 'MemberExpression') {
+                if (currentNode.type === 'MemberExpression') {
+                    currentNode = currentNode.object;
+                    depth += 1;
+                }
+                else if (currentNode.type === 'CallExpression') {
+                    currentNode = currentNode.callee;
+                }
+            }
+            return depth;
+        }
+        function check(node) {
+            var _a, _b;
+            // If the node is a member expression inside a call expression skip, this is to ensure
+            // that we consider the correct line length of the result.
+            //
+            // Example:
+            //     ```ts
+            //     foo
+            //        .bar();
+            //     ```
+            //     The replacement of this input should be `foo.bar();`, which has 10 character.
+            //     Without this check it would consider the length up to `r`, which is 7.
+            if (node.type === 'MemberExpression' && ((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'CallExpression') {
+                return;
+            }
+            // If the node is a call expression we need to validate it's callee as a member
+            // expression.
+            // If the node itself is already a member expression, like the
+            // `property` in `this.property.function()`, we validate the node directly.
+            const callee = node.type === 'CallExpression' ? node.callee : node;
+            if (
+            // If the callee is not a member expression, we can skip.
+            // For example, root level calls like `foo();`.
+            callee.type !== 'MemberExpression'
+                // If the callee is a computed member expression, like `foo[bar]()`, we can skip.
+                || callee.computed
+                // If the callee is already in the same line as it's object, we can skip.
+                || callee.object.loc.end.line === callee.property.loc.start.line) {
+                return;
+            }
+            // We only inline the first level of chained calls.
+            // If the current call is nested inside another call, we can skip.
+            if (getDepth(callee) > 1) {
+                return;
+            }
+            const { maxLineLength = 100 } = (_b = context.options[0]) !== null && _b !== void 0 ? _b : {};
+            const { property } = callee;
+            const lastToken = sourceCode.getLastToken(node, {
+                filter: token => token.loc.end.line === property.loc.start.line,
+            });
+            const semicolon = sourceCode.getLastToken(node.parent, {
+                filter: token => (token.loc.start.line === property.loc.start.line
+                    && token.type === 'Punctuator'
+                    && token.value === ';'),
+            });
+            const lineLength = callee.object.loc.end.column
+                + lastToken.loc.end.column - property.loc.start.column
+                + 1
+                + (semicolon !== null ? 1 : 0);
+            if (maxLineLength !== null && lineLength > maxLineLength) {
+                return;
+            }
+            const punctuator = sourceCode.getTokenBefore(callee.property);
+            const previousToken = sourceCode.getTokenBefore(punctuator, { includeComments: true });
+            const nextToken = sourceCode.getTokenAfter(punctuator, { includeComments: true });
+            if ((0, ast_utils_1.isCommentToken)(previousToken) || (0, ast_utils_1.isCommentToken)(nextToken)) {
+                return;
+            }
+            context.report({
+                node: node,
+                loc: {
+                    start: callee.object.loc.end,
+                    end: callee.property.loc.start,
+                },
+                messageId: 'unexpectedLineBreak',
+                fix: fixer => fixer.replaceTextRange([previousToken.range[1], nextToken.range[0]], punctuator.value),
+            });
+        }
+        return {
+            CallExpression: (node) => {
+                check(node);
+            },
+            MemberExpression: (node) => {
+                check(node);
+            },
+        };
+    },
+});

package/rules/newline-per-chained-call/index.js

@@ -42,8 +42,7 @@ exports.newlinePerChainedCall = (0, createRule_1.createRule)({
         const sourceCode = context.getSourceCode();
         function getPropertyText(node) {
             const prefix = '.';
-            const lines = sourceCode.getText(node.property)
-                .split(LINEBREAK_MATCHER);
+            const lines = sourceCode.getText(node.property).split(LINEBREAK_MATCHER);
             return prefix + lines[0];
         }
         function hasObjectAndPropertyOnSameLine(node) {
@@ -53,6 +52,7 @@ exports.newlinePerChainedCall = (0, createRule_1.createRule)({
             return token.value !== ')' || token.type !== 'Punctuator';
         }
         function validateCallExpressionIgnoreDepth(node) {
+            var _a, _b;
             let hasCallExpression = false;
             if (node.type === 'CallExpression') {
                 hasCallExpression = true;
@@ -80,9 +80,17 @@ exports.newlinePerChainedCall = (0, createRule_1.createRule)({
                 if (memberExpressions.length > ignoreChainWithDepth
                     && hasCallExpression
                     && memberExpressions.some(hasObjectAndPropertyOnSameLine)) {
-                    memberExpressions
-                        .filter(hasObjectAndPropertyOnSameLine)
-                        .forEach(memberExpression => {
+                    const expressionsOnSameLine = memberExpressions
+                        .filter(hasObjectAndPropertyOnSameLine);
+                    const rootNode = expressionsOnSameLine[expressionsOnSameLine.length - 1];
+                    if (rootNode.type === 'MemberExpression'
+                        && (((_a = rootNode.parent) === null || _a === void 0 ? void 0 : _a.type) === 'CallExpression'
+                            || ((_b = rootNode.parent) === null || _b === void 0 ? void 0 : _b.type) === 'MemberExpression')
+                        && (rootNode.object.type === 'ThisExpression'
+                            || rootNode.object.type === 'Identifier')) {
+                        expressionsOnSameLine.pop();
+                    }
+                    expressionsOnSameLine.forEach(memberExpression => {
                         context.report({
                             node: memberExpression.property,
                             loc: memberExpression.property.loc.start,