@useinsider/eslint-config 1.2.0 → 1.3.0-alpha.6

package/src/rules/jsdoc.cjs

@@ -1,26 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    rules: {
-        'jsdoc/check-param-names': ['error'],
-        'jsdoc/check-tag-names': ['error'],
-        'jsdoc/no-undefined-types': 'off',
-        'jsdoc/require-param': ['error', {
-            enableRestElementFixer: false,
-            enableRootFixer: false,
-        }],
-        'jsdoc/require-jsdoc': ['off'],
-        'jsdoc/require-param-description': 'off',
-        'jsdoc/require-param-type': ['error'],
-        'jsdoc/require-property-description': 'off',
-        'jsdoc/require-returns': ['error', {
-            contexts: ['TSInterfaceDeclaration', 'TSMethodSignature'],
-            forceRequireReturn: true,
-            exemptedBy: ['inheritdoc', 'watch'],
-        }],
-        'jsdoc/require-returns-check': ['error'],
-        'jsdoc/require-returns-description': 'off',
-        'jsdoc/tag-lines': ['error'],
-        'jsdoc/valid-types': 'off',
-        'jsdoc/check-types': ['error'],
-    },
-};

package/src/rules/stylistic.cjs

@@ -1,118 +0,0 @@
-/** @type {import("eslint").Linter.RulesRecord} */
-module.exports = {
-    rules: {
-        '@stylistic/array-bracket-newline': ['error', 'consistent'],
-        '@stylistic/array-bracket-spacing': ['error', 'never'],
-        '@stylistic/array-element-newline': ['error', 'consistent'],
-        '@stylistic/arrow-parens': ['error', 'as-needed'],
-        '@stylistic/arrow-spacing': ['error'],
-        '@stylistic/brace-style': ['error', '1tbs'],
-        '@stylistic/comma-dangle': ['error', {
-            arrays: 'always-multiline',
-            exports: 'always-multiline',
-            functions: 'never',
-            imports: 'always-multiline',
-            objects: 'always-multiline',
-            enums: 'always-multiline',
-            generics: 'always-multiline',
-            tuples: 'always-multiline',
-        }],
-        '@stylistic/comma-spacing': ['error'],
-        '@stylistic/computed-property-spacing': ['error'],
-        '@stylistic/dot-location': ['error', 'property'],
-        '@stylistic/eol-last': ['error', 'always'],
-        '@stylistic/function-call-argument-newline': ['error', 'consistent'],
-        '@stylistic/function-call-spacing': ['error', 'never'],
-        '@stylistic/function-paren-newline': ['error', 'consistent'],
-        '@stylistic/implicit-arrow-linebreak': ['error', 'beside'],
-        '@stylistic/indent': ['error', 4, {
-            SwitchCase: 1,
-            ignoredNodes: [
-                'PropertyDefinition[decorators]',
-                'TSUnionType',
-            ],
-        }],
-        '@stylistic/key-spacing': ['error'],
-        '@stylistic/keyword-spacing': ['error'],
-        '@stylistic/linebreak-style': ['error', 'unix'],
-        '@stylistic/lines-between-class-members': ['error', 'always', {
-            exceptAfterSingleLine: true,
-        }],
-        '@stylistic/max-len': ['error', 120, {
-            ignoreComments: true,
-            ignoreRegExpLiterals: true,
-            ignoreStrings: true,
-            ignoreTemplateLiterals: true,
-            ignoreTrailingComments: true,
-            ignoreUrls: true,
-        }],
-        '@stylistic/max-statements-per-line': ['error', {
-            max: 2,
-        }],
-        '@stylistic/member-delimiter-style': ['error', {
-            multiline: {
-                requireLast: true,
-            },
-            singleline: {
-                requireLast: false,
-            },
-        }],
-        '@stylistic/multiline-ternary': ['error', 'always-multiline'],
-        '@stylistic/new-parens': ['error', 'always'],
-        '@stylistic/no-extra-parens': ['error', 'all', {
-            allowParensAfterCommentPattern: '@type',
-            enforceForArrowConditionals: false,
-            nestedBinaryExpressions: false,
-            returnAssign: false,
-        }],
-        '@stylistic/no-extra-semi': ['error'],
-        '@stylistic/no-floating-decimal': 'error',
-        '@stylistic/no-mixed-operators': ['error', {
-            allowSamePrecedence: true,
-            groups: [
-                ['&', '|', '^', '~', '<<', '>>', '>>>'],
-                ['==', '!=', '===', '!==', '>', '>=', '<', '<='],
-                ['&&', '||'],
-                ['in', 'instanceof'],
-            ],
-        }],
-        '@stylistic/no-mixed-spaces-and-tabs': ['error'],
-        '@stylistic/no-multi-spaces': ['error'],
-        '@stylistic/no-multiple-empty-lines': ['error', {
-            max: 1,
-            maxEOF: 0,
-        }],
-        '@stylistic/no-trailing-spaces': ['error'],
-        '@stylistic/no-whitespace-before-property': ['error'],
-        '@stylistic/object-curly-newline': ['error', {
-            consistent: true,
-        }],
-        '@stylistic/object-curly-spacing': ['error', 'always'],
-        '@stylistic/padded-blocks': ['error', 'never'],
-        '@stylistic/quote-props': ['error', 'as-needed'],
-        '@stylistic/quotes': ['error', 'single', {
-            avoidEscape: true,
-        }],
-        '@stylistic/rest-spread-spacing': ['error', 'never'],
-        '@stylistic/semi': ['error'],
-        '@stylistic/semi-spacing': ['error', {
-            after: true,
-            before: false,
-        }],
-        '@stylistic/semi-style': ['error', 'last'],
-        '@stylistic/space-before-blocks': ['error'],
-        '@stylistic/space-before-function-paren': ['error', {
-            anonymous: 'always',
-            named: 'always',
-        }],
-        '@stylistic/space-in-parens': ['error', 'never'],
-        '@stylistic/space-infix-ops': ['error'],
-        '@stylistic/spaced-comment': ['error', 'always', {
-            markers: ['/'],
-        }],
-        '@stylistic/template-curly-spacing': ['error', 'never'],
-        '@stylistic/template-tag-spacing': ['error', 'never'],
-        '@stylistic/type-annotation-spacing': ['error'],
-        '@stylistic/type-generic-spacing': ['error'],
-    },
-};

