@useinsider/eslint-config 0.0.1 → 1.0.0-alpha.2

package/README.md

@@ -0,0 +1,85 @@
+# ESLint Config
+
+## Table of Contents
+- [ESLint Config](#eslint-config)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Installation](#installation)
+  - [Versioning Policy](#versioning-policy)
+  - [Available Configurations](#available-configurations)
+    - [Vanilla 🍦](#vanilla-)
+    - [Framework-specific](#framework-specific)
+    - [⏳ Upcoming Configurations](#-upcoming-configurations)
+  - [Contributing](#contributing)
+
+## Getting Started
+
+To ensure consistency and prevent version conflicts, we recommend adding this
+library as a development dependency with a fixed version. This can be achieved
+using the `-D` and `-E` flags in your package manager commands.
+
+### Installation
+
+1. **Install as a Development Dependency:**
+   - For npm users:
+     ```bash
+     npm install -D -E @useinsider/eslint-config
+     ```
+   - For pnpm users:
+     ```bash
+     pnpm add -D -E @useinsider/eslint-config
+     ```
+2. **Create an ESLint config file:**
+   You'll need an ESLint config file in your projects root directory.
+
+   You can check the official [ESLint documentation] to get more details.
+3. **Extend the Configuration:**
+   Add the following to your `.eslintrc` file to extend the configuration:
+    ```json5
+    {
+      "extends": ["@useinsider/eslint-config/dom"],
+      // Add the rest of your configuration here
+    }
+    ```
+
+[ESLint documentation]: https://eslint.org/docs/latest/use/configure/configuration-files
+
+## Versioning Policy
+
+This project follows the [Semantic Versioning](https://semver.org) policy.
+
+## Available Configurations
+
+We provide a variety of configurations to suit different environments and
+frameworks. Here's a list of available configurations:
+
+### Vanilla 🍦
+
+| Environment       | Browser (DOM)                                                             | Node                                                                                                      |
+| :---------------- | :------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------- |
+| **EcmaScript/JS** | [`@useinsider/eslint-config/dom`](./src/dom#readme)                       | [`@useinsider/eslint-config`](./src/node#readme)<br>[`@useinsider/eslint-config/node`](./src/node#readme) |
+| **TypeScript**    | [`@useinsider/eslint-config/typescript-dom`](./src/typescript-dom#readme) | [`@useinsider/eslint-config/typescript`](./src/typescript#readme)                                         |
+| **Config files**  |                                                                           | [`@useinsider/eslint-config/config`](./src/config#readme)                                                 |
+
+### Framework-specific
+
+| Environment | JavaScript                                            | TypeScript                                                                  |
+| :---------- | :---------------------------------------------------- | :-------------------------------------------------------------------------- |
+| **Vue 3**   | [`@useinsider/eslint-config/vue3`](./src/vue3#readme) | [`@useinsider/eslint-config/vue3-typescript`](./src/vue3-typescript#readme) |
+
+### ⏳ Upcoming Configurations
+
+Not available yet!
+
+| Environment       | Browser (DOM)                                                     | Node                                                      |
+| :---------------- | :---------------------------------------------------------------- | :-------------------------------------------------------- |
+| **Legacy ES5 💀​** | [`@useinsider/eslint-config/legacy-dom`](./src/legacy-dom#readme) | [`@useinsider/eslint-config/legacy`](./src/legacy#readme) |
+
+| Environment | JavaScript                                            | TypeScript                                                                  |
+| :---------- | :---------------------------------------------------- | :-------------------------------------------------------------------------- |
+| **Vue 2**   | [`@useinsider/eslint-config/vue2`](./src/vue2#readme) | [`@useinsider/eslint-config/vue2-typescript`](./src/vue2-typescript#readme) |
+
+## Contributing
+
+Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on
+how to contribute to this project.

package/package.json

@@ -1,42 +1,73 @@
 {
     "name": "@useinsider/eslint-config",
+    "version": "1.0.0-alpha.2",
+    "keywords": [
+        "useinsider",
+        "eslint",
+        "eslint-config"
+    ],
     "author": "Sahin Deniz <sahin.deniz@useinsider.com>",
     "license": "MIT",
-    "version": "0.0.1",
     "packageManager": "pnpm@8.11.0",
     "scripts": {
-        "lint": "eslint --ext .js,.cjs ./",
+        "lint": "eslint ./",
+        "lint:ci": "pnpm lint --quiet",
         "lint:fix": "pnpm lint --fix",
-        "release": "standard-version && git push --follow-tags && pnpm publish --dry-run --no-git-checks packages/eslint"
+        "release": "semantic-release -e semantic-release-monorepo"
     },
+    "homepage": "https://github.com/useinsider/eslint-config#readme",
     "repository": {
         "type": "git",
-        "url": "git+https://useinsider/eslint-config.git"
+        "url": "git+https://github.com/useinsider/eslint-config.git"
+    },
+    "bugs": {
+        "url": "https://github.com/useinsider/eslint-config/issues"
     },
     "exports": {
-        ".": "./src/node.cjs",
-        "./dom": "./src/dom.cjs",
-        "./typescript": "./src/typescript.cjs",
-        "./typescript-dom": "./src/typescript-dom.cjs",
-        "./vue3": "./src/vue3.cjs",
-        "./node": "./src/node.cjs",
-        "./config": "./src/config.cjs"
+        ".": "./src/node/index.cjs",
+        "./node": "./src/node/index.cjs",
+        "./config": "./src/config/index.cjs",
+        "./dom": "./src/dom/index.cjs",
+        "./typescript": "./src/typescript/index.cjs",
+        "./typescript-dom": "./src/typescript-dom/index.cjs",
+        "./vue3": "./src/vue3/index.cjs",
+        "./vue3-typescript": "./src/vue3-typescript/index.cjs"
     },
     "files": [
         "src/**/*"
     ],
-    "peerDependencies": {
-        "@cspell/eslint-plugin": "8.0.0",
+    "engines": {
+        "node": "^16.0.0 || >=18.0.0"
+    },
+    "dependencies": {
+        "@cspell/eslint-plugin": "6.19.2",
         "@stylistic/eslint-plugin": "1.4.1",
         "@stylistic/eslint-plugin-migrate": "1.4.1",
-        "@types/eslint": "8.44.7",
-        "@types/node": "20.10.1",
-        "eslint": "8.54.0",
         "eslint-config-airbnb-base": "15.0.0",
         "eslint-plugin-import": "2.29.0",
         "eslint-plugin-jsdoc": "46.9.0"
     },
     "devDependencies": {
-        "standard-version": "9.5.0"
+        "@semantic-release/changelog": "6.0.3",
+        "@semantic-release/git": "10.0.1",
+        "@types/eslint": "8.44.8",
+        "@types/node": "20.10.2",
+        "@useinsider/release-config": "workspace:*",
+        "semantic-release": "19.0.5",
+        "semantic-release-monorepo": "7.0.5"
+    },
+    "optionalDependencies": {
+        "@rushstack/eslint-patch": ">=1.6.0",
+        "@stylistic/eslint-plugin": ">=1.4.1",
+        "@stylistic/eslint-plugin-migrate": ">=1.4.1",
+        "@typescript-eslint/eslint-plugin": ">=6.13.1",
+        "@vue/eslint-config-typescript": ">=12.0.0",
+        "eslint": ">=8.54.0",
+        "eslint-plugin-vue": ">=9.19.2",
+        "eslint-plugin-vue-scoped-css": ">=2.5.1",
+        "vue-eslint-parser": ">=9.3.2"
+    },
+    "publishConfig": {
+        "access": "restricted"
     }
 }

package/src/config/README.md

@@ -0,0 +1,56 @@
+# @useinsider/eslint-config/config
+
+This rule set specifically targets configuration files typically placed at the
+root level of your project. These files are not part of your production build
+but are crucial for maintaining consistent coding standards across your
+development environment.
+
+**Examples of such files include:**
+- `.eslintrc.js`
+- `vite.config.ts`
+- `scripts/.../watch-build.js`
+- ...and more.
+
+## How to Use
+
+To integrate these rules into your project, modify your `.eslintrc` file as
+follows:
+
+```js
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+  root: true,
+  overrides: [
+    {
+      // For JavaScript configuration files at root level
+      files: ['./*.js', './*.cjs'],
+      extends: [
+        '@useinsider/eslint-config',
+        '@useinsider/eslint-config/config',
+      ],
+      // Add additional configurations here
+    },
+
+    {
+      // For TypeScript configuration files, including those in 'scripts' directory
+      files: ['./*.ts', './scripts/**/*.ts'],
+      extends: [
+        '@useinsider/eslint-config',
+        '@useinsider/eslint-config/typescript',
+        '@useinsider/eslint-config/config',
+      ],
+      parserOptions: {
+        // Required for '@typescript-eslint/parser'
+        project: ['./tsconfig.json'],
+      },
+    },
+  ],
+};
+```
+
+<blockquote>
+  <p>[!NOTE]<br>
+    Ensure that the <code>parserOptions.project</code> path correctly points to
+    your <code>tsconfig.json</code> file to enable TypeScript linting.
+  </p>
+</blockquote>

package/src/dom/README.md

@@ -0,0 +1,56 @@
+# @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-plugin-jsdoc \
+@cspell/eslint-plugin
+```
+
+```bash
+npm install -E -D \
+eslint-config-airbnb-base \
+eslint-plugin-jsdoc \
+@cspell/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/**/*.js'],
+      extends: [
+        '@useinsider/eslint-config/dom',
+      ],
+      // Add additional configuration settings as needed
+    },
+  ],
+};
+```

package/src/dom/index.cjs

@@ -0,0 +1,19 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+    extends: [
+        require.resolve('../base.cjs'),
+        'airbnb-base',
+        'plugin:jsdoc/recommended',
+        'plugin:@cspell/recommended',
+        require.resolve('../rules/core.cjs'),
+        require.resolve('../rules/stylistic.cjs'),
+        require.resolve('../rules/jsdoc.cjs'),
+    ],
+    env: {
+        browser: true,
+        es2021: true,
+    },
+    parserOptions: {
+        ecmaVersion: 'latest',
+    },
+};

package/src/node/README.md

@@ -0,0 +1,56 @@
+# @useinsider/eslint-config/node
+
+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-plugin-jsdoc \
+@cspell/eslint-plugin
+```
+
+```bash
+npm install -E -D \
+eslint-config-airbnb-base \
+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/**/*.{js,cjs,mjs}'],
+      extends: [
+        '@useinsider/eslint-config',
+      ],
+      // Additional configuration here
+    },
+  ],
+};
+```

package/src/node/index.cjs

@@ -0,0 +1,18 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+    extends: [
+        require.resolve('../base.cjs'),
+        'airbnb-base',
+        'plugin:jsdoc/recommended',
+        'plugin:@cspell/recommended',
+        require.resolve('../rules/core.cjs'),
+        require.resolve('../rules/stylistic.cjs'),
+        require.resolve('../rules/jsdoc.cjs'),
+    ],
+    env: {
+        node: true,
+    },
+    parserOptions: {
+        ecmaVersion: 'latest',
+    },
+};

package/src/rules/README.md

@@ -0,0 +1,6 @@
+# Rules
+
+Each file contains only the rules that are specific to its name.
+When a new plugin is introduced, its rule file must be named after the plugin
+and it should only contain rules that are specific to it. Even if it suppresses
+a core rule, oppressed rule must be declared inside the `core.cjs` file.

package/src/rules/{agnostic.cjs → core.cjs}

@@ -14,6 +14,8 @@ module.exports = {
         'handle-callback-err': ['error'],
         'import/extensions': ['error', {
             js: 'never',
+            json: 'always',
+            jsx: 'never',
             ts: 'never',
             tsx: 'never',
             vue: 'always',
@@ -120,18 +122,18 @@ module.exports = {
             },
             {
                 blankLine: 'always',
-                prev: ['*'],
                 next: ['multiline-block-like'],
+                prev: ['*'],
             },
             {
                 blankLine: 'always',
-                prev: ['multiline-block-like'],
                 next: ['*'],
+                prev: ['multiline-block-like'],
             },
             {
                 blankLine: 'any',
-                prev: ['case'],
                 next: ['case'],
+                prev: ['case'],
             },
             {
                 blankLine: 'any',
@@ -144,6 +146,7 @@ module.exports = {
         }],
         'prefer-destructuring': ['error'],
         radix: ['error', 'as-needed'],
+        semi: 'off',
         'space-before-function-paren': 'off',
         strict: ['error'],
         'use-isnan': ['error'],

package/src/rules/stylistic.cjs

@@ -53,6 +53,7 @@ module.exports = {
         '@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,

package/src/typescript/README.md

@@ -0,0 +1,64 @@
+# @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 \
+@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
+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

@@ -0,0 +1,41 @@
+/** @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/stylistic.cjs'),
+        require.resolve('../rules/jsdoc.cjs'),
+        require.resolve('../rules/typescript.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',
+    },
+    settings: {
+        jsdoc: {
+            mode: 'typescript',
+            tagNamePreference: {
+                callback: 'watch',
+                desc: 'use',
+            },
+        },
+    },
+};

package/src/typescript-dom/README.md

@@ -0,0 +1,64 @@
+# @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
+    },
+  ],
+};
+```

package/src/{typescript.cjs → typescript-dom/index.cjs}

@@ -1,23 +1,24 @@
 /** @type {import("eslint").Linter.Config} */
 module.exports = {
     extends: [
-        require.resolve('./base.cjs'),
+        require.resolve('../base.cjs'),
+        'airbnb-base',
         'airbnb-typescript/base',
-        'plugin:jsdoc/recommended',
         '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/agnostic.cjs'),
-        require.resolve('./rules/stylistic.cjs'),
-        require.resolve('./rules/jsdoc.cjs'),
-        require.resolve('./rules/typescript.cjs'),
+        require.resolve('../rules/core.cjs'),
+        require.resolve('../rules/stylistic.cjs'),
+        require.resolve('../rules/jsdoc.cjs'),
+        require.resolve('../rules/typescript.cjs'),
     ],
-    plugins: ['@typescript-eslint'],
     env: {
         browser: true,
         es2021: true,
     },
+    plugins: ['@typescript-eslint'],
     parser: '@typescript-eslint/parser',
     parserOptions: {
         ecmaVersion: 'latest',

package/src/vue3/README.md

@@ -0,0 +1,84 @@
+# @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

package/src/vue3/index.cjs

@@ -0,0 +1,28 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+    extends: [
+        require.resolve('../base.cjs'),
+        'airbnb-base',
+        'plugin:vue/vue3-recommended',
+        'plugin:vue-scoped-css/vue3-recommended',
+        'plugin:jsdoc/recommended',
+        'plugin:@cspell/recommended',
+        require.resolve('../rules/core.cjs'),
+        require.resolve('../rules/stylistic.cjs'),
+        require.resolve('../rules/jsdoc.cjs'),
+        require.resolve('../rules/vue.cjs'),
+    ],
+    env: {
+        browser: true,
+        es2021: true,
+    },
+    parser: 'vue-eslint-parser',
+    parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        ecmaFeatures: {
+            jsx: true,
+        },
+        extraFileExtensions: ['.vue'],
+    },
+};

package/src/vue3-typescript/README.md

@@ -0,0 +1,93 @@
+# @useinsider/eslint-config/vue3-typescript
+
+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
+TypeScript support, 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-config-airbnb-typescript \
+eslint-plugin-vue \
+eslint-plugin-vue-scoped-css \
+eslint-plugin-jsdoc \
+@cspell/eslint-plugin \
+@vue/eslint-config-typescript \
+@typescript-eslint/eslint-plugin \
+vue-eslint-parser
+```
+
+```bash
+npm install -E -D \
+eslint-config-airbnb-base \
+eslint-config-airbnb-typescript \
+eslint-plugin-vue \
+eslint-plugin-vue-scoped-css \
+eslint-plugin-jsdoc \
+@cspell/eslint-plugin \
+@vue/eslint-config-typescript \
+@typescript-eslint/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',
+      ],
+      parserOptions: {
+        project: ['./tsconfig.json'],
+      },
+      // 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

package/src/{vue3.cjs → vue3-typescript/index.cjs}

@@ -1,7 +1,7 @@
 /** @type {import("eslint").Linter.Config} */
 module.exports = {
     extends: [
-        require.resolve('./base.cjs'),
+        require.resolve('../base.cjs'),
         'airbnb-typescript/base',
         'plugin:vue/vue3-recommended',
         'plugin:vue-scoped-css/vue3-recommended',
@@ -10,11 +10,11 @@ module.exports = {
         'plugin:@cspell/recommended',
         '@vue/eslint-config-typescript',
         'plugin:@typescript-eslint/recommended',
-        require.resolve('./rules/agnostic.cjs'),
-        require.resolve('./rules/stylistic.cjs'),
-        require.resolve('./rules/jsdoc.cjs'),
-        require.resolve('./rules/vue.cjs'),
-        require.resolve('./rules/typescript.cjs'),
+        require.resolve('../rules/core.cjs'),
+        require.resolve('../rules/stylistic.cjs'),
+        require.resolve('../rules/jsdoc.cjs'),
+        require.resolve('../rules/vue.cjs'),
+        require.resolve('../rules/typescript.cjs'),
     ],
     plugins: ['@typescript-eslint'],
     env: {

package/src/dom.cjs

@@ -1,15 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    extends: [
-        require.resolve('./base.cjs'),
-        'airbnb-base',
-        'plugin:jsdoc/recommended',
-        'plugin:@cspell/recommended',
-        require.resolve('./rules/agnostic.cjs'),
-        require.resolve('./rules/stylistic.cjs'),
-        require.resolve('./rules/jsdoc.cjs'),
-    ],
-    env: {
-        browser: true,
-    },
-};

package/src/node.cjs

@@ -1,12 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    extends: [
-        require.resolve('./base.cjs'),
-        'airbnb-base',
-        'plugin:jsdoc/recommended',
-        'plugin:@cspell/recommended',
-        require.resolve('./rules/agnostic.cjs'),
-        require.resolve('./rules/stylistic.cjs'),
-        require.resolve('./rules/jsdoc.cjs'),
-    ],
-};