@enormora/eslint-config-base-with-prettier 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023]
+
+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, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/constants.js

@@ -0,0 +1,3 @@
+export const ecmaVersion = 2025;
+export const indentSize = 4;
+export const javascriptExtensions = [ '.js', '.cjs', '.mjs' ];

package/package.json

@@ -0,0 +1,43 @@
+{
+    "author": "Mathias Schreck <schreck.mathias@gmail.com>",
+    "contributors": [
+        "Christian Rackerseder <github@echooff.de>"
+    ],
+    "dependencies": {
+        "@cspell/eslint-plugin": "10.0.0",
+        "@eslint-community/eslint-plugin-eslint-comments": "4.7.1",
+        "@stylistic/eslint-plugin": "5.10.0",
+        "eslint-plugin-array-func": "5.1.1",
+        "eslint-plugin-destructuring": "2.2.1",
+        "eslint-plugin-import-x": "4.16.2",
+        "eslint-plugin-no-barrel-files": "1.3.1",
+        "eslint-plugin-no-secrets": "2.3.3",
+        "eslint-plugin-prettier": "5.5.5",
+        "eslint-plugin-promise": "7.3.0",
+        "eslint-plugin-sonarjs": "4.0.3",
+        "eslint-plugin-unicorn": "64.0.0"
+    },
+    "description": "Enormora’s ESLint base configuration formatted with prettier",
+    "exports": {
+        ".": {
+            "import": "./presets/base-with-prettier/base-with-prettier.js"
+        }
+    },
+    "license": "MIT",
+    "name": "@enormora/eslint-config-base-with-prettier",
+    "peerDependencies": {
+        "eslint": "^10.0.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/enormora/eslint-config.git"
+    },
+    "sideEffects": [
+        "./presets/base-with-prettier/base-with-prettier.js",
+        "./presets/base/base-shared.js",
+        "./rule-sets/best-practices.js",
+        "./rule-sets/restricted-syntax.js"
+    ],
+    "type": "module",
+    "version": "0.0.1"
+}

package/presets/base/base-shared.js