package/src/rules/typescript.cjs

@@ -1,33 +0,0 @@
-const overriddenRules = {
-    indent: 'off',
-    'no-undef': 'off',
-    'no-shadow': 'off',
-    '@typescript-eslint/comma-dangle': 'off',
-    'no-extra-parens': 'off',
-    '@typescript-eslint/no-extra-parens': 'off',
-    '@typescript-eslint/space-before-function-paren': 'off',
-    'no-unused-vars': 'off',
-    'no-useless-constructor': 'off',
-    '@typescript-eslint/indent': 'off',
-    semi: 'off',
-    '@typescript-eslint/semi': 'off',
-    'react/jsx-filename-extension': 'off',
-    'no-use-before-define': 'off',
-    '@typescript-eslint/lines-between-class-members': 'off',
-    '@typescript-eslint/comma-spacing': 'off',
-    '@typescript-eslint/space-before-blocks': 'off',
-};
-
-module.exports = {
-    rules: {
-        ...overriddenRules,
-        '@typescript-eslint/no-shadow': 'error',
-        '@typescript-eslint/no-unused-vars': ['error'],
-        '@typescript-eslint/no-useless-constructor': ['error'],
-        '@typescript-eslint/array-type': ['error', { default: 'array', readonly: 'array' }],
-        '@typescript-eslint/no-misused-promises': ['error', {
-            checksVoidReturn: { arguments: false },
-        }],
-        '@typescript-eslint/no-use-before-define': ['error'],
-    },
-};

