@prowise/eslint-config-linting-rules 2.0.7 → 2.1.1

package/README.md

@@ -14,35 +14,82 @@ Rules are based on:
 ## 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:
-    * Plain javascript project: `"extends": ["@prowise/eslint-config-linting-rules"],`
-    * Typescript project: `"extends": ["@prowise/eslint-config-linting-rules/typescript"],`
-    * Node-typescript backend project: `"extends": ["@prowise/eslint-config-linting-rules/backend"],`
-    * React-typescript frontend project: `"extends": ["@prowise/eslint-config-linting-rules/frontend"],`
+* Create a `eslint.config.js` file in the root folder of your project
+* Depending on the type of project import one of the predefined flavours:
+    * Plain javascript project: `import base from "@prowise/eslint-config-linting-rules"`
+    * Typescript project: `import typescript from "@prowise/eslint-config-linting-rules/typescript"`
+    * Node-typescript backend project: `import backend from "@prowise/eslint-config-linting-rules/backend"`
+    * React-typescript frontend project: `import frontend from "@prowise/eslint-config-linting-rules/frontend"`
+* Export the settings/rules, for example `export default frontend` for a frontend project.
 
-Note: Don't forget to add the project to your `parserOptions` in the `.eslintrc.js` file for typescript projects!
+If You want to add or overrule some settings you can add those by spreading the imported flavour and add the additions or overrides like the following examples.
 
-Sample of a `.eslintrc.js` file:
+NOTE: If you have a typescript project, you need to point to a `tsconfig.json` file which includes all the files which ESLint needs to check.
+
+Sample of a `eslint.config.js` file for a backend project using node and typescript:
 ```
-module.exports = {
-    extends: ["@prowise/eslint-config-linting-rules/frontend"],
-    parserOptions: {
-        project: "./tsconfig.json",
+import backend from "@prowise/eslint-config-linting-rules/backend";
+
+export default [...backend, {
+    ignores: [
+        "/**/reports",
+        "/dist",
+    ],
+    languageOptions: {
+        parserOptions: { project: "./tsconfig.json" },
     },
-};
+}];
 
 ```
-## Know issues
 
-#### ESM extension rules
-The `esm-extensions/force-extensions` rule might not work correctly when you use the `path` option in `tsconfig.json`. This has to do with the fact that the rule determines external packages by looking at the `node_modules` folder which cannot be found.
+Sample of a `eslint.config.js` file for a frontend project using react and typescript:
+```
+import backend from "@prowise/eslint-config-linting-rules/frontend";
+
+export default [...frontend, {
+    ignores: [
+        "/**/reports",
+        "/dist",
+    ],
+    languageOptions: {
+        parserOptions: { project: "./tsconfig.json" },
+    },
+}];
+
+```
+
+Additional information can be found at: https://eslint.org/docs/latest/use/getting-started
+
 
-It is best NOT to use paths redirects.
+## Migrating from version 1 (eslint <= 8.*.*)
+
+Version 2 of this library uses ESlint >= 9.*.*. This version of ESLint uses flat configuration which means that it only reads 1 configuration file in the root folder of your project.
+You need to remove all `.eslintrc` and `.eslintignore` files from all sub folders and add the configuration to the main `eslint.config.js` file.
+
+If you want different configuration for the different folders yo can use the following config as example:
+```
+import frontend from "@prowise/eslint-config-linting-rules/frontend";
+
+export default [...frontend,
+    {
+        ignores: [
+            "/**/reports",
+            "/dist",
+        ],
+        languageOptions: {
+            parserOptions: { project: "./tsconfig.json" },
+        },
+    },
+    {
+        files: ["tests/**/*],
+        rules: {
+            jsdoc/require-jsdoc: "off",
+        },
+    },
+];
+
+```
 
-#### Installing a new version
-When trying to update the installed lining version by `npm i -D "@prowise/eslint-config-linting-rules@latest` you might get an error on a peer dependency.
-In this case you can uninstall the linter by `npm uninstall "@prowise/eslint-config-linting-rules` and reinstall it again with `npm i -D "@prowise/eslint-config-linting-rules@latest`
+As you can see, the overrides are applicable to the files given in the `files` attribute. When you leave it undefined it applies to all files selected by the run command.
 
