@jakubmazanec/eslint-config 2.0.0-next.8fca4dc → 2.0.0

package/{LICENSE → LICENSE.md}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Jakub Mazanec
+Copyright (c) 2023 Jakub Mazanec
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 associated documentation files (the "Software"), to deal in the Software without restriction,

package/README.md

@@ -0,0 +1,34 @@
+<div align="center">
+
+# @jakubmazanec/eslint-config
+
+ESLint config for TypeScript projects.
+
+</div>
+
+## Installation
+
+```sh
+npm install @jakubmazanec/eslint-config
+```
+
+#### Prerequisites
+
+- Node.js 16 or later
+- TypeScript 5 or later
+
+## Usage
+
+🚧 This section is under development. Please check back later for updates.
+
+## Documentation
+
+See [API reference](./docs) for auto-generated documentation.
+
+## Contributing
+
+If you want to contribute, see [CONTRIBUTING](./CONTRIBUTING.md) for details.
+
+## License
+
+This package is licensed under the MIT license. See [LICENSE](./LICENSE.md) for details.

package/dist/constants.js

@@ -16,19 +16,19 @@ _export(exports, {
     GRAPHQL_EXTENSIONS_REGEXP: ()=>GRAPHQL_EXTENSIONS_REGEXP
 });
 const JS_AND_TS_EXTENSIONS = [
-    ".ts",
-    ".tsx",
-    ".cts",
-    ".mts",
-    ".js",
-    ".jsx",
-    ".cjs",
-    ".mjs",
-    ".json"
+    '.ts',
+    '.tsx',
+    '.cts',
+    '.mts',
+    '.js',
+    '.jsx',
+    '.cjs',
+    '.mjs',
+    '.json'
 ];
-const JS_EXTENSIONS_GLOB_PART = "{js,jsx,cjs,mjs}";
-const TS_EXTENSIONS_GLOB_PART = "{ts,tsx,cts,mts}";
-const JS_AND_TS_EXTENSIONS_GLOB_PART = "{js,jsx,cjs,mjs,ts,tsx,cts,mts}";
+const JS_EXTENSIONS_GLOB_PART = '{js,jsx,cjs,mjs}';
+const TS_EXTENSIONS_GLOB_PART = '{ts,tsx,cts,mts}';
+const JS_AND_TS_EXTENSIONS_GLOB_PART = '{js,jsx,cjs,mjs,ts,tsx,cts,mts}';
 const JS_AND_TS_EXTENSIONS_REGEXP = /\.(js|jsx|cjs|mjs|ts|tsx|cts|mts)$/;
 const ASSET_EXTENSIONS_REGEXP = /\.(ttf|eot|otf|svg|woff|woff2|mp3|png|jpg|jpeg|gif|ico)$/;
 const CSS_EXTENSIONS_REGEXP = /\.(css|scss)$/;

package/dist/main.js