package/src/rules/vue.cjs

@@ -1,172 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    rules: {
-        'vue/array-bracket-newline': ['error'],
-        'vue/array-bracket-spacing': ['error', 'never'],
-        'vue/array-element-newline': ['error', 'consistent'],
-        'vue/arrow-spacing': ['error'],
-        'vue/attribute-hyphenation': ['error', 'always'],
-        'vue/attributes-order': ['error', {
-            alphabetical: false,
-            order: [
-                'DEFINITION',
-                'LIST_RENDERING',
-                'CONDITIONALS',
-                'RENDER_MODIFIERS',
-                'GLOBAL',
-                'UNIQUE',
-                'TWO_WAY_BINDING',
-                'OTHER_DIRECTIVES',
-                'OTHER_ATTR',
-                'EVENTS',
-                'CONTENT',
-            ],
-        }],
-        'vue/brace-style': ['error', '1tbs'],
-        'vue/camelcase': ['error', {
-            allow: ['^\\$_'],
-        }],
-        'vue/comma-dangle': ['error', {
-            arrays: 'always-multiline',
-            exports: 'always-multiline',
-            functions: 'never',
-            imports: 'always-multiline',
-            objects: 'always-multiline',
-        }],
-        'vue/comma-spacing': ['error'],
-        'vue/comma-style': ['error', 'last'],
-        'vue/component-definition-name-casing': ['error', 'PascalCase'],
-        'vue/component-name-in-template-casing': ['error', 'PascalCase', {
-            registeredComponentsOnly: false,
-            ignores: [
-                'component',
-                'transition',
-            ],
-        }],
-        'vue/component-tags-order': ['error', {
-            order: [
-                'script[setup]',
-                'template',
-                'script:not([setup])',
-                'style',
-            ],
-        }],
-        'vue/dot-location': ['error'],
-        'vue/dot-notation': ['error'],
-        'vue/eqeqeq': ['error'],
-        'vue/func-call-spacing': ['error'],
-        'vue/html-closing-bracket-newline': ['error', {
-            multiline: 'never',
-            singleline: 'never',
-        }],
-        'vue/html-end-tags': ['error'],
-        'vue/html-indent': ['error', 4],
-        'vue/html-quotes': ['error', 'double'],
-        'vue/html-self-closing': ['error'],
-        'vue/html-closing-bracket-spacing': ['error'],
-        'vue/key-spacing': ['error'],
-        'vue/keyword-spacing': ['error'],
-        'vue/max-attributes-per-line': ['error', {
-            multiline: {
-                max: 1,
-            },
-            singleline: 1,
-        }],
-        'vue/max-len': ['error', 120, {
-            ignoreComments: true,
-            ignoreRegExpLiterals: true,
-            ignoreTemplateLiterals: true,
-            ignoreTrailingComments: true,
-            ignoreUrls: true,
-        }],
-        'vue/multi-word-component-names': 'off',
-        'vue/multiline-ternary': ['error', 'always-multiline'],
-        'vue/mustache-interpolation-spacing': ['error', 'always'],
-        'vue/no-bare-strings-in-template': ['error'],
-        'vue/no-console': ['error'],
-        'vue/no-constant-condition': ['error'],
-        'vue/no-empty-component-block': ['error'],
-        'vue/no-empty-pattern': ['error'],
-        'vue/no-extra-parens': ['error'],
-        'vue/no-irregular-whitespace': ['error'],
-        'vue/no-multi-spaces': ['error'],
-        'vue/no-multiple-objects-in-class': ['error'],
-        'vue/no-potential-component-option-typo': ['error'],
-        'vue/no-reserved-component-names': ['error'],
-        'vue/no-restricted-syntax': ['error'],
-        'vue/no-spaces-around-equal-signs-in-attribute': ['error'],
-        'vue/no-sparse-arrays': ['error'],
-        'vue/no-undef-components': ['error'],
-        'vue/no-unsupported-features': ['error'],
-        'vue/no-unused-properties': ['error'],
-        'vue/no-unused-refs': ['error'],
-        'vue/no-use-computed-property-like-method': ['error'],
-        'vue/no-use-v-if-with-v-for': 'error',
-        'vue/no-useless-concat': ['error'],
-        'vue/no-useless-mustaches': ['error'],
-        'vue/no-useless-v-bind': ['error'],
-        'vue/no-v-text': ['error'],
-        'vue/object-curly-newline': ['error', {
-            consistent: true,
-        }],
-        'vue/object-curly-spacing': ['error', 'always'],
-        'vue/object-property-newline': ['error', {
-            allowAllPropertiesOnSameLine: true,
-        }],
-        'vue/object-shorthand': ['error', 'always'],
-        'vue/order-in-components': ['error', {
-            order: [
-                'el',
-                'name',
-                'parent',
-                'functional',
-                ['delimiters', 'comments'],
-                ['components', 'directives', 'filters'],
-                'extends',
-                'mixins',
-                'inheritAttrs',
-                'model',
-                ['props', 'propsData'],
-                'data',
-                'computed',
-                'watch',
-                'LIFECYCLE_HOOKS',
-                'methods',
-                ['template', 'render'],
-                'renderError',
-            ],
-        }],
-        'vue/padding-line-between-blocks': ['error'],
-        'vue/prefer-separate-static-class': ['error'],
-        'vue/prefer-template': ['error'],
-        'vue/prefer-true-attribute-shorthand': ['error'],
-        'vue/prop-name-casing': ['error', 'camelCase'],
-        'vue/quote-props': ['error', 'as-needed'],
-        'vue/require-default-prop': ['error'],
-        'vue/require-prop-type-constructor': 'error',
-        'vue/require-prop-types': ['error'],
-        'vue/script-indent': ['error', 4, {
-            switchCase: 1,
-        }],
-        'vue/space-in-parens': ['error', 'never'],
-        'vue/space-infix-ops': ['error'],
-        'vue/space-unary-ops': ['error'],
-        'vue/template-curly-spacing': ['error'],
-        'vue/this-in-template': ['error', 'never'],
-        'vue/v-bind-style': ['error', 'shorthand'],
-        'vue/v-on-function-call': 'off',
-        'vue/v-on-style': ['error', 'shorthand'],
-        'vue/v-on-event-hyphenation': 'off',
-        'vue/no-setup-props-destructure': 'off',
-        'vue/block-tag-newline': ['error', {
-            singleline: 'always',
-            multiline: 'always',
-        }],
-        'vue/require-explicit-emits': ['error'],
-        'vue/no-required-prop-with-default': ['error'],
-        'vue/no-ref-object-destructure': ['error'],
-        'vue/no-template-target-blank': ['error'],
-        'vue/define-emits-declaration': ['error', 'type-based'],
-        'vue/define-props-declaration': ['error', 'type-based'],
-    },
-};

