@prowise/eslint-config-linting-rules 1.0.18 → 1.1.1

package/README.md

@@ -1,15 +1,17 @@
-# Prowise linting rules #
+# Prowise linting rules
 
 This repository contains the Prowise basic linting rules
 Rules are based on:
-* the airbnb rule sets
-* the recommended rules of eslint and the different plugins
-* Prowise preferences
-### What is this repository for? ###
+
+* The Airbnb rule sets
+* The recommended rules of Eslint and the different plugins
+* Prowise Style Guide
+
+### What is this repository for?
 
 * Easy setup to all linting rules on a code repository
 
-### How to use ###
+### How to use
 
 * Install this package with `npm install @prowise/eslint-config-linting-rules -D`
 * Depending on the type of project, add the following line to your `eslintrc` file:
@@ -29,5 +31,4 @@ module.exports = {
     },
 };
 
-```
-
+```

package/backend.js

@@ -5,7 +5,8 @@ module.exports = {
 
     env: { node: true },
 
-    plugins: ["eslint-plugin-node"],
+    // For Node, we require that you add extensions (.js) to every Javascript/Typescript file.
+    plugins: ["eslint-plugin-node", "require-extensions"],
 
     rules: { ...nodeRules },
 };

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"1.0.18","description":"Default Prowise linting rules for npm packages.","main":"index.js","exports":{"./default":"./index.js","./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":"^6.7.3","@typescript-eslint/parser":"^6.7.3","confusing-browser-globals":"^1.0.11","eslint":"^8.50.0","eslint-import-resolver-typescript":"^3.6.1","eslint-plugin-import":"^2.28.1","eslint-plugin-jest":"^27.4.0","eslint-plugin-jsdoc":"^46.8.2","eslint-plugin-node":"^11.1.0","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-react":"^7.33.2","eslint-plugin-react-hooks":"^4.6.0","object.assign":"^4.1.4"},"overrides":{"semver":"^7.5.3"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"1.1.1","description":"Default Prowise linting rules for npm packages.","main":"index.js","exports":{"./default":"./index.js","./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":"^6.16.0","@typescript-eslint/parser":"^6.16.0","confusing-browser-globals":"^1.0.11","eslint":"^8.56.0","eslint-import-resolver-typescript":"^3.6.1","eslint-plugin-import":"^2.29.1","eslint-plugin-jest":"^27.6.0","eslint-plugin-jsdoc":"^46.9.1","eslint-plugin-node":"^11.1.0","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-react":"^7.33.2","eslint-plugin-react-hooks":"^4.6.0","eslint-plugin-require-extensions":"^0.1.3","object.assign":"^4.1.5"},"overrides":{"semver":"^7.5.3"}}

package/src/rules/base-rules.js

@@ -1298,7 +1298,7 @@ module.exports = {
         /**
          * Disallow use of Object.prototype.hasOwnProperty.call() and prefer use of Object.hasOwn() 🔧
          * https://eslint.org/docs/latest/rules/prefer-object-has-own.
-         * Turned off: only supported with ES2022 and node 18: can be turned on when all projects support node18/ES2022
+         * Turned off: only supported with ES2022 and node 18: can be turned on when all projects support node18/ES2022.
          */
         "prefer-object-has-own": "off",
 

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

@@ -27,6 +27,8 @@ module.exports = {
         /**
          * Ensure consistent use of file extension within the import path
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md.
+         *
+         * Only warn, do not error on this, certain bundlers might accept it.
          */
         "import/extensions": ["error", "ignorePackages", { js: "never", mjs: "never", jsx: "never" }],
 

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

@@ -60,8 +60,30 @@ module.exports = {
         /**
          * Reports invalid block tag names ✅
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names.
-         */
-        "jsdoc/check-tag-names": "warn",
+         * Defined tags are valid typedoc tags
+         */
+        "jsdoc/check-tag-names": ["warn", {
+            definedTags: [
+                "alpha",
+                "beta",
+                "category",
+                "defaultValue",
+                "eventProperty",
+                "experimental",
+                "group",
+                "hidden",
+                "internal",
+                "label",
+                "link",
+                "overload",
+                "packageDocumentation",
+                "privateRemarks",
+                "remarks",
+                "template",
+                "typeParam",
+                "virtual",
+            ],
+        }],
 
         /**
          * Reports invalid types ✅
@@ -162,9 +184,23 @@ module.exports = {
          * Requires that block description, explicit `@description`, and `@param`/`@returns`
          * tag descriptions are written in complete sentences
          * https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description-complete-sentence.
-         * Keep this on, new projects should have this on!
-         */
-        "jsdoc/require-description-complete-sentence": "warn",
+         *
+         * This is disabled for the following reason:
+         *
+         * - It makes a lot of mistakes, such as considering two words a sentence
+         *      or considering an URL a sentence.
+         * - It gets in the way of developer productivity, if you need a spell checker
+         *      or sentence tool, install one in your IDE.
+         * - The autofixer is very liberal with its autofixing of dots at the end
+         *      of the sentence, which often leads to wrong dots. Therefore, readability
+         *      actually gets worse.
+         *
+         * In conclusion, if you write JSDocs, please actually take time to write,
+         * instead of relying on some broken jsdoc rule.
+         *
+         * If you cannot do that, PR reviewers should call you out on it.
+         */
+        "jsdoc/require-description-complete-sentence": "off",
 
         /**
          * Requires that all functions have examples

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

@@ -57,5 +57,17 @@ module.exports = {
          * https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-exit.md.
          */
         "node/no-process-exit": "off",
+
+        /**
+         * Require specifying an extension for Node projects when in ESM export mode.
+         * Node does not support leaving out the extension when importing.
+         * Therefore all backend Node.js projects should always include .js as an extension.
+         *
+         * This does not effect projects that use CJS exports, but it doesn't hurt either.
+         * Https://github.com/solana-labs/eslint-plugin-require-extensions.
+         */
+        "import/extensions": "off",
+        "require-extensions/require-extensions": "error",
+        "require-extensions/require-index": "error",
     },
 };

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

@@ -375,7 +375,7 @@ 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
+         * Turned off: a bit of overkill.
          */
         "react/require-default-props": ["off", { forbidDefaultForRequired: true }],
 

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

@@ -97,6 +97,7 @@ module.exports = {
                     Symbol: {
                         message: "Avoid using the `Symbol` type. Did you mean `symbol`?",
                     },
+                    "{}": false,
                 },
             },
         ],
@@ -143,7 +144,7 @@ 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
+         * Turned off => we want to keep difference between defining type and interface.
          */
         "@typescript-eslint/consistent-type-definitions": "off",