@prowise/eslint-config-linting-rules 0.0.5 → 0.0.7

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"0.0.5","description":"Default Prowise linting rules for npm packages.","main":"index.js","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./frontend":"./frontend.js"},"scripts":{"lint":"eslint ."},"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.23.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","semver":"^7.3.7"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"0.0.7","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"}}

package/src/rules/base-rules.js

@@ -1,6 +1,4 @@
 const confusingBrowserGlobals = require("confusing-browser-globals");
-const eslintPkg = require("eslint/package.json");
-const semver = require("semver");
 
 module.exports = {
     /*
@@ -406,7 +404,7 @@ module.exports = {
          * Enforce that class methods use "this"
          * https://eslint.org/docs/latest/rules/class-methods-use-this.
          */
-        "class-methods-use-this": ["error", { exceptMethods: [] }],
+        "class-methods-use-this": "off",
 
         /**
          * Specify the maximum cyclomatic complexity allowed in a program
@@ -766,7 +764,7 @@ module.exports = {
          * Disallow this keywords outside of classes or class-like objects
          * https://eslint.org/docs/latest/rules/no-invalid-this.
          */
-        "no-invalid-this": "warn",
+        "no-invalid-this": "off",
 
         /**
          * Disallow usage of __iterator__ property
@@ -1056,16 +1054,6 @@ module.exports = {
          */
         "no-restricted-syntax": [
             "error",
-            {
-                selector: "ForInStatement",
-                message:
-                    "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
-            },
-            {
-                selector: "ForOfStatement",
-                message:
-                    "iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations.",
-            },
             {
                 selector: "LabeledStatement",
                 message:
@@ -1146,7 +1134,8 @@ module.exports = {
             "error",
             {
                 allow: [],
-                allowAfterThis: false,
+                allowAfterThis: true,
+                allowFunctionParams: true,
                 allowAfterSuper: false,
                 enforceInMethodNames: true,
             },
@@ -1378,7 +1367,7 @@ module.exports = {
          * Require use of the second argument for parseInt()
          * https://eslint.org/docs/latest/rules/radix.
          */
-        radix: "error",
+        radix: ["error", "as-needed"],
 
         /**
          * Require `await` in `async function` (note: this is a horrible rule that should never be used)
@@ -1472,7 +1461,7 @@ module.exports = {
          * Require parens in arrow function arguments 🔧
          * https://eslint.org/docs/latest/rules/arrow-parens.
          */
-        "arrow-parens": ["error", "as-needed", { requireForBlockBody: true }],
+        "arrow-parens": ["error", "always"],
 
         /**
          * Require space before/after arrow function"s arrow 🔧
@@ -1568,13 +1557,11 @@ module.exports = {
         "function-call-argument-newline": ["error", "consistent"],
 
         /**
-         * Require line breaks inside function parentheses if there are line breaks between parameters 🔧
+         * 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": [
-            "error",
-            semver.satisfies(eslintPkg.version, ">= 6") ? "multiline-arguments" : "consistent",
-        ],
+        "function-paren-newline": "off",
 
         /**
          * Enforce the spacing around the * in generator functions 🔧
@@ -1585,48 +1572,16 @@ 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": ["error", "beside"],
+        "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: [
-            "error",
-            4,
-            {
-                SwitchCase: 1,
-                VariableDeclarator: 1,
-                outerIIFEBody: 1,
-                FunctionDeclaration: { parameters: 1, body: 1 },
-                FunctionExpression: { parameters: 1, body: 1 },
-                CallExpression: { arguments: 1 },
-                ArrayExpression: 1,
-                ObjectExpression: 1,
-                ImportDeclaration: 1,
-                flatTernaryExpressions: false,
-                ignoredNodes: [
-                    "JSXElement",
-                    "JSXElement > *",
-                    "JSXAttribute",
-                    "JSXIdentifier",
-                    "JSXNamespacedName",
-                    "JSXMemberExpression",
-                    "JSXSpreadAttribute",
-                    "JSXExpressionContainer",
-                    "JSXOpeningElement",
-                    "JSXClosingElement",
-                    "JSXFragment",
-                    "JSXOpeningFragment",
-                    "JSXClosingFragment",
-                    "JSXText",
-                    "JSXEmptyExpression",
-                    "JSXSpreadChild",
-                ],
-                ignoreComments: false,
-            },
-        ],
+        indent: "off",
 
         /**
          * Specify whether double or single quotes should be used in JSX attributes 🔧
@@ -1788,16 +1743,17 @@ module.exports = {
         "nonblock-statement-body-position": ["error", "beside", { overrides: {} }],
 
         /**
-         * Enforce line breaks between braces 🔧
+         * Enforce line breaks between braces. 🔧
          * https://eslint.org/docs/latest/rules/object-curly-newline.
+         * Turned off => conflicting with the prettier rules.
          */
         "object-curly-newline": [
-            "error",
+            "off",
             {
-                ObjectExpression: { minProperties: 4, multiline: true, consistent: true },
-                ObjectPattern: { minProperties: 4, multiline: true, consistent: true },
-                ImportDeclaration: { minProperties: 4, multiline: true, consistent: true },
-                ExportDeclaration: { minProperties: 4, multiline: true, consistent: true },
+                ObjectExpression: { minProperties: 7, multiline: true, consistent: true },
+                ObjectPattern: { minProperties: 7, multiline: true, consistent: true },
+                ImportDeclaration: { minProperties: 7, multiline: true, consistent: true },
+                ExportDeclaration: { minProperties: 7, multiline: true, consistent: true },
             },
         ],
 
@@ -1817,7 +1773,7 @@ module.exports = {
          * Requires operator at the beginning of the line in multiline statements 🔧
          * https://eslint.org/docs/latest/rules/operator-linebreak.
          */
-        "operator-linebreak": ["error", "before", { overrides: { "=": "none" } }],
+        "operator-linebreak": ["error", "before", { overrides: { "=": "after" } }],
 
         /**
          * Disallow padding within blocks 🔧

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

@@ -30,13 +30,13 @@ module.exports = {
          * Reports invalid padding inside JSDoc blocks
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation.
          */
-        "jsdoc/check-indentation": "warn",
+        "jsdoc/check-indentation": "off",
 
         /**
          * Reports invalid alignment of JSDoc block lines
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment.
          */
-        "jsdoc/check-line-alignment": "warn",
+        "jsdoc/check-line-alignment": "off",
 
         /**
          * Ensures that parameter names in JSDoc match those in the function declaration ✅
@@ -91,7 +91,7 @@ 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": "warn",
+        "jsdoc/match-description": "off",
 
         /**
          * Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks ✅
@@ -164,7 +164,7 @@ module.exports = {
          * tag descriptions are written in complete sentences
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description-complete-sentence.
          */
-        "jsdoc/require-description-complete-sentence": "warn",
+        "jsdoc/require-description-complete-sentence": "off",
 
         /**
          * Requires that all functions have examples
@@ -219,7 +219,7 @@ module.exports = {
          * Requires that all function parameters are documented ✅
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param.
          */
-        "jsdoc/require-param": "warn",
+        "jsdoc/require-param": "off",
 
         /**
          * Requires that each `@param` tag has a `description` value ✅
@@ -244,7 +244,7 @@ module.exports = {
          * is a plain `object`, `Object`, or `PlainObject
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property.
          */
-        "jsdoc/require-property": "warn",
+        "jsdoc/require-property": "off",
 
         /**
          * Requires that each `@property` tag has a `description` value ✅
@@ -268,7 +268,7 @@ module.exports = {
          * Requires that returns are documented ✅
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns.
          */
-        "jsdoc/require-returns": "warn",
+        "jsdoc/require-returns": "off",
 
         /**
          * Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment ✅

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

@@ -521,8 +521,9 @@ 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": ["error", { multiline: "consistent", singleline: "consistent" }],
+        "react/jsx-curly-newline": "off",
 
         /**
          * Enforce or disallow spaces inside of curly braces in JSX attributes and expressions
@@ -663,19 +664,19 @@ module.exports = {
          * Disallow unnecessary fragments 🔧
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-useless-fragment.md.
          */
-        "react/jsx-no-useless-fragment": "error",
+        "react/jsx-no-useless-fragment": ["error", { allowExpressions: true }],
 
         /**
          * Require one JSX element per line 🔧
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-one-expression-per-line.md.
          */
-        "react/jsx-one-expression-per-line": ["error", { allow: "single-child" }],
+        "react/jsx-one-expression-per-line": "off",
 
         /**
          * Enforce PascalCase for user-defined JSX components
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md.
          */
-        "react/jsx-pascal-case": ["error", { allowAllCaps: true, ignore: [] }],
+        "react/jsx-pascal-case": ["error", { allowAllCaps: true, allowNamespace: true, ignore: [] }],
 
         /**
          * Disallow multiple spaces between inline JSX props 🔧
@@ -691,7 +692,7 @@ module.exports = {
             "error",
             {
                 html: "enforce",
-                custom: "enforce",
+                custom: "ignore",
                 explicitSpread: "ignore",
                 exceptions: [],
             },

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

@@ -42,7 +42,7 @@ module.exports = {
          * Require using either T[] or Array<T> for arrays 🔒 🔧
          * https://typescript-eslint.io/rules/array-type.
          */
-        "@typescript-eslint/array-type": ["error", { default: "array" }],
+        "@typescript-eslint/array-type": ["error", { default: "array-simple" }],
 
         /**
          * Disallow awaiting a value that is not a Thenable ✅  💭
@@ -132,7 +132,7 @@ module.exports = {
          * Require or disallow the Record type 🔒 🔧
          * https://typescript-eslint.io/rules/consistent-indexed-oject-style.
          */
-        "@typescript-eslint/consistent-indexed-object-style": "warn",
+        "@typescript-eslint/consistent-indexed-object-style": ["warn", "record"],
 
         /**
          * Enforce consistent usage of type assertions 🔒
@@ -143,8 +143,9 @@ module.exports = {
         /**
          * Enforce type definitions to consistently use either interface or type 🔒 🔧
          * https://typescript-eslint.io/rules/consistent-type-definitions.
+         * Turned off => we want to keep difference between defining type and interface
          */
-        "@typescript-eslint/consistent-type-definitions": "warn",
+        "@typescript-eslint/consistent-type-definitions": "off",
 
         /**
          * Enforce consistent usage of type exports 🔧 💭
@@ -173,16 +174,33 @@ module.exports = {
         "@typescript-eslint/dot-notation": baseRules["dot-notation"],
 
         /**
-         * Require explicit return types on functions and class methods
-         * https://typescript-eslint.io/rules/explicit-function-return.
+         * Require explicit return types on functions and class methods.
+         * Https://typescript-eslint.io/rules/explicit-function-return-type.
          */
-        "@typescript-eslint/explicit-function-return-type": "warn",
+        "@typescript-eslint/explicit-function-return-type": [
+            "warn",
+            {
+                allowExpressions: true,
+                allowTypedFunctionExpressions: true,
+                allowHigherOrderFunctions: true,
+                allowDirectConstAssertionInArrowFunctions: true,
+                allowConciseArrowFunctionExpressionsStartingWithVoid: true,
+            },
+        ],
 
         /**
          * Require explicit accessibility modifiers on class properties and methods 🔧 💡
          * https://typescript-eslint.io/rules/explicit-member-accessibility.
          */
-        "@typescript-eslint/explicit-member-accessibility": "error",
+        "@typescript-eslint/explicit-member-accessibility": [
+            "error",
+            {
+                accessibility: "explicit",
+                overrides: {
+                    constructors: "off",
+                },
+            },
+        ],
 
         /**
          * Require explicit return and argument types on exported functions" and classes" public class methods
@@ -264,7 +282,10 @@ module.exports = {
          * Require expressions of type void to appear in statement position 🔧 💡 💭
          * https://typescript-eslint.io/rules/no-confusing-void-expression.
          */
-        "@typescript-eslint/no-confusing-void-expression": "warn",
+        "@typescript-eslint/no-confusing-void-expression": [
+            "warn",
+            { ignoreArrowShorthand: true, ignoreVoidOperator: true },
+        ],
 
         /**
          * Disallow duplicate class members.
@@ -628,7 +649,7 @@ module.exports = {
          * Require each enum member value to be explicitly initialized 💡
          * https://typescript-eslint.io/rules/prefer-enum-initializers.
          */
-        "@typescript-eslint/prefer-enum-initializers": "warn",
+        "@typescript-eslint/prefer-enum-initializers": "off",
 
         /**
          * Enforce the use of for-of loop over the standard for loop where possible 🔒
@@ -664,7 +685,7 @@ module.exports = {
          * Enforce using the nullish coalescing operator instead of logical chaining 🔒 💡 💭
          * https://typescript-eslint.io/rules/prefer-nullish-coalescing.
          */
-        "@typescript-eslint/prefer-nullish-coalescing": "warn",
+        "@typescript-eslint/prefer-nullish-coalescing": "off",
 
         /**
          * Enforce using concise optional chain expressions instead of chained logical ands 🔒 💡
@@ -682,7 +703,7 @@ module.exports = {
          * Require function parameters to be typed as readonly to prevent accidental mutation of inputs 💭
          * https://typescript-eslint.io/rules/prefer-readonly-parameter-types.
          */
-        "@typescript-eslint/prefer-readonly-parameter-types": ["warn", { ignoreInferredTypes: true }],
+        "@typescript-eslint/prefer-readonly-parameter-types": "off",
 
         /**
          * Enforce using type parameter when calling Array#reduce instead of casting 🔒 🔧 💭
@@ -837,9 +858,9 @@ module.exports = {
         /**
          * Enforce consistent indentation.
          * Https://typescript-eslint.io/rules/indent.
+         * Turned off => conflicting with the prettier rules
          */
-        indent: "off",
-        "@typescript-eslint/indent": baseRules.indent,
+        "@typescript-eslint/indent": "off",
 
         /**
          * Enforce consistent spacing before and after keywords.