clean up

morewings · May 12, 2024 · 5cb59a4 · 5cb59a4
1 parent e891f4c
commit 5cb59a4
Show file tree

Hide file tree

Showing 34 changed files with 1,034 additions and 437 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,36 +1,44 @@
 module.exports = {
     root: true,
+    env: {browser: true, es2020: true, node: true, jest: true},
+    parserOptions: {
+        ecmaVersion: 'latest',
+        // eslint-disable-next-line no-undef
+        tsconfigRootDir: __dirname,
+        sourceType: 'module',
+    },
+    settings: {
+        react: {
+            version: 'detect',
+        },
+    },
     extends: [
+        'eslint:recommended',
         'plugin:@typescript-eslint/recommended',
-        'next/core-web-vitals',
+        'plugin:react/recommended',
+        'plugin:react/jsx-runtime',
         'plugin:react-hooks/recommended',
+        'next/core-web-vitals',
         'plugin:ssr-friendly/recommended',
-        'plugin:prettier/recommended'
+        'plugin:prettier/recommended',
     ],
     parser: '@typescript-eslint/parser',
-    parserOptions: {
-        ecmaFeatures: {
-            jsx: true
-        },
-        ecmaVersion: 2018,
-        sourceType: 'module'
-    },
-    plugins: ['prettier', '@typescript-eslint', 'ssr-friendly'],
+    plugins: ['import', 'prettier', '@typescript-eslint', 'ssr-friendly'],
     rules: {
         /**
          * Allow empty arrow functions `() => {}`, while keeping other empty functions restricted
          * @see https://eslint.org/docs/latest/rules/no-empty-function#allow-arrowfunctions
          */
-        '@typescript-eslint/no-empty-function': ['error', { allow: ['arrowFunctions'] }],
+        '@typescript-eslint/no-empty-function': ['error', {allow: ['arrowFunctions']}],
         '@typescript-eslint/ban-ts-comment': 1,
         'no-const-assign': 'error',
         /** Restrict imports from devDependencies since they are not included in library build. peerDependencies are ok */
         'import/no-extraneous-dependencies': [
             'error',
             {
                 devDependencies: false,
-                peerDependencies: true
-            }
+                peerDependencies: true,
+            },
         ],
         /**
          * Enforce import order with empty lines between import group
@@ -39,20 +47,15 @@ module.exports = {
         'import/order': [
             'error',
             {
-                groups: [
-                    'builtin',
-                    'external',
-                    'internal',
-                    ['parent', 'sibling', 'index']
-                ],
+                groups: ['builtin', 'external', 'internal', ['parent', 'sibling', 'index']],
                 pathGroups: [
                     {
                         pattern: '@/**',
-                        group: 'internal'
-                    }
+                        group: 'internal',
+                    },
                 ],
-                'newlines-between': 'always'
-            }
+                'newlines-between': 'always',
+            },
         ],
         /**
          * Disallow combined module and type imports like this `import React, {FC} from 'react'`.
@@ -61,14 +64,79 @@ module.exports = {
          */
         '@typescript-eslint/consistent-type-imports': 'error',
         'import/no-cycle': 'error',
-        'prettier/prettier': ['error', {
-            semi: true,
-            singleQuote: true,
-            jsxSingleQuote: false,
-            trailingComma: 'none',
-            bracketSpacing: true,
-            jsxBracketSameLine: true,
-            arrowParens: 'avoid'
-        }]
-    }
+        'prettier/prettier': [
+            'error',
+            {
+                semi: true,
+                singleQuote: true,
+                jsxSingleQuote: false,
+                trailingComma: 'es5',
+                bracketSpacing: false,
+                jsxBracketSameLine: true,
+                arrowParens: 'avoid',
+            },
+        ],
+        '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+        /**
+         * Allow unused variables with names stating with '_'
+         * @see https://eslint.org/docs/latest/rules/no-unused-vars
+         * @see https://typescript-eslint.io/rules/no-unused-vars/
+         */
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                argsIgnorePattern: '^_',
+                varsIgnorePattern: '^_',
+                caughtErrorsIgnorePattern: '^_',
+                ignoreRestSiblings: true,
+                args: 'after-used',
+            },
+        ],
+    },
+    overrides: [
+        /* Allow require imports for internal scripts */
+        {
+            files: ['*.js', '*.cjs'],
+            rules: {
+                '@typescript-eslint/no-var-requires': 0,
+            },
+        },
+        /* Allow devDependencies imports for tests and config files */
+        {
+            files: [
+                '**/*.spec.*',
+                '**/testUtils/*.*',
+                '**/*.js',
+                '**/*.cjs',
+                '**/setupTests.ts',
+            ],
+            rules: {
+                'import/no-extraneous-dependencies': [
+                    'error',
+                    {
+                        devDependencies: true,
+                        peerDependencies: true,
+                    },
+                ],
+            },
+        },
+        /* Disable `template` directory imports for all files */
+        {
+            files: ['./src/**/*.*'],
+            rules: {
+                'no-restricted-imports': [
+                    'error',
+                    {
+                        patterns: [
+                            {
+                                group: ['**/templates/**'],
+                                message: 'Imports from templates directory are forbidden.',
+                            },
+                        ],
+                    },
+                ],
+            },
+        }
+    ],
 };
+
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/README.md b/README.md
@@ -2,8 +2,6 @@
 
 This template is for Next based web applications using Redux.
 
-Tba
-
 ## Features
 
 - Supports **Typescript**.

diff --git a/package.json b/package.json
@@ -9,8 +9,8 @@
     "start": "next start",
     "lint:code": "eslint src/ --ext .js,.jsx,.ts,.tsx",
     "fix:code": "run-s 'lint:code --fix'",
-    "lint:style": "stylelint 'src/**/*.{ts,tsx}'",
-    "fix:style": "stylelint 'src/**/*.{ts,tsx}' --fix",
+    "lint:style": "stylelint 'src/**/*.css'",
+    "fix:style": "stylelint 'src/**/*.css' --fix",
     "lint:tsc": "tsc --pretty --noEmit",
     "prepare": "is-ci || husky install"
   },
@@ -30,11 +30,14 @@
     "@types/react-dom": "18.2.15",
     "@types/uniqid": "5.3.4",
     "@typescript-eslint/eslint-plugin": "5.62.0",
+    "@typescript-eslint/parser": "^7.8.0",
     "eslint": "8.53.0",
     "eslint-config-next": "13.5.6",
     "eslint-config-prettier": "8.10.0",
     "eslint-config-react-app": "7.0.1",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "4.6.0",
     "eslint-plugin-ssr-friendly": "1.2.0",
     "husky": "8.0.3",