@croct/eslint-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Croct.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+<p align="center">
+    <a href="https://croct.com">
+        <img src="https://cdn.croct.io/brand/logo/repo-icon-green.svg" alt="Croct" height="80"/>
+    </a>
+    <br />
+    <strong>JavaScript Coding Standard</strong>
+    <br />
+    A set of <a href="https://eslint.org/">ESLint</a> rules applied to all Croct JavaScript projects.
+</p>
+<p align="center">
+    <a href="https://www.npmjs.com/package/@croct/eslint-plugin"><img alt="Version" src="https://img.shields.io/npm/v/@croct/eslint-plugin"/></a>
+    <a href="https://github.com/croct-tech/coding-standard-js/actions/workflows/branch-validations.yaml">
+        <img alt="Build" src="https://github.com/croct-tech/coding-standard-js/actions/workflows/branch-validations.yaml/badge.svg" />
+    </a>
+    <a href="https://codeclimate.com/repos/620292a0376562495b002392/maintainability"><img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/c1fe99959c642f53697b/maintainability" /></a>
+    <a href="https://codeclimate.com/repos/620292a0376562495b002392/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/c1fe99959c642f53697b/test_coverage" /></a>
+    <br />
+    <br />
+    <a href="https://github.com/croct-tech/coding-standard-js/releases">📦 Releases</a>
+    ·
+    <a href="https://github.com/croct-tech/coding-standard-js/issues">🐞 Report Bug</a>
+    ·
+    <a href="https://github.com/croct-tech/coding-standard-js/issues">✨ Request Feature</a>
+</p>
+
+## Installation
+
+The recommended way to install the SDK is via [NPM](https://npmjs.com). It pairs nicely with module bundlers such as
+Webpack or Browserify:
+
+```sh
+npm i -D @croct/eslint-plugin
+```
+
+Then, add the following to your `.eslintrc.js` file:
+
+```js
+// Workaround for https://github.com/eslint/eslint/issues/3458
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+   "plugins": ["@croct"]
+}
+```
+
+Note the `require` call at the top of the file. This is a workaround to avoid adding the transitive dependencies of 
+the plugin to the project, which is [currently not supported by the ESLint plugin system](https://github.com/eslint/eslint/issues/3458).
+
+### TypeScript
+
+For TypeScript projects, you need first to install the TypeScript parser:
+
+```sh
+npm i -D @typescript-eslint/parser
+```
+
+Then, add the following to your `.eslintrc.js` file:
+
+```js
+// Workaround for https://github.com/eslint/eslint/issues/3458
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@croct"
+    ],
+    "extends": [
+      "plugin:@croct/typescript"
+    ],
+    "parserOptions": {
+      "extends": "./tsconfig.json",
+      "project": ["./tsconfig.json"]
+    },
+}
+```
+
+For the list for available presets and rules, see the [reference documentation](docs/README.md). 
+
+## Basic usage
+
+Run the following command to check if the project adheres to the coding standard:
+
+```sh
+eslint
+```
+
+## Contributing
+
+Contributions to the package are always welcome!
+
+- Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/coding-standard-js/issues).
+- For major changes, please [open an issue](https://github.com/croct-tech/coding-standard-js/issues) first to discuss what you would like to change.
+- Please make sure to update tests as appropriate.
+
+## Testing
+
+Before running the test suites, the development dependencies must be installed:
+
+```sh
+npm i
+```
+
+Then, to run all tests:
+
+```sh
+npm run test
+```
+
+## Copyright Notice
+
+Copyright © 2015-2021 Croct Limited, All Rights Reserved.
+
+All information contained herein is, and remains the property of Croct Limited. The intellectual, design and technical concepts contained herein are proprietary to Croct Limited s and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Croct Limited.

package/configs/cypress.d.ts

@@ -0,0 +1,13 @@
+export declare const cypress: {
+    extends: string[];
+    plugins: string[];
+    rules: {
+        'no-loop-func': number;
+        'cypress/no-assigning-return-values': string;
+        'cypress/no-unnecessary-waiting': string;
+        'cypress/assertion-before-screenshot': string;
+        'cypress/no-async-tests': string;
+        'cypress/no-pause': string;
+        '@typescript-eslint/no-namespace': string;
+    };
+};

package/configs/cypress.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cypress = void 0;
+exports.cypress = {
+    extends: [
+        'plugin:@croct/javascript',
+    ],
+    plugins: [
+        'cypress',
+        '@croct',
+    ],
+    rules: {
+        'no-loop-func': 0,
+        'cypress/no-assigning-return-values': 'warn',
+        'cypress/no-unnecessary-waiting': 'error',
+        'cypress/assertion-before-screenshot': 'warn',
+        'cypress/no-async-tests': 'error',
+        'cypress/no-pause': 'error',
+        '@typescript-eslint/no-namespace': 'off',
+    },
+};

package/configs/index.d.ts

@@ -0,0 +1,250 @@
+export declare const configs: {
+    cypress: {
+        extends: string[];
+        plugins: string[];
+        rules: {
+            'no-loop-func': number;
+            'cypress/no-assigning-return-values': string;
+            'cypress/no-unnecessary-waiting': string;
+            'cypress/assertion-before-screenshot': string;
+            'cypress/no-async-tests': string;
+            'cypress/no-pause': string;
+            '@typescript-eslint/no-namespace': string;
+        };
+    };
+    react: {
+        extends: string[];
+        plugins: string[];
+        rules: {
+            '@croct/jsx-attribute-spacing': string;
+            'react/jsx-wrap-multilines': string;
+            'react/display-name': string;
+            'react/jsx-newline': (string | {
+                prevent: boolean;
+            })[];
+            'react/jsx-no-bind': (string | {
+                allowArrowFunctions: boolean;
+                allowBind: boolean;
+                allowFunctions: boolean;
+            })[];
+            'react/no-unstable-nested-components': (string | {
+                allowAsProps: boolean;
+            })[];
+            'react/jsx-no-useless-fragment': (string | {
+                allowExpressions: boolean;
+            })[];
+            'react/function-component-definition': string;
+            'testing-library/no-container': string;
+            'testing-library/no-node-access': string;
+            'testing-library/await-async-utils': string;
+            'jsx-a11y/aria-role': (string | {
+                ignoreNonDOM: boolean;
+            })[];
+            'react/jsx-uses-react': string;
+            'react/react-in-jsx-scope': string;
+            'react/jsx-one-expression-per-line': string;
+            'react/prop-types': string;
+            'react/require-default-props': string;
+            'react/jsx-fragments': string[];
+            'react-hooks/rules-of-hooks': string;
+            'react-hooks/exhaustive-deps': string;
+            'react/jsx-filename-extension': (number | {
+                extensions: string[];
+            })[];
+            'react/jsx-indent': (string | number)[];
+            'react/jsx-indent-props': string;
+            'react/jsx-props-no-spreading': string;
+            'no-restricted-imports': (string | {
+                name: string;
+                importNames: string[];
+                message: string;
+            })[];
+            'import/order': (string | {
+                groups: string[];
+                pathGroups: {
+                    pattern: string;
+                    group: string;
+                    position: string;
+                }[];
+                pathGroupsExcludedImportTypes: string[];
+                'newlines-between': string;
+                alphabetize: {
+                    order: string;
+                    caseInsensitive: boolean;
+                };
+            })[];
+        };
+    };
+    typescript: {
+        extends: string[];
+        plugins: string[];
+        rules: {
+            '@typescript-eslint/array-type': (string | {
+                default: string;
+            })[];
+            '@typescript-eslint/prefer-as-const': string;
+            '@typescript-eslint/adjacent-overload-signatures': string;
+            '@typescript-eslint/type-annotation-spacing': string;
+            '@typescript-eslint/semi': string[];
+            '@typescript-eslint/strict-boolean-expressions': (string | {
+                allowString: boolean;
+                allowNumber: boolean;
+                allowNullableObject: boolean;
+            })[];
+            '@typescript-eslint/prefer-regexp-exec': string;
+            '@typescript-eslint/prefer-optional-chain': string;
+            'no-shadow': string;
+            '@typescript-eslint/no-shadow': (string | {
+                ignoreTypeValueShadow: boolean;
+                ignoreFunctionTypeParameterNameValueShadow: boolean;
+            })[];
+            '@typescript-eslint/no-empty-interface': string;
+            '@typescript-eslint/explicit-member-accessibility': string[];
+            '@typescript-eslint/explicit-module-boundary-types': string;
+            '@typescript-eslint/explicit-function-return-type': string[];
+            '@typescript-eslint/no-explicit-any': string;
+            'no-use-before-define': string;
+            '@typescript-eslint/no-use-before-define': string;
+            'no-unused-expressions': string;
+            '@typescript-eslint/no-unused-expressions': string;
+            indent: (string | number | {
+                SwitchCase: number;
+            })[];
+            '@typescript-eslint/no-unused-vars': string;
+            'no-unused-vars': string;
+            '@typescript-eslint/no-non-null-assertion': string;
+            'object-curly-spacing': string;
+            '@typescript-eslint/object-curly-spacing': string;
+            '@typescript-eslint/member-delimiter-style': (string | {
+                multiline: {
+                    delimiter: string;
+                    requireLast: boolean;
+                };
+                singleline: {
+                    delimiter: string;
+                    requireLast: boolean;
+                };
+                overrides: {
+                    interface: {
+                        singleline: {
+                            delimiter: string;
+                        };
+                        multiline: {
+                            delimiter: string;
+                        };
+                    };
+                };
+            })[];
+            'no-undef': string;
+        };
+        overrides: {
+            files: string[];
+            extends: string[];
+            plugins: string[];
+            rules: {
+                'no-new-object': string;
+            };
+            env: {
+                jest: boolean;
+            };
+        }[];
+    };
+    javascript: {
+        extends: string[];
+        plugins: string[];
+        rules: {
+            '@croct/argument-spacing': string;
+            '@croct/complex-expression-spacing': string;
+            'array-bracket-newline': string[];
+            'multiline-ternary': string[];
+            'no-undef-init': string;
+            'jest/consistent-test-it': (string | {
+                fn: string;
+            })[];
+            'jest/no-large-snapshots': string;
+            'jest/prefer-expect-resolves': string;
+            'jest/prefer-lowercase-title': (string | {
+                ignore: string[];
+            })[];
+            'jest/prefer-spy-on': string;
+            'jest/require-top-level-describe': string;
+            'jest/prefer-to-contain': string;
+            'jest/prefer-hooks-on-top': string;
+            'jest/prefer-equality-matcher': string;
+            'jest/no-test-return-statement': string;
+            'function-call-argument-newline': string[];
+            'no-underscore-dangle': string;
+            'import/no-default-export': string;
+            'array-element-newline': string[];
+            'import-newlines/enforce': (string | {
+                items: number;
+                'max-len': number;
+            })[];
+            'no-smart-quotes/no-smart-quotes': string;
+            'no-shadow': string;
+            'import/prefer-default-export': string;
+            'import/no-extraneous-dependencies': string;
+            'no-use-before-define': string;
+            'arrow-parens': string[];
+            'class-methods-use-this': string;
+            'consistent-return': string;
+            'default-case': string;
+            'import/extensions': string[];
+            'import/no-unresolved': string;
+            indent: (string | number | {
+                SwitchCase: number;
+            })[];
+            'linebreak-style': string[];
+            'max-classes-per-file': string;
+            'max-len': (string | {
+                code: number;
+                ignoreStrings: boolean;
+            })[];
+            'no-await-in-loop': string;
+            'no-bitwise': string;
+            'no-continue': string;
+            'no-multiple-empty-lines': (string | {
+                max: number;
+                maxEOF: number;
+                maxBOF: number;
+            })[];
+            'no-plusplus': (string | {
+                allowForLoopAfterthoughts: boolean;
+            })[];
+            'no-unused-expressions': string;
+            'no-unused-vars': string;
+            'no-restricted-syntax': string[];
+            'object-curly-newline': (string | {
+                multiline: boolean;
+                consistent: boolean;
+            })[];
+            'object-curly-spacing': string[];
+            'require-await': string;
+            'object-shorthand': string[];
+            'padding-line-between-statements': (string | {
+                blankLine: string;
+                prev: string;
+                next: string[];
+            } | {
+                blankLine: string;
+                prev: string[];
+                next: string;
+            } | {
+                blankLine: string;
+                prev: string[];
+                next: string[];
+            })[];
+        };
+        overrides: {
+            files: string[];
+            extends: string[];
+            plugins: string[];
+            rules: {
+                'no-new-object': string;
+            };
+            env: {
+                jest: boolean;
+            };
+        }[];
+    };
+};

package/configs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = void 0;
+const cypress_1 = require("./cypress");
+const react_1 = require("./react");
+const typescript_1 = require("./typescript");
+const javascript_1 = require("./javascript");
+exports.configs = {
+    cypress: cypress_1.cypress,
+    react: react_1.react,
+    typescript: typescript_1.typescript,
+    javascript: javascript_1.javascript,
+};

package/configs/javascript.d.ts

@@ -0,0 +1,98 @@
+export declare const javascript: {
+    extends: string[];
+    plugins: string[];
+    rules: {
+        '@croct/argument-spacing': string;
+        '@croct/complex-expression-spacing': string;
+        'array-bracket-newline': string[];
+        'multiline-ternary': string[];
+        'no-undef-init': string;
+        'jest/consistent-test-it': (string | {
+            fn: string;
+        })[];
+        'jest/no-large-snapshots': string;
+        'jest/prefer-expect-resolves': string;
+        'jest/prefer-lowercase-title': (string | {
+            ignore: string[];
+        })[];
+        'jest/prefer-spy-on': string;
+        'jest/require-top-level-describe': string;
+        'jest/prefer-to-contain': string;
+        'jest/prefer-hooks-on-top': string;
+        'jest/prefer-equality-matcher': string;
+        'jest/no-test-return-statement': string;
+        'function-call-argument-newline': string[];
+        'no-underscore-dangle': string;
+        'import/no-default-export': string;
+        'array-element-newline': string[];
+        'import-newlines/enforce': (string | {
+            items: number;
+            'max-len': number;
+        })[];
+        'no-smart-quotes/no-smart-quotes': string;
+        'no-shadow': string;
+        'import/prefer-default-export': string;
+        'import/no-extraneous-dependencies': string;
+        'no-use-before-define': string;
+        'arrow-parens': string[];
+        'class-methods-use-this': string;
+        'consistent-return': string;
+        'default-case': string;
+        'import/extensions': string[];
+        'import/no-unresolved': string;
+        indent: (string | number | {
+            SwitchCase: number;
+        })[];
+        'linebreak-style': string[];
+        'max-classes-per-file': string;
+        'max-len': (string | {
+            code: number;
+            ignoreStrings: boolean;
+        })[];
+        'no-await-in-loop': string;
+        'no-bitwise': string;
+        'no-continue': string;
+        'no-multiple-empty-lines': (string | {
+            max: number;
+            maxEOF: number;
+            maxBOF: number;
+        })[];
+        'no-plusplus': (string | {
+            allowForLoopAfterthoughts: boolean;
+        })[];
+        'no-unused-expressions': string;
+        'no-unused-vars': string;
+        'no-restricted-syntax': string[];
+        'object-curly-newline': (string | {
+            multiline: boolean;
+            consistent: boolean;
+        })[];
+        'object-curly-spacing': string[];
+        'require-await': string;
+        'object-shorthand': string[];
+        'padding-line-between-statements': (string | {
+            blankLine: string;
+            prev: string;
+            next: string[];
+        } | {
+            blankLine: string;
+            prev: string[];
+            next: string;
+        } | {
+            blankLine: string;
+            prev: string[];
+            next: string[];
+        })[];
+    };
+    overrides: {
+        files: string[];
+        extends: string[];
+        plugins: string[];
+        rules: {
+            'no-new-object': string;
+        };
+        env: {
+            jest: boolean;
+        };
+    }[];
+};