@@ -0,0 +1,453 @@
+import codeSpellChecker from '@cspell/eslint-plugin';
+import eslintCommentsPlugin from '@eslint-community/eslint-plugin-eslint-comments';
+import importPlugin, { createNodeResolver } from 'eslint-plugin-import-x';
+import noSecretsPlugin from 'eslint-plugin-no-secrets';
+import { ecmaVersion, javascriptExtensions } from '../../constants.js';
+import { bestPracticesRuleSet } from '../../rule-sets/best-practices.js';
+import {
+    createRestrictedSyntaxPlugin,
+    noClassDeclarationRestriction,
+    noEmptyFunctionBodyRestriction,
+    noSwitchStatementRestriction
+} from '../../rule-sets/restricted-syntax.js';
+import { stylisticRuleSet } from '../../rule-sets/stylistic.js';
+
+const restrictedSyntaxPlugin = createRestrictedSyntaxPlugin([
+    'no-class-declaration',
+    'no-switch-statement',
+    'no-empty-function-body'
+]);
+
+export const baseSharedConfig = {
+    languageOptions: {
+        ecmaVersion,
+        sourceType: 'module',
+        parserOptions: {
+            ecmaVersion,
+            ecmaFeatures: {
+                jsx: false,
+                globalReturn: false,
+                impliedStrict: false
+            }
+        }
+    },
+    linterOptions: {
+        noInlineConfig: false,
+        reportUnusedDisableDirectives: true
+    },
+    plugins: {
+        ...stylisticRuleSet.plugins,
+        ...bestPracticesRuleSet.plugins,
+        import: importPlugin,
+        'eslint-comments': eslintCommentsPlugin,
+        'no-secrets': noSecretsPlugin,
+        '@cspell': codeSpellChecker,
+        'restricted-syntax': restrictedSyntaxPlugin
+    },
+    settings: {
+        ...stylisticRuleSet.settings,
+        ...bestPracticesRuleSet.settings,
+        'import/parsers': {
+            espree: javascriptExtensions
+        },
+        'import-x/resolver-next': [ createNodeResolver() ]
+    },
+    rules: {
+        ...stylisticRuleSet.rules,
+        ...bestPracticesRuleSet.rules,
+
+        'array-callback-return': 'error',
+        camelcase: 'off',
+        'no-array-constructor': 'error',
+        'no-bitwise': 'error',
+        'no-caller': 'error',
+        'no-case-declarations': 'error',
+        'no-class-assign': 'error',
+        'no-cond-assign': 'error',
+        'no-console': 'error',
+        'no-const-assign': 'error',
+        'no-constant-condition': 'error',
+        'no-continue': 'error',
+        'no-control-regex': 'error',
+        'no-debugger': 'error',
+        'no-delete-var': 'error',
+        'no-div-regex': 'error',
+        'no-dupe-class-members': 'error',
+        'no-dupe-keys': 'error',
+        'no-dupe-args': 'error',
+        'no-duplicate-case': 'error',
+        'no-duplicate-imports': 'error',
+        'no-else-return': [ 'error', { allowElseIf: false } ],
+        'no-empty': [ 'error', { allowEmptyCatch: true } ],
+        'no-empty-character-class': 'error',
+        'no-empty-function': 'off',
+        'no-empty-pattern': 'error',
+        'no-empty-static-block': 'error',
+        'no-eq-null': 'error',
+        'no-eval': 'error',
+        'no-ex-assign': 'error',
+        'no-extend-native': 'error',
+        'no-extra-bind': 'error',
+        'no-extra-boolean-cast': 'error',
+        'no-extra-label': 'error',
+        'no-fallthrough': 'error',
+        'no-func-assign': 'error',
+        'no-implicit-coercion': 'error',
+        'no-implicit-globals': 'error',
+        'no-implied-eval': 'error',
+        'no-inline-comments': 'off',
+        'no-inner-declarations': [ 'error', 'functions' ],
+        'no-invalid-regexp': 'error',
+        'no-invalid-this': 'off',
+        'no-irregular-whitespace': 'error',
+        'no-iterator': 'error',
+        'no-label-var': 'error',
+        'no-labels': 'error',
+        'no-lone-blocks': 'error',
+        'no-lonely-if': 'error',
+        'no-loop-func': 'error',
+        'no-new-native-nonconstructor': 'error',
+        'no-multi-str': 'error',
+        'no-global-assign': 'error',
+        'no-negated-condition': 'off',
+        'no-nested-ternary': 'error',
+        'no-new': 'error',
+        'no-new-func': 'error',
+        'no-new-wrappers': 'error',
+        'no-obj-calls': 'error',
+        'no-object-constructor': 'error',
+        'no-octal': 'error',
+        'no-octal-escape': 'error',
+        'no-param-reassign': [ 'error', { props: true } ],
+        'no-plusplus': 'error',
+        'no-proto': 'error',
+        'no-prototype-builtins': 'error',
+        'no-redeclare': [ 'error', { builtinGlobals: true } ],
+        'no-regex-spaces': 'error',
+        'no-restricted-syntax': 'off',
+        'restricted-syntax/no-class-declaration': [ 'error', noClassDeclarationRestriction ],
+        'restricted-syntax/no-switch-statement': [ 'error', noSwitchStatementRestriction ],
+        'restricted-syntax/no-empty-function-body': [ 'error', noEmptyFunctionBodyRestriction ],
+        'no-return-assign': [ 'error', 'always' ],
+        'no-self-assign': [ 'error', { props: true } ],
+        'no-self-compare': 'error',
+        'no-sequences': 'error',
+        'no-shadow': [ 'error', { builtinGlobals: true } ],
+        'no-shadow-restricted-names': 'error',
+        'no-sparse-arrays': 'error',
+        'no-ternary': 'off',
+        'no-this-before-super': 'error',
+        'no-throw-literal': 'error',
+        'no-unassigned-vars': 'error',
+        'no-undef': [ 'error', { typeof: true } ],
+        'no-undef-init': 'error',
+        'no-undefined': 'off',
+        'no-unexpected-multiline': 'error',
+        'no-underscore-dangle': 'error',
+        'no-unmodified-loop-condition': 'error',
+        'no-unneeded-ternary': 'error',
+        'no-unreachable': 'error',
+        'no-unsafe-finally': 'error',
+        'no-unused-expressions': 'error',
+        'no-unused-labels': 'error',
+        'no-unused-vars': [
+            'error',
+            {
+                vars: 'all',
+                args: 'after-used',
+                ignoreRestSiblings: true,
+                argsIgnorePattern: '^_$',
+                caughtErrors: 'all',
+                caughtErrorsIgnorePattern: '^_$'
+            }
+        ],
+        'no-use-before-define': 'error',
+        'no-useless-call': 'error',
+        'no-useless-computed-key': 'error',
+        'no-useless-concat': 'error',
+        'no-useless-constructor': 'error',
+        'no-useless-escape': 'error',
+        'no-useless-rename': 'error',
+        'no-void': 'error',
+        'prefer-const': [
+            'error',
+            {
+                destructuring: 'all'
+            }
+        ],
+        'prefer-spread': 'error',
+        'prefer-template': 'error',
+        'preserve-caught-error': 'error',
+        'no-var': 'error',
+        'no-warning-comments': [
+            'error',
+            {
+                terms: [ 'todo', 'fixme', 'wtf', 'falls through', 'istanbul', 'c8' ],
+                location: 'anywhere'
+            }
+        ],
+        'no-with': 'error',
+        'no-magic-numbers': [
+            'error',
+            {
+                ignoreDefaultValues: true,
+                ignoreArrayIndexes: false,
+                detectObjects: false,
+                enforceConst: false,
+                ignoreClassFieldInitialValues: false,
+                ignore: [ -1, 0, 1 ]
+            }
+        ],
+        'arrow-body-style': [ 'error', 'always' ],
+        'accessor-pairs': [
+            'error',
+            {
+                enforceForClassMembers: true
+            }
+        ],
+        'block-scoped-var': 'off',
+        complexity: [ 'error', { max: 6 } ],
+        'consistent-return': 'error',
+        'consistent-this': [ 'error', 'self' ],
+        'constructor-super': 'error',
+        curly: [ 'error', 'all' ],
+        'default-case': 'error',
+        'dot-notation': 'error',
+        eqeqeq: 'error',
+        'func-names': 'off',
+        'func-style': 'off',
+        'guard-for-in': 'error',
+        'id-length': [ 'error', { min: 2, properties: 'never' } ],
+        'init-declarations': [ 'error', 'always' ],
+        'max-depth': [ 'error', { max: 5 } ],
+        'max-lines': [ 'error', { max: 500, skipBlankLines: true, skipComments: true } ],
+        'max-nested-callbacks': [ 'error', { max: 4 } ],
+        'max-params': [ 'error', { max: 4 } ],
+        'max-statements': [ 'error', { max: 10 } ],
+        'new-cap': [
+            'error',
+            {
+                newIsCap: true,
+                capIsNew: true
+            }
+        ],
+        'object-shorthand': [ 'error', 'always' ],
+        'one-var': [ 'error', 'never' ],
+        'operator-assignment': [ 'error', 'always' ],
+        'prefer-arrow-callback': [
+            'error',
+            {
+                allowNamedFunctions: true
+            }
+        ],
+        'prefer-rest-params': 'error',
+        radix: 'error',
+        'id-match': 'off',
+        'require-yield': 'error',
+        'sort-vars': 'off',
+        'sort-imports': 'off',
+        strict: [ 'error', 'safe' ],
+        'unicode-bom': [ 'error', 'never' ],
+        'use-isnan': 'error',
+        'valid-typeof': 'error',
+        'vars-on-top': 'error',
+        yoda: [ 'error', 'never' ],
+        'capitalized-comments': 'off',
+        'class-methods-use-this': 'error',
+        'func-name-matching': 'off',
+        'no-await-in-loop': 'off',
+        'no-compare-neg-zero': 'error',
+        'no-multi-assign': 'error',
+        'no-restricted-properties': 'off',
+        'no-template-curly-in-string': 'error',
+        'no-unsafe-negation': 'error',
+        'no-useless-return': 'error',
+        'prefer-destructuring': [
+            'error',
+            {
+                VariableDeclarator: {
+                    array: false,
+                    object: true
+                },
+                AssignmentExpression: {
+                    array: false,
+                    object: false
+                }
+            },
+            {
+                enforceForRenamedProperties: false
+            }
+        ],
+        'prefer-numeric-literals': 'error',
+        'prefer-promise-reject-errors': [
+            'error',
+            {
+                allowEmptyReject: false
+            }
+        ],
+        'require-await': 'off',
+        'sort-keys': 'off',
+        'symbol-description': 'error',
+        'for-direction': 'off',
+        'getter-return': [
+            'error',
+            {
+                allowImplicit: false
+            }
+        ],
+        'max-classes-per-file': 'off',
+        'max-lines-per-function': 'off',
+        'prefer-object-spread': 'error',
+        'no-async-promise-executor': 'error',
+        'no-misleading-character-class': 'error',
+        'default-param-last': 'error',
+        'prefer-regex-literals': 'error',
+        'require-unicode-regexp': 'off',
+        'no-useless-catch': 'error',
+        'prefer-named-capture-group': 'error',
+        'no-import-assign': 'error',
+        'require-atomic-updates': 'error',
+
+        'no-restricted-imports': 'off',
+
+        'no-alert': 'off',
+        'no-script-url': 'off',
+        'no-restricted-globals': 'off',
+
+        'grouped-accessor-pairs': 'off',
+        'no-constructor-return': 'error',
+        'no-dupe-else-if': 'error',
+        'no-setter-return': 'error',
+        'prefer-exponentiation-operator': 'error',
+
+        'default-case-last': 'error',
+        'no-restricted-exports': 'off',
+        'no-useless-backreference': 'error',
+        'id-denylist': 'off',
+        'no-loss-of-precision': 'off',
+        'no-promise-executor-return': 'error',
+        'no-unreachable-loop': 'error',
+        'no-nonoctal-decimal-escape': 'error',
+        'no-unsafe-optional-chaining': 'error',
+        'no-unused-private-class-members': 'error',
+        'no-constant-binary-expression': 'error',
+        'logical-assignment-operators': [ 'error', 'never' ],
+        'prefer-object-has-own': 'error',
+        'no-useless-assignment': 'error',
+
+        'no-secrets/no-secrets': [ 'error', { tolerance: 5 } ],
+        'no-secrets/no-pattern-match': 'off',
+
+        'eslint-comments/disable-enable-pair': [
+            'error',
+            {
+                allowWholeFile: true
+            }
+        ],
+        'eslint-comments/no-aggregating-enable': 'error',
+        'eslint-comments/no-duplicate-disable': 'error',
+        'eslint-comments/no-unused-enable': 'error',
+        'eslint-comments/no-restricted-disable': 'off',
+        'eslint-comments/no-unlimited-disable': 'error',
+        'eslint-comments/no-use': 'off',
+        'eslint-comments/require-description': 'error',
+
+        'import/no-deprecated': 'error',
+        'import/exports-last': 'off',
+        'import/dynamic-import-chunkname': 'off',
+        'import/unambiguous': 'off',
+        'import/no-dynamic-require': 'error',
+        'import/no-named-export': 'off',
+        'import/no-default-export': 'error',
+        'import/prefer-default-export': 'off',
+        'import/newline-after-import': 'error',
+        'import/no-nodejs-modules': 'off',
+        'import/max-dependencies': [ 'error', { max: 10 } ],
+        'import/first': 'error',
+        'import/no-unused-modules': [ 'error', { unusedExports: true, suppressMissingFileEnumeratorAPIWarning: true } ],
+        'import/no-anonymous-default-export': 'off',
+        'import/no-named-default': 'off',
+        'import/no-cycle': 'error',
+        'import/no-relative-parent-imports': 'off',
+        'import/group-exports': 'off',
+        'import/no-internal-modules': 'off',
+        'import/no-restricted-paths': 'off',
+        'import/named': 'off',
+        'import/no-namespace': 'off',
+        'import/default': 'error',
+        'import/export': 'error',
+        'import/extensions': [
+            'error',
+            {
+                js: 'ignorePackages',
+                jsx: 'ignorePackages',
+                json: 'ignorePackages'
+            }
+        ],
+        'import/namespace': [
+            'error',
+            {
+                allowComputed: true
+            }
+        ],
+        'import/no-absolute-path': 'error',
+        'import/no-webpack-loader-syntax': 'error',
+        'import/no-self-import': 'error',
+        'import/no-useless-path-segments': [
+            'error',
+            {
+                noUselessIndex: true
+            }
+        ],
+        'import/no-amd': 'error',
+        'import/no-commonjs': 'error',
+        'import/no-duplicates': 'error',
+        'import/no-extraneous-dependencies': 'error',
+        'import/no-mutable-exports': 'error',
+        'import/no-named-as-default-member': 'error',
+        'import/no-named-as-default': 'error',
+        'import/order': 'error',
+        'import/no-unassigned-import': [
+            'error',
+            {
+                allow: []
+            }
+        ],
+        // this rule doesn’t work correctly for ESM modules which use the exports field in package.json instead of main, see also https://github.com/import-js/eslint-plugin-import/issues/2703
+        'import/no-unresolved': 'off',
+        'import/no-relative-packages': 'off',
+        'import/no-import-module-exports': 'off',
+        'import/no-empty-named-blocks': 'error',
+        'import/consistent-type-specifier-style': 'off',
+        'import/no-rename-default': 'off',
+        'import/prefer-namespace-import': 'off',
+
+        '@cspell/spellchecker': [
+            'warn',
+            {
+                autoFix: false,
+                numSuggestions: 3,
+                generateSuggestions: true,
+                ignoreImports: true,
+                ignoreImportProperties: true,
+                checkIdentifiers: true,
+                checkStrings: true,
+                checkStringTemplates: true,
+                checkJSXText: true,
+                checkComments: true,
+                cspell: {
+                    words: [],
+                    ignoreWords: [],
+                    flagWords: [],
+                    ignoreRegExpList: [],
+                    includeRegExpList: [],
+                    allowCompoundWords: true,
+                    import: [],
+                    dictionaries: []
+                },
+                customWordListFile: undefined,
+                debugMode: false
+            }
+        ]
+    }
+};

