@prowise/eslint-config-linting-rules 0.0.12 → 1.0.0

package/.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

package/.nvmrc

@@ -0,0 +1 @@
+18

package/index.js

@@ -13,7 +13,6 @@ module.exports = {
         "eslint-plugin-prefer-arrow",
         "eslint-plugin-jest",
         "eslint-plugin-jsdoc",
-        "eslint-plugin-prettier",
     ],
 
     parserOptions: {
@@ -39,14 +38,5 @@ module.exports = {
         "jest/no-identical-title": "error",
         "jest/prefer-to-have-length": "warn",
         "jest/valid-expect": "error",
-        "prettier/prettier": [
-            "error",
-            {
-                singleQuote: false,
-                tabWidth: 4,
-                printWidth: 120,
-                trailingComma: "all",
-            },
-        ],
     },
 };

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"0.0.12","description":"Default Prowise linting rules for npm packages.","main":"index.js","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./frontend":"./frontend.js"},"scripts":{"lint":"eslint **/*.js"},"repository":{"type":"git","url":"git+ssh://git@bitbucket.org/prowise/npm-linting-rules.git"},"author":"Prowise B.V.","license":"UNLICENSED","homepage":"https://bitbucket.org/prowise/npm-linting-rules#readme","dependencies":{"@typescript-eslint/eslint-plugin":"^5.36.2","@typescript-eslint/parser":"^5.36.2","confusing-browser-globals":"^1.0.11","eslint":"^8.24.0","eslint-import-resolver-typescript":"^3.5.1","eslint-plugin-import":"^2.26.0","eslint-plugin-jest":"^27.0.1","eslint-plugin-jsdoc":"^39.3.6","eslint-plugin-node":"^11.1.0","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-prettier":"^4.2.1","eslint-plugin-react":"^7.31.7","eslint-plugin-react-hooks":"^4.6.0","object.assign":"^4.1.4","prettier":"^2.7.1"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"1.0.0","description":"Default Prowise linting rules for npm packages.","main":"index.js","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./frontend":"./frontend.js"},"scripts":{"lint":"eslint **/*.js"},"repository":{"type":"git","url":"git+ssh://git@bitbucket.org/prowise/npm-linting-rules.git"},"author":"Prowise B.V.","license":"UNLICENSED","homepage":"https://bitbucket.org/prowise/npm-linting-rules#readme","dependencies":{"@typescript-eslint/eslint-plugin":"^5.36.2","@typescript-eslint/parser":"^5.36.2","confusing-browser-globals":"^1.0.11","eslint":"^8.24.0","eslint-import-resolver-typescript":"^3.5.1","eslint-plugin-import":"^2.26.0","eslint-plugin-jest":"^27.0.1","eslint-plugin-jsdoc":"^39.3.6","eslint-plugin-node":"^11.1.0","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-react":"^7.31.7","eslint-plugin-react-hooks":"^4.6.0","object.assign":"^4.1.4"}}

package/src/rules/base-rules.js

