@frontify/eslint-config-basic 0.18.1 → 0.19.0-next.1

package/index.js

@@ -1,29 +1,98 @@
 /* (c) Copyright Frontify Ltd., all rights reserved. */
 
 module.exports = {
+    reportUnusedDisableDirectives: true,
     env: {
         es6: true,
         browser: true,
         node: true,
     },
-    plugins: ['html', 'unicorn', 'no-only-tests', 'promise', 'lodash', 'prettier'],
+    plugins: ['@typescript-eslint', 'unicorn', 'no-only-tests', 'promise', 'lodash', 'prettier'],
     extends: [
+        'eslint:recommended',
+        'plugin:eslint-comments/recommended',
         'plugin:jsonc/recommended-with-jsonc',
         'plugin:yml/standard',
         'plugin:markdown/recommended',
-        'plugin:prettier/recommended',
+        'plugin:import/recommended',
+        'plugin:import/typescript',
+        'prettier',
     ],
     ignorePatterns: [
+        '.next',
         '*.min.*',
+        '*.d.ts',
+        'CHANGELOG.md',
         'dist',
         'LICENSE*',
+        'output',
+        'out',
         'coverage',
+        'public',
         'temp',
         'package-lock.json',
         'pnpm-lock.yaml',
         'yarn.lock',
+        '__snapshots__',
     ],
+    parserOptions: {
+        project: true,
+    },
+    parser: '@typescript-eslint/parser',
+    settings: {
+        'import/resolver': {
+            typescript: true,
+            node: true,
+        },
+        'import/parsers': {
+            '@typescript-eslint/parser': ['.ts', '.tsx'],
+        },
+    },
     overrides: [
+        {
+            excludedFiles: ['**/*.md/*.*'],
+            files: ['*.ts', '*.tsx', '*.mts', '*.cts'],
+            parserOptions: {
+                project: true,
+            },
+            parser: '@typescript-eslint/parser',
+            rules: {
+                // As we're using @typescript-eslint it's recommended to turn off
+                // the standard eslint rule for unused variables and use the @typescript-eslint rule instead.
+                // See here: https://typescript-eslint.io/rules/no-unused-vars/
+                'no-unused-vars': 'off',
+                '@typescript-eslint/no-unused-vars': 'error',
+
+                // Allow overload of functions: https://typescript-eslint.io/rules/no-dupe-class-members/
+                'no-dupe-class-members': 'off',
+                '@typescript-eslint/no-dupe-class-members': 'error',
+
+                '@typescript-eslint/no-explicit-any': 'warn',
+                'no-throw-literal': 'off',
+                '@typescript-eslint/no-throw-literal': 'error',
+                'no-implied-eval': 'off',
+                '@typescript-eslint/no-implied-eval': 'error',
+                'dot-notation': 'off',
+                '@typescript-eslint/dot-notation': ['error', { allowKeywords: true }],
+                '@typescript-eslint/await-thenable': 'error',
+                '@typescript-eslint/no-for-in-array': 'error',
+                '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+                '@typescript-eslint/no-unsafe-argument': 'error',
+                '@typescript-eslint/no-unsafe-call': 'error',
+                '@typescript-eslint/no-unsafe-return': 'error',
+                'require-await': 'off',
+                '@typescript-eslint/require-await': 'error',
+                '@typescript-eslint/restrict-plus-operands': 'error',
+                '@typescript-eslint/restrict-template-expressions': 'error',
+                '@typescript-eslint/unbound-method': 'off',
+                '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+                '@typescript-eslint/consistent-type-imports': [
+                    'warn',
+                    { prefer: 'type-imports', fixStyle: 'separate-type-imports' },
+                ],
+                '@typescript-eslint/no-misused-promises': [2, { checksVoidReturn: { attributes: false } }],
+            },
+        },
         {
             files: ['*.json', '*.json5'],
             parser: 'jsonc-eslint-parser',
@@ -100,9 +169,6 @@ module.exports = {
                             'pnpm',
                             'overrides',
                             'resolutions',
-                            'husky',
-                            'simple-git-hooks',
-                            'lint-staged',
                             'eslintConfig',
                         ],
                     },
@@ -118,9 +184,10 @@ module.exports = {
             },
         },
         {
-            files: ['*.js'],
+            files: ['*.js', '*.cjs', '*.jsx'],
             rules: {
                 '@typescript-eslint/no-var-requires': 'off',
+                '@typescript-eslint/no-require-imports': 'off',
             },
         },
         {
@@ -130,20 +197,56 @@ module.exports = {
             },
         },
         {
-            files: ['scripts/**/*.*'],
+            files: ['scripts/**/*.*', 'cli/**/*.*'],
             rules: {
                 'no-console': 'off',
             },
         },
         {
-            files: ['*.test.ts', '*.test.tsx', '*.test.js', '*.spec.ts', '*.spec.tsx', '*.spec.js'],
+            files: [
+                '*.test.ts',
+                '*.test.tsx',
+                '*.test.js',
+                '*.test.jsx',
+                '*.spec.ts',
+                '*.spec.tsx',
+                '*.spec.js',
+                '*.spec.jsx',
+            ],
             rules: {
                 'no-unused-expressions': 'off',
                 'no-only-tests/no-only-tests': 'error',
+                '@typescript-eslint/unbound-method': 'off', // Allows to use `vi.fn()` or spy/mock in tests
+            },
+        },
+        {
+            // Code blocks in markdown file
+            files: ['**/*.md/*.*'],
+            rules: {
+                '@typescript-eslint/no-redeclare': 'off',
+                '@typescript-eslint/no-unused-vars': 'off',
+                '@typescript-eslint/no-use-before-define': 'off',
+                '@typescript-eslint/no-var-requires': 'off',
+                '@typescript-eslint/comma-dangle': 'off',
+                '@typescript-eslint/consistent-type-imports': 'off',
+                'import/no-unresolved': 'off',
+                'unused-imports/no-unused-imports': 'off',
+                'unused-imports/no-unused-vars': 'off',
+                'no-alert': 'off',
+                'no-console': 'off',
+                'no-restricted-imports': 'off',
+                'no-unused-expressions': 'off',
+                'no-unused-vars': 'off',
             },
         },
     ],
     rules: {
+        // Eslint prettier
+        'prettier/prettier': 'error',
+        'arrow-body-style': 'off', // Problematic with Prettier
+        'prefer-arrow-callback': 'off', // Problematic with Prettier
+
+        // Eslint (base)
         'linebreak-style': ['error', 'unix'],
         'prefer-template': 'error',
         'template-curly-spacing': 'error',
@@ -160,6 +263,7 @@ module.exports = {
         'vars-on-top': 'error',
         'block-scoped-var': 'error',
         'array-callback-return': 'error',
+        'no-use-before-define': 'off',
         'object-shorthand': [
             'error',
             'always',
@@ -168,48 +272,144 @@ module.exports = {
                 avoidQuotes: true,
             },
         ],
+        'no-case-declarations': 'error',
+        'no-multi-spaces': 'error',
+        'no-multi-str': 'error',
+        'no-with': 'error',
+        'no-void': 'error',
+        'no-useless-escape': 'off',
+        'no-invalid-this': 'error',
+        'require-await': 'off',
+        'no-return-assign': 'off',
+        'max-statements-per-line': ['error', { max: 1 }],
+        'prefer-exponentiation-operator': 'error',
+        'prefer-rest-params': 'error',
+        'prefer-spread': 'error',
+        'generator-star-spacing': 'off',
+        'no-debugger': 'error',
+        'no-constant-condition': 'warn',
+        'object-curly-spacing': ['error', 'always'],
+        'prefer-const': [
+            'error',
+            {
+                destructuring: 'all',
+                ignoreReadBeforeAssign: true,
+            },
+        ],
+        'prefer-arrow-callback': [
+            'error',
+            {
+                allowNamedFunctions: false,
+                allowUnboundThis: true,
+            },
+        ],
+        'no-unreachable': 'error',
+        'no-unused-labels': 'error',
+        'no-useless-computed-key': 'error',
+        'no-useless-concat': 'error',
+        'no-useless-escape': 'error',
+        'no-useless-rename': [
+            'error',
+            {
+                ignoreDestructuring: false,
+                ignoreImport: false,
+                ignoreExport: false,
+            },
+        ],
+        'no-with': 'error',
+        'no-whitespace-before-property': 'error',
+        'no-undef': 'off', // Doesn't works well with TypeScript
+
+        // Eslint Comments
+        'spaced-comment': [
+            'error',
+            'always',
+            {
+                line: {
+                    markers: ['/'],
+                    exceptions: ['/', '#'],
+                },
+                block: {
+                    markers: ['!'],
+                    exceptions: ['*'],
+                    balanced: true,
+                },
+            },
+        ],
+
+        // Eslint Import
+        'import/no-unresolved': 'off',
+        'import/no-internal-modules': 'off',
+        'import/no-relative-parent-imports': 'off',
+        'import/no-named-as-default': 'off',
+        'import/exports-last': 'off',
+        'import/no-namespace': 'off',
+        'import/extensions': 'off',
+        'import/order': [
+            'error',
+            {
+                groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
+                'newlines-between': 'always',
+            },
+        ],
+        'import/prefer-default-export': 'off',
+        'import/max-dependencies': 'off',
+        'import/no-unassigned-import': 'off',
+        'import/no-default-export': 'off',
+        'import/no-named-export': 'off',
+        'import/group-exports': 'off',
+        'import/no-duplicates': ['error', { 'prefer-inline': true }],
+        'import/consistent-type-specifier-style': ['error', 'prefer-inline'],
 
+        // Unicorn
+        // Pass error message when throwing errors
         'unicorn/error-message': 'error',
+        // Uppercase regex escapes
         'unicorn/escape-case': 'error',
-        'unicorn/no-array-instanceof': 'error',
+        // Array.isArray instead of instanceof
+        'unicorn/no-instanceof-array': 'error',
+        // Prevent deprecated `new Buffer()`
         'unicorn/no-new-buffer': 'error',
-        'unicorn/no-unsafe-regex': 'off',
+        // Keep regex literals safe!
+        'unicorn/no-unsafe-regex': 'error',
+        // Lowercase number formatting for octal, hex, binary (0x1'error' instead of 0X1'error')
         'unicorn/number-literal-case': 'error',
-        'unicorn/prefer-exponentiation-operator': 'error',
+        // use find when possible
+        'unicorn/prefer-array-find': 'error',
+        // use default param instead of foo = foo || 'bar';
+        'unicorn/prefer-default-parameters': 'error',
+        // includes over indexOf when checking for existence
         'unicorn/prefer-includes': 'error',
-        'unicorn/prefer-starts-ends-with': 'error',
+        // String methods startsWith/endsWith instead of more complicated stuff
+        'unicorn/prefer-string-starts-ends-with': 'error',
+        // Use replaceAll instead of replace with regex
+        'unicorn/prefer-string-replace-all': 'error',
+        // textContent instead of innerText
         'unicorn/prefer-text-content': 'error',
+        // Enforce throwing type error when throwing error while checking typeof
         'unicorn/prefer-type-error': 'error',
+        // Use new when throwing error
         'unicorn/throw-new-error': 'error',
-        'unicorn/prefer-string-replace-all': 'error',
-        'unicorn/prefer-default-parameters': 'error',
-        'unicorn/prefer-array-find': 'error',
+        // Prefer using the `node:` protocol
+        'unicorn/prefer-node-protocol': 'error',
         'unicorn/no-array-for-each': 'error',
         'unicorn/custom-error-definition': 'error',
         'unicorn/better-regex': 'error',
         'unicorn/explicit-length-check': 'error',
         'unicorn/no-await-expression-member': 'error',
-        'unicorn/no-nested-ternary': 'error',
+        'unicorn/no-nested-ternary': 'off', // Conflict with prettier
         'unicorn/no-new-array': 'error',
         'unicorn/no-this-assignment': 'error',
-        'unicorn/no-unsafe-regex': 'error',
         'unicorn/no-useless-length-check': 'error',
         'unicorn/catch-error-name': 'error',
 
-        'promise/prefer-await-to-then': 'error',
+        // Eslint Promise
         'promise/param-names': 'error',
 
-        'sort-imports': [
-            'error',
-            {
-                ignoreCase: false,
-                ignoreDeclarationSort: true,
-                ignoreMemberSort: false,
-                memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
-                allowSeparatedGroups: false,
-            },
-        ],
+        // Eslint Jsonc
+        'jsonc/no-dupe-keys': 'error',
 
+        // Eslint Lodash
         'lodash/import-scope': [2, 'method'],
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontify/eslint-config-basic",
-  "version": "0.18.1",
+  "version": "0.19.0-next.1",
   "author": "Frontify Developers <developers@frontify.com>",
   "license": "MIT",
   "repository": {
@@ -20,21 +20,24 @@
     "prettier": ">=3.0.0"
   },
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-html": "^7.1.0",
-    "eslint-plugin-jsonc": "^2.9.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jsonc": "^2.10.0",
     "eslint-plugin-lodash": "^7.4.0",
     "eslint-plugin-markdown": "^3.0.1",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-unicorn": "^48.0.1",
-    "eslint-plugin-yml": "^1.8.0",
+    "eslint-plugin-unicorn": "^49.0.0",
+    "eslint-plugin-yml": "^1.10.0",
     "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
-    "eslint": "^8.48.0",
+    "eslint": "^8.53.0",
     "prettier": "^3.0.3"
   },
   "scripts": {