-## Version 2
-This version contains several breaking changes. This version is only tested on a backend project.
-For the moment: DO NOT USE this version on a frontend project! You best use the latest version 1.2.13
+For additional information see the official documentation on https://eslint.org/docs/latest/use/configure/migration-guide

package/eslint.back.js

@@ -0,0 +1,9 @@
+import base from "./base.js";
+import node from "./rules/plugin-node-rules.js";
+
+export default [base, node, {
+    rules: {
+        "import/no-named-as-default-member": "off",
+        "import/no-named-as-default": "off",
+    },
+}];

package/next.js

@@ -0,0 +1,24 @@
+import globals from "globals";
+import base from "./base.js";
+import next from "./rules/plugin-next-rules.js";
+import react from "./rules/plugin-react-rules.js";
+import typescript from "./rules/plugin-typescript-rules.js";
+import vitest from "./rules/plugin-vitest-rules.js";
+
+export default [
+    base,
+    typescript,
+    react,
+    next,
+    vitest,
+    {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+                Atomics: "readonly",
+                SharedArrayBuffer: "readonly",
+            },
+        },
+    },
+];

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"2.0.7","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./front-react":"./front-react.js","./front-solid":"./front-solid.js"},"scripts":{"lint":"eslint","inspect":"eslint --inspect-config"},"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":{"@stylistic/eslint-plugin":"^2.12.1","confusing-browser-globals":"^1.0.11","eslint":"^9.16.0","eslint-import-resolver-typescript":"^3.7.0","eslint-plugin-import-x":"^4.5.0","eslint-plugin-jest":"^28.9.0","eslint-plugin-jsdoc":"^50.6.1","eslint-plugin-jsx-a11y":"^6.10.2","eslint-plugin-n":"^17.15.0","eslint-plugin-prefer-arrow-functions":"^3.4.1","eslint-plugin-react":"^7.37.2","eslint-plugin-solid":"^0.14.5","eslint-plugin-vitest":"^0.5.4","globals":"^15.13.0","typescript-eslint":"^8.18.0"},"devDependencies":{"@eslint/config-inspector":"^0.6.0"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"2.1.1","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./front-react":"./front-react.js","./front-solid":"./front-solid.js","./next":"./next.js"},"scripts":{"lint":"eslint","inspect":"eslint --inspect-config"},"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":{"@next/eslint-plugin-next":"^15.1.0","@stylistic/eslint-plugin":"^2.12.1","confusing-browser-globals":"^1.0.11","eslint":"^9.17.0","eslint-import-resolver-typescript":"^3.7.0","eslint-plugin-import-x":"^4.5.0","eslint-plugin-jest":"^28.9.0","eslint-plugin-jsdoc":"^50.6.1","eslint-plugin-jsx-a11y":"^6.10.2","eslint-plugin-n":"^17.15.0","eslint-plugin-prefer-arrow-functions":"^3.4.1","eslint-plugin-react":"^7.37.2","eslint-plugin-react-hooks":"^5.1.0","eslint-plugin-solid":"^0.14.5","eslint-plugin-vitest":"^0.5.4","globals":"^15.13.0","typescript-eslint":"^8.18.1"},"devDependencies":{"@eslint/config-inspector":"^0.6.0"}}

package/rules/plugin-next-rules.js