package/src/typescript/README.md

@@ -1,64 +0,0 @@
-# @useinsider/eslint-config/typescript
-
-This ESLint configuration is ideal for Node.js projects without front-end
-elements or DOM libraries. For mixed back-end and front-end projects, separate
-override blocks or a combined `node` and `dom` setup in a single block are
-possible, but not recommended.
-
-## Installation
-
-Before proceeding, ensure you have ESLint installed in your project.
-If not, install it:
-
-```bash
-pnpm add -E -D eslint
-```
-
-```bash
-npm install -E -D eslint
-```
-
-Then, install the ESLint plugins that our configuration extends. These are
-necessary for the configuration to work correctly:
-
-```bash
-pnpm add -E -D \
-eslint-config-airbnb-base \
-eslint-config-airbnb-typescript \
-@cspell/eslint-plugin \
-eslint-plugin-jsdoc \
-@typescript-eslint/eslint-plugin
-```
-
-```bash
-npm install -E -D \
-eslint-config-airbnb-base \
-eslint-config-airbnb-typescript \
-@typescript-eslint/eslint-plugin
-eslint-plugin-jsdoc \
-@cspell/eslint-plugin \
-```
-
-## Usage
-
-To integrate these rules into your project, modify your `.eslintrc` file as
-follows:
-
-```js
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['./src/**/*.ts'],
-      extends: [
-        '@useinsider/eslint-config/typescript',
-      ],
-      parserOptions: {
-        // Required for '@typescript-eslint/parser'
-        project: ['./tsconfig.json'],
-      },
-      // Additional configuration here
-    },
-  ],
-};
-```

