Merge pull request #323 from belgattitude/linters-improved

Example with sonarjs eslint plugin

.changeset/popular-penguins-cover.md

@@ -0,0 +1,9 @@
+---
+'blog-app': minor
+'web-app': minor
+'@your-org/core-lib': minor
+'@your-org/db-main-prisma': minor
+'@your-org/ui-lib': minor
+---
+
+Example: eslint-plugin-sonarjs cause cause it desserves to belong here

.eslintrc.base.json

@@ -1,6 +1,7 @@
 {
   "root": true,
   "extends": [
+    "plugin:sonarjs/recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended",
     "plugin:jest/recommended"
@@ -10,7 +11,8 @@
     "prettier",
     "react-hooks",
     "jest",
-    "jest-formatting"
+    "jest-formatting",
+    "sonarjs"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -30,8 +32,9 @@
     "no-empty-function": "off",
     "@typescript-eslint/no-empty-function": [
       "error",
-      { "allow": ["private-constructors", "decoratedFunctions"] }
-    ]
+      { "allow": ["private-constructors"] }
+    ],
+    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
   },
   "overrides": [
     {
@@ -55,7 +58,9 @@
       "rules": {
         "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-var-requires": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off"
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "sonarjs/no-duplicate-string": "off",
+        "sonarjs/no-all-duplicated-branches": "off"
       }
     },
     {

README.md

@@ -443,6 +443,8 @@ An example of base eslint configuration can be found in [./.eslint.base.json](./
 and packages extends it in their own root folder, as an example see [./apps/web-app/.eslintrc.json](./apps/web-app/.eslintrc.json).
 Prettier is included in eslint configuration as well as [eslint-config-next](https://nextjs.org/docs/basic-features/eslint) for nextjs apps.
 
+For code complexity and deeper code analysis [sonarjs plugin](https://github.com/SonarSource/eslint-plugin-sonarjs) is activated.
+
 ### 5.2 Hooks / Lint-staged
 
 Check the [.husky](./.husky) folder content to see what hooks are enabled. Lint-staged is used to guarantee

apps/blog-app/next.config.js

@@ -110,7 +110,7 @@ const nextConfig = {
   },
 
   // @ts-ignore
-  webpack: function (config, { defaultLoaders }) {
+  webpack: function (config, { _defaultLoaders }) {
     config.module.rules.push({
       test: /\.svg$/,
       issuer: /\.(js|ts)x?$/,

apps/blog-app/package.json

@@ -73,6 +73,7 @@
     "eslint-plugin-prettier": "3.4.1",
     "eslint-plugin-react": "7.24.0",
     "eslint-plugin-react-hooks": "4.2.0",
+    "eslint-plugin-sonarjs": "0.10.0",
     "eslint-plugin-testing-library": "4.12.0",
     "jest": "27.1.0",
     "jest-css-modules-transform": "4.3.0",

apps/web-app/.eslintrc.json

@@ -39,6 +39,12 @@
         "@typescript-eslint/explicit-module-boundary-types": "off"
       }
     },
+    {
+      "files": ["src/backend/api/**/*.ts"],
+      "rules": {
+        "@typescript-eslint/explicit-module-boundary-types": "off"
+      }
+    },
     {
       "files": ["**/*.devtool.ts", "**/*.devtool.tsx"],
       "rules": {

apps/web-app/next.config.js

@@ -123,7 +123,7 @@ const nextConfig = {
   },
 
   // @ts-ignore
-  webpack: (config, { defaultLoaders, isServer }) => {
+  webpack: (config, { isServer, _defaultLoaders }) => {
     // A temp workaround for https://github.com/prisma/prisma/issues/6899#issuecomment-849126557
     if (isServer) {
       config.externals.push('_http_common');

apps/web-app/package.json

@@ -81,6 +81,7 @@
     "eslint-plugin-prettier": "3.4.1",
     "eslint-plugin-react": "7.24.0",
     "eslint-plugin-react-hooks": "4.2.0",
+    "eslint-plugin-sonarjs": "0.10.0",
     "eslint-plugin-testing-library": "4.12.0",
     "jest": "27.1.0",
     "jest-css-modules-transform": "4.3.0",

apps/web-app/src/pages/demo.tsx

@@ -9,7 +9,7 @@ type Props = {
 };
 
 export default function DemoRoute(
-  props: InferGetServerSidePropsType<typeof getServerSideProps>
+  _props: InferGetServerSidePropsType<typeof getServerSideProps>
 ) {
   return <DemoPage />;
 }

apps/web-app/src/pages/home.tsx

@@ -9,7 +9,7 @@ type Props = {
 };
 
 export default function HomeRoute(
-  props: InferGetServerSidePropsType<typeof getServerSideProps>
+  _props: InferGetServerSidePropsType<typeof getServerSideProps>
 ) {
   return <HomePage />;
 }

packages/core-lib/package.json

@@ -51,6 +51,7 @@
     "eslint-plugin-prettier": "3.4.1",
     "eslint-plugin-react": "7.24.0",
     "eslint-plugin-react-hooks": "4.2.0",
+    "eslint-plugin-sonarjs": "0.10.0",
     "eslint-plugin-testing-library": "4.12.0",
     "jest": "27.1.0",
     "microbundle": "0.13.3",

packages/core-lib/src/utils/random-utils.ts

@@ -6,7 +6,7 @@ export class RandomUtils {
    * lower than max if max isn't an integer).
    * @link https://stackoverflow.com/questions/1527803/generating-random-whole-numbers-in-javascript-in-a-specific-range/1527820#1527820
    */
-  static getRandomInt(min: number, max: number) {
+  static getRandomInt(min: number, max: number): number {
     min = Math.ceil(min);
     max = Math.floor(max);
     return Math.floor(Math.random() * (max - min + 1)) + min;

packages/db-main-prisma/.eslintrc.json

@@ -1,8 +1,15 @@
 {
   "root": true,
-  "extends": ["../../.eslintrc.base.json", "plugin:jsx-a11y/recommended"],
+  "extends": ["../../.eslintrc.base.json"],
   "env": {
     "browser": true
   },
-  "overrides": []
+  "overrides": [
+    {
+      "files": ["*.seed.ts", "*.seed.js"],
+      "rules": {
+        "sonarjs/no-duplicate-string": "off"
+      }
+    }
+  ]
 }

packages/db-main-prisma/package.json

@@ -41,6 +41,7 @@
     "eslint-plugin-jest": "24.4.0",
     "eslint-plugin-jest-formatting": "3.0.0",
     "eslint-plugin-prettier": "3.4.1",
+    "eslint-plugin-sonarjs": "0.10.0",
     "jest": "27.1.0",
     "keyword-extractor": "0.0.20",
     "npm-run-all": "4.1.5",

packages/ui-lib/package.json

@@ -47,6 +47,7 @@
     "eslint-plugin-prettier": "3.4.1",
     "eslint-plugin-react": "7.24.0",
     "eslint-plugin-react-hooks": "4.2.0",
+    "eslint-plugin-sonarjs": "0.10.0",
     "eslint-plugin-testing-library": "4.12.0",
     "jest": "27.1.0",
     "microbundle": "0.13.3",

yarn.lock

@@ -3849,6 +3849,7 @@ __metadata:
     eslint-plugin-prettier: 3.4.1
     eslint-plugin-react: 7.24.0
     eslint-plugin-react-hooks: 4.2.0
+    eslint-plugin-sonarjs: 0.10.0
     eslint-plugin-testing-library: 4.12.0
     jest: 27.1.0
     microbundle: 0.13.3
@@ -3888,6 +3889,7 @@ __metadata:
     eslint-plugin-jest: 24.4.0
     eslint-plugin-jest-formatting: 3.0.0
     eslint-plugin-prettier: 3.4.1
+    eslint-plugin-sonarjs: 0.10.0
     jest: 27.1.0
     keyword-extractor: 0.0.20
     npm-run-all: 4.1.5
@@ -3924,6 +3926,7 @@ __metadata:
     eslint-plugin-prettier: 3.4.1
     eslint-plugin-react: 7.24.0
     eslint-plugin-react-hooks: 4.2.0
+    eslint-plugin-sonarjs: 0.10.0
     eslint-plugin-testing-library: 4.12.0
     jest: 27.1.0
     microbundle: 0.13.3
@@ -4916,6 +4919,7 @@ __metadata:
     eslint-plugin-prettier: 3.4.1
     eslint-plugin-react: 7.24.0
     eslint-plugin-react-hooks: 4.2.0
+    eslint-plugin-sonarjs: 0.10.0
     eslint-plugin-testing-library: 4.12.0
     jest: 27.1.0
     jest-css-modules-transform: 4.3.0
@@ -7479,6 +7483,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"eslint-plugin-sonarjs@npm:0.10.0":
+  version: 0.10.0
+  resolution: "eslint-plugin-sonarjs@npm:0.10.0"
+  peerDependencies:
+    eslint: ^5.0.0 || ^6.0.0 || ^7.0.0
+  checksum: 6ef5b2050180a612b310610d9b1f2a89508ecf41326573cd62977ad085b25a6be7e31f47eee5857fb43b4bbd1bea1454419b52545ee3cb6cb2185a1938872009
+  languageName: node
+  linkType: hard
+
 "eslint-plugin-testing-library@npm:4.12.0":
   version: 4.12.0
   resolution: "eslint-plugin-testing-library@npm:4.12.0"
@@ -17052,6 +17065,7 @@ resolve@^2.0.0-next.3:
     eslint-plugin-prettier: 3.4.1
     eslint-plugin-react: 7.24.0
     eslint-plugin-react-hooks: 4.2.0
+    eslint-plugin-sonarjs: 0.10.0
     eslint-plugin-testing-library: 4.12.0
     graphql: 15.5.1
     i18next: 20.4.0