@@ -0,0 +1,147 @@
+import nextPlugin from "@next/eslint-plugin-next";
+
+/*
+    * ✅ recommended
+    * 🔒 strict
+    * 🔧 fixable
+    * 💡 has suggestion
+    * 💭 requires type information
+    */
+
+export default {
+    plugins: {
+        next: nextPlugin,
+    },
+
+    rules: {
+        // warnings
+
+        /**
+         * Enforce font-display behavior with Google Fonts.
+         * https://nextjs.org/docs/messages/google-font-display
+         */
+        "next/google-font-display": "warn",
+
+        /**
+         * Ensure preconnect is used with Google Fonts.
+         * https://nextjs.org/docs/messages/google-font-preconnect
+         */
+        "next/google-font-preconnect": "warn",
+
+        /**
+         * Prefer next/script component when using the inline script for Google Analytics.
+         * https://nextjs.org/docs/messages/next-script-for-ga
+         */
+        "next/next-script-for-ga": "warn",
+
+        /**
+         * Prevent client components from being async functions.
+         * https://nextjs.org/docs/messages/no-async-client-component
+         */
+        "next/no-async-client-component": "warn",
+
+        /**
+         * Prevent usage of next/script's beforeInteractive strategy outside of pages/_document.js.
+         * https://nextjs.org/docs/messages/no-before-interactive-script-outside-document
+         */
+        "next/no-before-interactive-script-outside-document": "warn",
+
+        /**
+         * Prevent manual stylesheet tags.
+         * https://nextjs.org/docs/messages/no-css-tags
+         */
+        "next/no-css-tags": "warn",
+
+        /**
+         * Prevent usage of <head> element.
+         * https://nextjs.org/docs/messages/no-head-element
+         */
+        "next/no-head-element": "warn",
+
+        /**
+         * Prevent usage of <a> elements to navigate to internal Next.js pages.
+         * https://nextjs.org/docs/messages/no-html-link-for-pages
+         */
+        "next/no-html-link-for-pages": "warn",
+
+        /**
+         * Prevent usage of <img> element due to slower LCP and higher bandwidth.
+         * https://nextjs.org/docs/messages/no-img-element
+         */
+        "next/no-img-element": "warn",
+
+        /**
+         * Prevent page-only custom fonts.
+         * https://nextjs.org/docs/messages/no-page-custom-font
+         */
+        "next/no-page-custom-font": "warn",
+
+        /**
+         * Prevent usage of styled-jsx in pages/_document.js.
+         * https://nextjs.org/docs/messages/no-styled-jsx-in-document
+         */
+        "next/no-styled-jsx-in-document": "warn",
+
+        /**
+         * Prevent synchronous scripts.
+         * https://nextjs.org/docs/messages/no-sync-scripts
+         */
+        "next/no-sync-scripts": "warn",
+
+        /**
+         * Prevent usage of <title> with Head component from next/document.
+         * https://nextjs.org/docs/messages/no-title-in-document-head
+         */
+        "next/no-title-in-document-head": "warn",
+
+        /**
+         * Prevent common typos in Next.js's data fetching functions
+         * https://nextjs.org/docs
+         */
+        "next/no-typos": "warn",
+
+        /**
+         * Prevent duplicate polyfills from Polyfill.io.
+         * https://nextjs.org/docs/messages/no-unwanted-polyfillio
+         */
+        "next/no-unwanted-polyfillio": "warn",
+
+        // errors
+
+        /**
+         * Enforce id attribute on next/script components with inline content
+         * https://nextjs.org/docs/messages/inline-script-id
+         */
+        "next/inline-script-id": "error",
+
+        /**
+         * Prevent assignment to the module variable.
+         * https://nextjs.org/docs/messages/no-assign-module-variable
+         */
+        "next/no-assign-module-variable": "error",
+
+        /**
+         * Prevent importing next/document outside of pages/_document.js
+         * https://nextjs.org/docs/messages/no-document-import-in-page
+         */
+        "next/no-document-import-in-page": "error",
+
+        /**
+         * Prevent duplicate usage of <Head> in pages/_document.js
+         * https://nextjs.org/docs/messages/no-duplicate-head
+         */
+        "next/no-duplicate-head": "error",
+
+        /**
+         * Prevent usage of next/head in pages/_document.js.
+         * https://nextjs.org/docs/messages/no-head-import-in-document
+         */
+        "next/no-head-import-in-document": "error",
+
+        /**
+         * Prevent usage of next/script in next/head component.
+         * https://nextjs.org/docs/messages/no-script-component-in-head
+         */
+        "next/no-script-component-in-head": "error",
+    },
+};

package/rules/plugin-react-rules.js

@@ -1,4 +1,5 @@
 import reactPlugin from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
 
 export default {
     /*
@@ -8,7 +9,8 @@ export default {
      */
 
     plugins: {
-        react: reactPlugin,
+        "react": reactPlugin,
+        "react-hooks": reactHooks,
     },
 
     rules: {
@@ -761,5 +763,7 @@ export default {
                 format: ["PascalCase"],
             },
         ],
+        "react-hooks/rules-of-hooks": "error",
+        "react-hooks/exhaustive-deps": "warn",
     },
 };