@@ -44,7 +44,7 @@ module.exports = {
          * Disallow await inside of loops
          * https://eslint.org/docs/latest/rules/no-await-in-loop.
          */
-        "no-await-in-loop": "error",
+        "no-await-in-loop": "off",
 
         /**
          * Disallow modifying variables of class declarations ✅
@@ -326,7 +326,7 @@ module.exports = {
          * Disallow use of variables before they are defined
          * https://eslint.org/docs/latest/rules/no-use-before-define.
          */
-        "no-use-before-define": ["error", { functions: true, classes: true, variables: true }],
+        "no-use-before-define": ["error", { functions: true, classes: true, variables: true, allowNamedExports: true }],
 
         /**
          * Disallow useless backreferences in regular expressions ✅
@@ -364,9 +364,8 @@ module.exports = {
         /**
          * Enforces no braces where they can be omitted 🔧
          * https://eslint.org/docs/latest/rules/arrow-body-style.
-         * Turned off => conflicting with the prettier rules.
          */
-        "arrow-body-style": "off",
+        "arrow-body-style": ["error", "as-needed", { requireReturnForObjectLiteral: false }],
 
         /**
          * Treat var statements as if they were block scoped
@@ -429,13 +428,13 @@ module.exports = {
          * Specify curly brace conventions for all control statements 🔧
          * https://eslint.org/docs/latest/rules/curly.
          */
-        curly: ["error", "multi-line"],
+        curly: ["error", "multi", "consistent"],
 
         /**
          * Require default case in switch statements
          * https://eslint.org/docs/latest/rules/default-case.
          */
-        "default-case": ["error", { commentPattern: "^no default$" }],
+        "default-case": ["error", { commentPattern: "^no-default$" }],
 
         /**
          * Enforce default clauses in switch statements to be last
@@ -475,7 +474,7 @@ module.exports = {
          * Require function expressions to have a name
          * https://eslint.org/docs/latest/rules/func-names.
          */
-        "func-names": "warn",
+        "func-names": "off",
 
         /**
          * Enforces use of function declarations
@@ -625,9 +624,8 @@ module.exports = {
         /**
          * Disallow arrow functions where they could be confused with comparisons 🔧
          * https://eslint.org/docs/latest/rules/no-confusing-arrow.
-         * Turned off => conflicting with the prettier rules.
          */
-        "no-confusing-arrow": "off",
+        "no-confusing-arrow": "warn",
 
         /**
          * Disallow use of console
@@ -639,7 +637,7 @@ module.exports = {
          * Disallow use of the continue statement
          * https://eslint.org/docs/latest/rules/no-continue.
          */
-        "no-continue": "error",
+        "no-continue": "warn",
 
         /**
          * Disallow deletion of variables ✅
@@ -863,7 +861,6 @@ module.exports = {
         /**
          * Disallow nested ternary expressions
          * https://eslint.org/docs/latest/rules/no-nested-ternary.
-         * Turned off => conflicting with the prettier rules.
          */
         "no-nested-ternary": "off",
 
@@ -919,7 +916,7 @@ module.exports = {
          * Disallow use of unary operators, ++ and --
          * https://eslint.org/docs/latest/rules/no-plusplus.
          */
-        "no-plusplus": "error",
+        "no-plusplus": "off",
 
         /**
          * Disallow usage of __proto__ property
@@ -1053,7 +1050,7 @@ module.exports = {
          * Disallow use of assignment in return statement
          * https://eslint.org/docs/latest/rules/no-return-assign.
          */
-        "no-return-assign": ["error", "always"],
+        "no-return-assign": "off",
 
         /**
          * Disallow redundant `return await`
@@ -1114,7 +1111,7 @@ module.exports = {
          * https://eslint.org/docs/latest/rules/no-underscore-dangle.
          */
         "no-underscore-dangle": [
-            "error",
+            "off",
             {
                 allow: [],
                 allowAfterThis: true,
@@ -1138,8 +1135,8 @@ module.exports = {
         "no-unused-expressions": [
             "error",
             {
-                allowShortCircuit: false,
-                allowTernary: false,
+                allowShortCircuit: true,
+                allowTernary: true,
                 allowTaggedTemplates: false,
             },
         ],
@@ -1154,7 +1151,7 @@ module.exports = {
          * Disallow unnecessary .call() and .apply()
          * https://eslint.org/docs/latest/rules/no-useless-call.
          */
-        "no-useless-call": "off",
+        "no-useless-call": "warn",
 
         /**
          * Disallow unnecessary catch clauses ✅
@@ -1256,9 +1253,8 @@ module.exports = {
         /**
          * Suggest using arrow functions as callbacks 🔧
          * https://eslint.org/docs/latest/rules/prefer-arrow-callback.
-         * Turned off => conflicting with the prettier rules.
          */
-        "prefer-arrow-callback": "off",
+        "prefer-arrow-callback": "warn",
 
         /**
          * Suggest using of const declaration for variables that are never modified after declared 🔧
@@ -1274,7 +1270,7 @@ module.exports = {
             "error",
             {
                 VariableDeclarator: { array: false, object: true },
-                AssignmentExpression: { array: true, object: false },
+                AssignmentExpression: { array: false, object: false },
             },
             {
                 enforceForRenamedProperties: false,
@@ -1543,7 +1539,6 @@ module.exports = {
         /**
          * Require line breaks inside function parentheses if there are line breaks between parameters. 🔧
          * https://eslint.org/docs/latest/rules/function-paren-newline.
-         * Turned off => conflicting with the prettier rules.
          */
         "function-paren-newline": "off",
 
@@ -1556,16 +1551,14 @@ module.exports = {
         /**
          * Enforce the location of arrow function bodies with implicit returns 🔧
          * https://eslint.org/docs/latest/rules/implicit-arrow-linebreak.
-         * Turned off => conflicting with the prettier rules.
          */
         "implicit-arrow-linebreak": "off",
 
         /**
          * This option sets a specific tab width for your code 🔧
          * https://eslint.org/docs/latest/rules/indent.
-         * Turned off => conflicting with the prettier rules.
          */
-        indent: "off",
+        indent: "error",
 
         /**
          * Specify whether double or single quotes should be used in JSX attributes 🔧
@@ -1625,7 +1618,7 @@ module.exports = {
          * Require or disallow an empty line between class members 🔧
          * https://eslint.org/docs/latest/rules/lines-between-class-members.
          */
-        "lines-between-class-members": ["error", "always", { exceptAfterSingleLine: false }],
+        "lines-between-class-members": ["error", "always", { exceptAfterSingleLine: true }],
 
         /**
          * Specify the maximum length of a line in your program
@@ -1633,9 +1626,9 @@ module.exports = {
          */
         "max-len": [
             "error",
-            120,
-            2,
             {
+                code: 120,
+                tabWidth: 4,
                 ignoreUrls: true,
                 ignoreComments: false,
                 ignoreRegExpLiterals: true,
@@ -1666,7 +1659,7 @@ module.exports = {
          * Enforces new line after each method call in the chain to make it more readable and easy to maintain 🔧
          * https://eslint.org/docs/latest/rules/newline-per-chained-call.
          */
-        "newline-per-chained-call": ["error", { ignoreChainWithDepth: 4 }],
+        "newline-per-chained-call": ["error", { ignoreChainWithDepth: 3 }],
 
         /**
          * Disallow unnecessary parentheses 🔧
@@ -1724,15 +1717,14 @@ module.exports = {
          * Enforce the location of single-line statements 🔧
          * https://eslint.org/docs/latest/rules/nonblock-statement-body-position.
          */
-        "nonblock-statement-body-position": ["error", "beside", { overrides: {} }],
+        "nonblock-statement-body-position": ["error", "any", { overrides: {} }],
 
         /**
          * Enforce line breaks between braces. 🔧
          * https://eslint.org/docs/latest/rules/object-curly-newline.
-         * Turned off => conflicting with the prettier rules.
          */
         "object-curly-newline": [
-            "off",
+            "error",
             {
                 ObjectExpression: { minProperties: 7, multiline: true, consistent: true },
                 ObjectPattern: { minProperties: 7, multiline: true, consistent: true },
@@ -1756,9 +1748,8 @@ module.exports = {
         /**
          * Requires operator at the beginning of the line in multiline statements 🔧
          * https://eslint.org/docs/latest/rules/operator-linebreak.
-         * Turned off => conflicting with the prettier rules.
          */
-        "operator-linebreak": "off",
+        "operator-linebreak": ["error", "before"],
 
         /**
          * Disallow padding within blocks 🔧

package/src/rules/plugin-import-rules.js

@@ -300,6 +300,7 @@ module.exports = {
                         position: "before",
                     },
                 ],
+                alphabetize: { order: "asc", caseInsensitive: true },
             },
         ],
 

package/src/rules/plugin-jsdoc-rules.js

@@ -91,8 +91,13 @@ module.exports = {
          * Enforces a regular expression pattern on descriptions
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description.
          */
-        "jsdoc/match-description": "off",
-
+        "jsdoc/match-description": [
+            "error",
+            {
+                matchDescription: "[A-Z].*",
+                message: "The default description should begin with a capital letter",
+            },
+        ],
         /**
          * Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks ✅
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-multiline-blocks.

package/src/rules/plugin-react-rules.js

@@ -23,8 +23,9 @@ module.exports = {
 
         "jsx-quotes": ["error", "prefer-double"],
 
+        // turned off just like in the base rules
         "class-methods-use-this": [
-            "error",
+            "off",
             {
                 exceptMethods: [
                     "render",
@@ -374,8 +375,9 @@ module.exports = {
         /**
          * Enforce a defaultProps definition for every prop that is not a required prop
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/require-default-props.md.
+         * Turned off: a bit of overkill
          */
-        "react/require-default-props": ["error", { forbidDefaultForRequired: true }],
+        "react/require-default-props": ["off", { forbidDefaultForRequired: true }],
 
         /**
          * Enforce React components to have a shouldComponentUpdate method
@@ -521,9 +523,8 @@ module.exports = {
         /**
          * Enforce consistent linebreaks in curly braces in JSX attributes and expressions
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-curly-newline.md.
-         * Turned off => conflicting with the prettier rules
          */
-        "react/jsx-curly-newline": "off",
+        "react/jsx-curly-newline": ["off", { multiline: "consistent", singleline: "consistent" }],
 
         /**
          * Enforce or disallow spaces inside of curly braces in JSX attributes and expressions
@@ -565,7 +566,7 @@ module.exports = {
          * Enforce JSX indentation 🔧
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-indent.md.
          */
-        "react/jsx-indent": ["error", 4],
+        "react/jsx-indent": "error",
 
         /**
          * Enforce props indentation in JSX 🔧

package/src/rules/plugin-typescript-rules.js

@@ -156,8 +156,9 @@ module.exports = {
         /**
          * Enforce consistent usage of type imports  🔧
          * https://typescript-eslint.io/rules/consistent-type-imports.
+         * Turned off to allow us to use type import to prevent circular import warning.
          */
-        "@typescript-eslint/consistent-type-imports": ["warn", { prefer: "no-type-imports" }],
+        "@typescript-eslint/consistent-type-imports": ["off", { prefer: "no-type-imports" }],
 
         /**
          * Enforce default parameters to be last.
@@ -191,14 +192,12 @@ module.exports = {
         /**
          * Require explicit accessibility modifiers on class properties and methods 🔧 💡
          * https://typescript-eslint.io/rules/explicit-member-accessibility.
+         * Defaults to public, other accessability must be set explicitly!
          */
         "@typescript-eslint/explicit-member-accessibility": [
             "error",
             {
-                accessibility: "explicit",
-                overrides: {
-                    constructors: "off",
-                },
+                accessibility: "no-public",
             },
         ],
 
@@ -858,9 +857,9 @@ module.exports = {
         /**
          * Enforce consistent indentation.
          * Https://typescript-eslint.io/rules/indent.
-         * Turned off => conflicting with the prettier rules
          */
-        "@typescript-eslint/indent": "off",
+        indent: "off",
+        "@typescript-eslint/indent": baseRules.indent,
 
         /**
          * Enforce consistent spacing before and after keywords.
@@ -937,9 +936,7 @@ module.exports = {
                     (result, devDep) => {
                         const toAppend = [devDep];
                         const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, "ts$1");
-                        if (devDepWithTs !== devDep) {
-                            toAppend.push(devDepWithTs);
-                        }
+                        if (devDepWithTs !== devDep) toAppend.push(devDepWithTs);
                         return [...result, ...toAppend];
                     },
                 ),