@@ -1,7 +1,7 @@
 "use strict";
 let config = {
     extends: [
-        require.resolve("./presets/base.js")
+        require.resolve('./presets/base.js')
     ],
     reportUnusedDisableDirectives: true,
     // We can't define rules here otherwise they override the ones in the extending configs above. This is bad for actual `overrides`!

package/dist/presets/base.js

@@ -14,20 +14,20 @@ const _typescript = require("../rules/typescript");
 const _unicorn = require("../rules/unicorn");
 const config = {
     parserOptions: {
-        ecmaVersion: "latest",
-        sourceType: "module",
+        ecmaVersion: 'latest',
+        sourceType: 'module',
         ecmaFeatures: {
             jsx: true
         }
     },
     plugins: [
-        "import",
-        "react",
-        "react-hooks",
-        "jsx-a11y",
-        "eslint-comments",
-        "promise",
-        "unicorn"
+        'import',
+        'react',
+        'react-hooks',
+        'jsx-a11y',
+        'eslint-comments',
+        'promise',
+        'unicorn'
     ],
     env: {
         browser: true,
@@ -36,41 +36,41 @@ const config = {
         serviceworker: true
     },
     globals: {
-        __DEV__: "readonly",
+        __DEV__: 'readonly',
         // metrics and analytics providers
-        ga: "readonly",
-        newrelic: "readonly",
+        ga: 'readonly',
+        newrelic: 'readonly',
         // mostly for easier compatibility between browsers, workers, etc
-        global: "readonly",
+        global: 'readonly',
         // mostly references to `process.env.NODE_ENV`
-        process: "readonly",
+        process: 'readonly',
         // references for globalThis
-        globalThis: "readonly",
+        globalThis: 'readonly',
         // Webpack variables
-        __webpack_public_path__: "writeable",
-        __webpack_require__: "readonly",
-        __webpack_chunk_load__: "readonly",
-        __webpack_modules__: "readonly",
-        __webpack_hash__: "readonly",
-        __non_webpack_require__: "readonly",
-        __webpack_exports_info__: "readonly",
-        DEBUG: "readonly"
+        __webpack_public_path__: 'writeable',
+        __webpack_require__: 'readonly',
+        __webpack_chunk_load__: 'readonly',
+        __webpack_modules__: 'readonly',
+        __webpack_hash__: 'readonly',
+        __non_webpack_require__: 'readonly',
+        __webpack_exports_info__: 'readonly',
+        DEBUG: 'readonly'
     },
     settings: {
-        "import/ignore": [
-            "node_modules",
-            "\\.json$",
+        'import/ignore': [
+            'node_modules',
+            '\\.json$',
             _constants.ASSET_EXTENSIONS_REGEXP.source,
             _constants.CSS_EXTENSIONS_REGEXP.source,
             _constants.GRAPHQL_EXTENSIONS_REGEXP.source
         ],
         react: {
-            version: "detect"
+            version: 'detect'
         },
         propWrapperFunctions: [
-            "forbidExtraProps",
-            "exact",
-            "Object.freeze"
+            'forbidExtraProps',
+            'exact',
+            'Object.freeze'
         ]
     },
     rules: {
@@ -89,17 +89,17 @@ const config = {
                 `*.test.${_constants.JS_AND_TS_EXTENSIONS_GLOB_PART}`
             ],
             plugins: [
-                "jest",
-                "jest-formatting",
-                "testing-library"
+                'jest',
+                'jest-formatting',
+                'testing-library'
             ],
             settings: {
-                "testing-library/custom-queries": "off",
-                "testing-library/custom-renders": "off",
-                "testing-library/utils-module": "off"
+                'testing-library/custom-queries': 'off',
+                'testing-library/custom-renders': 'off',
+                'testing-library/utils-module': 'off'
             },
             globals: {
-                jsdom: "readonly"
+                jsdom: 'readonly'
             },
             env: {
                 jest: true,
@@ -110,9 +110,9 @@ const config = {
                 ..._jestFormatting.default,
                 ..._testingLibrary.default,
                 // override ESLint rules
-                "max-classes-per-file": "off",
+                'max-classes-per-file': 'off',
                 // override eslint-plugin-node rules
-                "node/no-sync": "off"
+                'node/no-sync': 'off'
             }
         },
         {
@@ -120,11 +120,11 @@ const config = {
                 `*.${_constants.TS_EXTENSIONS_GLOB_PART}`
             ],
             plugins: [
-                "@typescript-eslint"
+                '@typescript-eslint'
             ],
-            parser: "@typescript-eslint/parser",
+            parser: '@typescript-eslint/parser',
             parserOptions: {
-                project: "tsconfig.typecheck.json",
+                project: 'tsconfig.typecheck.json',
                 // Fixed issue with webstorm
                 tsconfigRootDir: process.cwd()
             },
@@ -132,23 +132,23 @@ const config = {
                 node: {
                     tryExtensions: _constants.JS_AND_TS_EXTENSIONS
                 },
-                "import/resolver": {
+                'import/resolver': {
                     typescript: {}
                 },
-                "import/parsers": {
-                    "@typescript-eslint/parser": [
-                        ".ts",
-                        ".tsx",
-                        ".mts",
-                        ".cts"
+                'import/parsers': {
+                    '@typescript-eslint/parser': [
+                        '.ts',
+                        '.tsx',
+                        '.mts',
+                        '.cts'
                     ]
                 }
             },
             rules: {
                 ..._typescript.default,
                 // override eslint-plugin-import rules
-                "import/no-extraneous-dependencies": [
-                    "error",
+                'import/no-extraneous-dependencies': [
+                    'error',
                     {
                         devDependencies: [
                             `**/*.test.${_constants.JS_AND_TS_EXTENSIONS_GLOB_PART}`,
@@ -167,8 +167,8 @@ const config = {
             ],
             rules: {
                 // override @typescript-eslint/eslint-plugin rules
-                "@typescript-eslint/ban-ts-comment": "off",
-                "@typescript-eslint/no-floating-promises": "off"
+                '@typescript-eslint/ban-ts-comment': 'off',
+                '@typescript-eslint/no-floating-promises': 'off'
             }
         }
     ]

package/dist/presets/nextjs.js

@@ -2,7 +2,7 @@
 const _nextjs = require("../rules/nextjs");
 const config = {
     plugins: [
-        "@next/next"
+        '@next/next'
     ],
     rules: {
         ..._nextjs.default

package/dist/presets/nodejs.js

@@ -2,7 +2,7 @@
 const _node = require("../rules/node");
 const config = {
     plugins: [
-        "node"
+        'node'
     ],
     env: {
         browser: false,
@@ -10,54 +10,54 @@ const config = {
     },
     globals: {
         // ECMAScript
-        ArrayBuffer: "readonly",
-        Atomics: "readonly",
-        BigInt: "readonly",
-        BigInt64Array: "readonly",
-        BigUint64Array: "readonly",
-        DataView: "readonly",
-        Float32Array: "readonly",
-        Float64Array: "readonly",
-        Int16Array: "readonly",
-        Int32Array: "readonly",
-        Int8Array: "readonly",
-        Map: "readonly",
-        Promise: "readonly",
-        Proxy: "readonly",
-        Reflect: "readonly",
-        Set: "readonly",
-        SharedArrayBuffer: "readonly",
-        Symbol: "readonly",
-        Uint16Array: "readonly",
-        Uint32Array: "readonly",
-        Uint8Array: "readonly",
-        Uint8ClampedArray: "readonly",
-        WeakMap: "readonly",
-        WeakSet: "readonly",
+        ArrayBuffer: 'readonly',
+        Atomics: 'readonly',
+        BigInt: 'readonly',
+        BigInt64Array: 'readonly',
+        BigUint64Array: 'readonly',
+        DataView: 'readonly',
+        Float32Array: 'readonly',
+        Float64Array: 'readonly',
+        Int16Array: 'readonly',
+        Int32Array: 'readonly',
+        Int8Array: 'readonly',
+        Map: 'readonly',
+        Promise: 'readonly',
+        Proxy: 'readonly',
+        Reflect: 'readonly',
+        Set: 'readonly',
+        SharedArrayBuffer: 'readonly',
+        Symbol: 'readonly',
+        Uint16Array: 'readonly',
+        Uint32Array: 'readonly',
+        Uint8Array: 'readonly',
+        Uint8ClampedArray: 'readonly',
+        WeakMap: 'readonly',
+        WeakSet: 'readonly',
         // ECMAScript (experimental)
-        globalThis: "readonly",
+        globalThis: 'readonly',
         // ECMA-402
-        Intl: "readonly",
+        Intl: 'readonly',
         // Web Standard
-        TextDecoder: "readonly",
-        TextEncoder: "readonly",
-        URL: "readonly",
-        URLSearchParams: "readonly",
-        WebAssembly: "readonly",
-        clearInterval: "readonly",
-        clearTimeout: "readonly",
-        console: "readonly",
-        queueMicrotask: "readonly",
-        setInterval: "readonly",
-        setTimeout: "readonly",
+        TextDecoder: 'readonly',
+        TextEncoder: 'readonly',
+        URL: 'readonly',
+        URLSearchParams: 'readonly',
+        WebAssembly: 'readonly',
+        clearInterval: 'readonly',
+        clearTimeout: 'readonly',
+        console: 'readonly',
+        queueMicrotask: 'readonly',
+        setInterval: 'readonly',
+        setTimeout: 'readonly',
         // Node.js
-        Buffer: "readonly",
-        GLOBAL: "readonly",
-        clearImmediate: "readonly",
-        global: "readonly",
-        process: "readonly",
-        root: "readonly",
-        setImmediate: "readonly",
+        Buffer: 'readonly',
+        GLOBAL: 'readonly',
+        clearImmediate: 'readonly',
+        global: 'readonly',
+        process: 'readonly',
+        root: 'readonly',
+        setImmediate: 'readonly',
         // Other
         __dirname: false,
         __filename: false,
@@ -68,29 +68,29 @@ const config = {
     settings: {
         node: {
             tryExtensions: [
-                ".js",
-                ".jsx",
-                ".json",
-                ".mjs",
-                ".cjs"
+                '.js',
+                '.jsx',
+                '.json',
+                '.mjs',
+                '.cjs'
             ]
         },
         convertPath: {
-            "src/**/*.ts": [
-                "^src/(.+?)\\.ts$",
-                "lib/$1.js"
+            'src/**/*.ts': [
+                '^src/(.+?)\\.ts$',
+                'lib/$1.js'
             ],
-            "src/**/*.tsx": [
-                "^src/(.+?)\\.tsx$",
-                "lib/$1.js"
+            'src/**/*.tsx': [
+                '^src/(.+?)\\.tsx$',
+                'lib/$1.js'
             ],
-            "src/**/*.mts": [
-                "^src/(.+?)\\.ts$",
-                "esm/$1.js"
+            'src/**/*.mts': [
+                '^src/(.+?)\\.ts$',
+                'esm/$1.js'
             ],
-            "src/**/*.cts": [
-                "^src/(.+?)\\.tsx$",
-                "lib/$1.js"
+            'src/**/*.cts': [
+                '^src/(.+?)\\.tsx$',
+                'lib/$1.js'
             ]
         }
     },

package/dist/presets/prettier.js

@@ -2,10 +2,10 @@
 const _prettier = require("../rules/prettier");
 const config = {
     extends: [
-        "eslint-config-prettier"
+        'eslint-config-prettier'
     ],
     plugins: [
-        "eslint-plugin-prettier"
+        'eslint-plugin-prettier'
     ],
     rules: {
         ..._prettier.default

package/dist/rules/a11y.js

@@ -5,70 +5,70 @@ Object.defineProperty(exports, "default", {
 });
 const config = {
     // eslint-plugin-jsx-a11y rules
-    "jsx-a11y/alt-text": "warn",
-    "jsx-a11y/anchor-has-content": [
-        "warn",
+    'jsx-a11y/alt-text': 'warn',
+    'jsx-a11y/anchor-has-content': [
+        'warn',
         {
             components: [
-                "Link"
+                'Link'
             ]
         }
     ],
-    "jsx-a11y/anchor-is-valid": [
-        "error",
+    'jsx-a11y/anchor-is-valid': [
+        'error',
         {
             components: [
-                "Link"
+                'Link'
             ],
             specialLink: [
-                "hrefLeft",
-                "hrefRight",
-                "to"
+                'hrefLeft',
+                'hrefRight',
+                'to'
             ]
         }
     ],
-    "jsx-a11y/aria-activedescendant-has-tabindex": "warn",
-    "jsx-a11y/aria-props": "error",
-    "jsx-a11y/aria-proptypes": "error",
-    "jsx-a11y/aria-role": [
-        "error",
+    'jsx-a11y/aria-activedescendant-has-tabindex': 'warn',
+    'jsx-a11y/aria-props': 'error',
+    'jsx-a11y/aria-proptypes': 'error',
+    'jsx-a11y/aria-role': [
+        'error',
         {
             ignoreNonDOM: false
         }
     ],
-    "jsx-a11y/aria-unsupported-elements": "error",
-    "jsx-a11y/autocomplete-valid": "warn",
-    "jsx-a11y/click-events-have-key-events": "warn",
-    "jsx-a11y/control-has-associated-label": "warn",
-    "jsx-a11y/heading-has-content": [
-        "warn",
+    'jsx-a11y/aria-unsupported-elements': 'error',
+    'jsx-a11y/autocomplete-valid': 'warn',
+    'jsx-a11y/click-events-have-key-events': 'warn',
+    'jsx-a11y/control-has-associated-label': 'warn',
+    'jsx-a11y/heading-has-content': [
+        'warn',
         {
             components: [
-                "Typography"
+                'Typography'
             ]
         }
     ],
-    "jsx-a11y/html-has-lang": "warn",
-    "jsx-a11y/iframe-has-title": "warn",
-    "jsx-a11y/img-redundant-alt": "warn",
-    "jsx-a11y/interactive-supports-focus": "warn",
-    "jsx-a11y/label-has-associated-control": "warn",
-    "jsx-a11y/lang": "error",
-    "jsx-a11y/media-has-caption": "warn",
-    "jsx-a11y/mouse-events-have-key-events": "warn",
-    "jsx-a11y/no-access-key": "warn",
-    "jsx-a11y/no-autofocus": "off",
-    "jsx-a11y/no-distracting-elements": "error",
-    "jsx-a11y/no-interactive-element-to-noninteractive-role": "warn",
-    "jsx-a11y/no-noninteractive-element-interactions": "warn",
-    "jsx-a11y/no-noninteractive-element-to-interactive-role": "warn",
-    "jsx-a11y/no-noninteractive-tabindex": "error",
-    "jsx-a11y/no-redundant-roles": "error",
-    "jsx-a11y/no-static-element-interactions": "warn",
-    "jsx-a11y/role-has-required-aria-props": "error",
-    "jsx-a11y/role-supports-aria-props": "error",
-    "jsx-a11y/scope": "error",
-    "jsx-a11y/tabindex-no-positive": "error"
+    'jsx-a11y/html-has-lang': 'warn',
+    'jsx-a11y/iframe-has-title': 'warn',
+    'jsx-a11y/img-redundant-alt': 'warn',
+    'jsx-a11y/interactive-supports-focus': 'warn',
+    'jsx-a11y/label-has-associated-control': 'warn',
+    'jsx-a11y/lang': 'error',
+    'jsx-a11y/media-has-caption': 'warn',
+    'jsx-a11y/mouse-events-have-key-events': 'warn',
+    'jsx-a11y/no-access-key': 'warn',
+    'jsx-a11y/no-autofocus': 'off',
+    'jsx-a11y/no-distracting-elements': 'error',
+    'jsx-a11y/no-interactive-element-to-noninteractive-role': 'warn',
+    'jsx-a11y/no-noninteractive-element-interactions': 'warn',
+    'jsx-a11y/no-noninteractive-element-to-interactive-role': 'warn',
+    'jsx-a11y/no-noninteractive-tabindex': 'error',
+    'jsx-a11y/no-redundant-roles': 'error',
+    'jsx-a11y/no-static-element-interactions': 'warn',
+    'jsx-a11y/role-has-required-aria-props': 'error',
+    'jsx-a11y/role-supports-aria-props': 'error',
+    'jsx-a11y/scope': 'error',
+    'jsx-a11y/tabindex-no-positive': 'error'
 };
 const _default = config;
 

package/dist/rules/eslint-comments.js

@@ -5,24 +5,24 @@ Object.defineProperty(exports, "default", {
 });
 const config = {
     // eslint-plugin-eslint-comments rules
-    "eslint-comments/disable-enable-pair": [
-        "error",
+    'eslint-comments/disable-enable-pair': [
+        'error',
         {
             allowWholeFile: true
         }
     ],
-    "eslint-comments/no-aggregating-enable": "error",
-    "eslint-comments/no-duplicate-disable": "error",
-    "eslint-comments/no-restricted-disable": "off",
-    "eslint-comments/no-unlimited-disable": "error",
-    "eslint-comments/no-unused-disable": "off",
-    "eslint-comments/no-unused-enable": "error",
-    "eslint-comments/no-use": "off",
-    "eslint-comments/require-description": [
-        "error",
+    'eslint-comments/no-aggregating-enable': 'error',
+    'eslint-comments/no-duplicate-disable': 'error',
+    'eslint-comments/no-restricted-disable': 'off',
+    'eslint-comments/no-unlimited-disable': 'error',
+    'eslint-comments/no-unused-disable': 'off',
+    'eslint-comments/no-unused-enable': 'error',
+    'eslint-comments/no-use': 'off',
+    'eslint-comments/require-description': [
+        'error',
         {
             ignore: [
-                "eslint-enable"
+                'eslint-enable'
             ]
         }
     ]