package/src/typescript/index.cjs

@@ -1,44 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    extends: [
-        require.resolve('../base.cjs'),
-        'airbnb-base',
-        'airbnb-typescript/base',
-        'plugin:@cspell/recommended',
-        'plugin:jsdoc/recommended',
-        'plugin:jsdoc/recommended-typescript-error',
-        'plugin:@typescript-eslint/recommended',
-        'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        require.resolve('../rules/core.cjs'),
-        require.resolve('../rules/cspell.cjs'),
-        require.resolve('../rules/jsdoc.cjs'),
-        require.resolve('../rules/typescript.cjs'),
-        require.resolve('../rules/stylistic.cjs'),
-    ],
-    env: {
-        node: true,
-        es2021: true,
-    },
-    plugins: ['@typescript-eslint'],
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-        ecmaVersion: 'latest',
-        sourceType: 'module',
-    },
-    rules: {
-        'jsdoc/require-param': 'off',
-        'jsdoc/require-jsdoc': 'off',
-        'jsdoc/require-returns': 'off',
-        'jsdoc/require-param-type': 'off',
-        'jsdoc/check-param-names': 'off',
-    },
-    settings: {
-        jsdoc: {
-            mode: 'typescript',
-            tagNamePreference: {
-                callback: 'watch',
-                desc: 'use',
-            },
-        },
-    },
-};

package/src/typescript-dom/README.md

@@ -1,85 +0,0 @@
-# @useinsider/eslint-config/dom
-
-This configuration is designed for production source files typically located in
-the `src` directory of your project. It provides ESLint rules specifically for
-DOM-related code.
-
-## Installation
-
-Before proceeding, ensure you have ESLint installed in your project.
-If not, install it:
-
-```bash
-pnpm add -E -D eslint
-```
-
-```bash
-npm install -E -D eslint
-```
-
-Then, install the ESLint plugins that our configuration extends. These are
-necessary for the configuration to work correctly:
-
-```bash
-pnpm add -E -D \
-eslint-config-airbnb-base \
-eslint-config-airbnb-typescript \
-@cspell/eslint-plugin \
-eslint-plugin-jsdoc \
-@typescript-eslint/eslint-plugin
-```
-
-```bash
-npm install -E -D \
-eslint-config-airbnb-base \
-eslint-config-airbnb-typescript \
-@cspell/eslint-plugin \
-eslint-plugin-jsdoc \
-@typescript-eslint/eslint-plugin
-```
-
-## Usage
-
-To integrate these rules into your project, modify your `.eslintrc` file as
-follows:
-
-```js
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['./src/**/*.ts'],
-      extends: [
-        '@useinsider/eslint-config/typescript-dom',
-      ],
-      parserOptions: {
-        // `project` is necessary for `@typescript-eslint/parser` to work
-        project: ['./tsconfig.json'],
-      },
-      // Add additional configuration settings as needed
-    },
-  ],
-};
-```
-
-### Vue Extension Configuration
-
-To properly lint `.vue` files imported within `.ts` files, it's essential to
-update the `parserOptions` in your ESLint configuration. This adjustment helps
-prevent ESLint errors that may arise due to the import of Vue components. Add
-the following configuration to your `.eslintrc` file:
-
-```js
-{
-  // Existing configuration...
-  parserOptions: {
-    // Other existing parser options...
-    extraFileExtensions: ['.vue'], // Add this line
-  },
-},
-```
-
-This change ensures that ESLint correctly processes .vue files alongside
-TypeScript files, maintaining consistent code quality and style across your
-project.