package/presets/base-with-prettier/base-with-prettier.js

@@ -0,0 +1,15 @@
+import prettierPlugin from 'eslint-plugin-prettier';
+import { baseSharedConfig } from '../base/base-shared.js';
+
+export const baseWithPrettierConfig = {
+    ...baseSharedConfig,
+    plugins: {
+        ...baseSharedConfig.plugins,
+        prettier: prettierPlugin
+    },
+    rules: {
+        ...baseSharedConfig.rules,
+
+        'prettier/prettier': 'error'
+    }
+};

package/readme.md

@@ -0,0 +1,42 @@
+# `@enormora/eslint-config-base-with-prettier`
+
+Drop-in alternative to [`@enormora/eslint-config-base`](../base/base.md) that formats with
+[prettier](https://prettier.io/) instead of dprint.
+
+This preset is itself a base preset — pick this one **or** `@enormora/eslint-config-base`, never both. It contains the
+same set of lint rules as the regular base preset; the only difference is the formatter integration.
+
+## Install & Setup
+
+Install the `@enormora/eslint-config-base-with-prettier` package together with prettier itself via npm:
+
+```bash
+npm install --save-dev @enormora/eslint-config-base-with-prettier prettier
+```
+
+Provide a `prettier.config.js` at your project root with the formatting options you want (see the
+[prettier configuration reference](https://prettier.io/docs/en/options.html)):
+
+```javascript
+export default {
+  printWidth: 120,
+  tabWidth: 4,
+  singleQuote: true,
+  trailingComma: "none",
+  arrowParens: "always",
+};
+```
+
+Create an ESLint configuration file (e.g., `eslint.config.js`) in your project and add the preset to the configuration
+array:
+
+```javascript
+import { baseWithPrettierConfig } from "@enormora/eslint-config-base-with-prettier";
+
+export default [
+  {
+    ignores: ["dist/**/*"],
+  },
+  baseWithPrettierConfig,
+];
+```