package/src/typescript-dom/index.cjs

@@ -1,47 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    extends: [
-        require.resolve('../base.cjs'),
-        'airbnb-base',
-        'airbnb-typescript/base',
-        'plugin:@cspell/recommended',
-        'plugin:jsdoc/recommended',
-        'plugin:jsdoc/recommended-typescript-error',
-        'plugin:@typescript-eslint/recommended',
-        'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        require.resolve('../rules/core.cjs'),
-        require.resolve('../rules/cspell.cjs'),
-        require.resolve('../rules/jsdoc.cjs'),
-        require.resolve('../rules/typescript.cjs'),
-        require.resolve('../rules/stylistic.cjs'),
-    ],
-    env: {
-        browser: true,
-        es2021: true,
-    },
-    plugins: ['@typescript-eslint'],
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-        ecmaVersion: 'latest',
-        sourceType: 'module',
-        ecmaFeatures: {
-            jsx: true,
-        },
-    },
-    rules: {
-        'jsdoc/require-param': 'off',
-        'jsdoc/require-jsdoc': 'off',
-        'jsdoc/require-returns': 'off',
-        'jsdoc/require-param-type': 'off',
-        'jsdoc/check-param-names': 'off',
-    },
-    settings: {
-        jsdoc: {
-            mode: 'typescript',
-            tagNamePreference: {
-                callback: 'watch',
-                desc: 'use',
-            },
-        },
-    },
-};

package/src/vue3/README.md

@@ -1,84 +0,0 @@
-# @useinsider/eslint-config/vue3
-
-This package provides a comprehensive ESLint configuration tailored for Vue 3
-projects, ensuring code quality and consistency. It integrates best practices
-from the Vue community and extends various ESLint plugins to cover aspects like
-JSDoc conventions, and scoped CSS in Vue components.
-
-## Installation
-
-Before proceeding, ensure you have ESLint installed in your project.
-If not, install it:
-
-```bash
-pnpm add -E -D eslint
-```
-
-```bash
-npm install -E -D eslint
-```
-
-Then, install the ESLint plugins and configurations that our Vue configuration
-extends. These are necessary for the configuration to work correctly:
-
-```bash
-pnpm add -E -D \
-eslint-config-airbnb-base \
-eslint-plugin-vue \
-eslint-plugin-vue-scoped-css \
-eslint-plugin-jsdoc \
-@cspell/eslint-plugin \
-vue-eslint-parser
-```
-
-```bash
-npm install -E -D \
-eslint-config-airbnb-base \
-eslint-plugin-vue \
-eslint-plugin-vue-scoped-css \
-eslint-plugin-jsdoc \
-@cspell/eslint-plugin \
-vue-eslint-parser
-```
-
-## Usage
-
-To use this ESLint configuration in your Vue 3 project, update your `.eslintrc`
-file as follows:
-
-```js
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['./src/**/*.vue'],
-      extends: [
-        '@useinsider/eslint-config/vue3',
-      ],
-      // Add additional configuration settings as needed
-    },
-  ],
-};
-```
-
-Remember, you can always override specific rules or add additional plugins as
-per your project's requirements.
-
-## Reusable config limitation
-
-Before [ESLint Flat Config] becomes stable, in order to work around a
-[known limitation in ESLint], we recommend you to use this package alongside
-[@rushstack/eslint-patch], so that you don't have to install too many
-dependencies:
-
-```bash
-pnpm add -E -D @rushstack/eslint-patch
-```
-```bash
-npm install -E -D @rushstack/eslint-patch
-```
-
-[ESLint Flat Config]: https://eslint.org/docs/latest/use/configure/configuration-files-new
-[known limitation in ESLint]: https://github.com/eslint/eslint/issues/3458
-[@rushstack/eslint-patch]: https://www.npmjs.com/package/@rushstack/eslint-patch