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

package/README.md

@@ -5,11 +5,13 @@
   - [Table of Contents](#table-of-contents)
   - [Getting Started](#getting-started)
     - [Installation](#installation)
-  - [Versioning Policy](#versioning-policy)
-  - [Available Configurations](#available-configurations)
+  - [Examples](#examples)
+  - [Available Presets](#available-presets)
     - [Vanilla 🍦](#vanilla-)
     - [Framework-specific](#framework-specific)
     - [⏳ Upcoming Configurations](#-upcoming-configurations)
+      - [Vanilla 🍦](#vanilla--1)
+      - [Framework-specific](#framework-specific-1)
   - [Contributing](#contributing)
 
 ## Getting Started
@@ -34,50 +36,75 @@ using the `-D` and `-E` flags in your package manager commands.
 
    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
-    }
+   Add the following to your `eslint.config.js` file to use the presets:
+    ```js
+    import useInsider from '@useinsider/eslint-config';
+
+    /** @type {import('eslint').Linter.FlatConfig[]} */
+    export default [
+        await useInsider({
+            // See `Available Presets`
+            preset: ['dom'],
+            config: {
+                // Glob file path pattern to specify the target files of the
+                // selected presets
+                files: ['src/**/*'],
+            },
+        }),
+        await useInsider({
+            preset: ['node', 'config'],
+            config: {
+                files: ['**/eslint.config.js'],
+            },
+        }),
+    ];
     ```
+4. Adjust your `eslint.config.js` to your projects needs. Choose the right
+   preset for the right folder path
 
-[ESLint documentation]: https://eslint.org/docs/latest/use/configure/configuration-files
+[ESLint documentation]: https://eslint.org/docs/next/use/configure/configuration-files
 
-## Versioning Policy
+## Examples
 
-This project follows the [Semantic Versioning](https://semver.org) policy.
+Checkout the [examples directory](../../examples) to see various apps with the extended ESLint
+configuration.
 
-## Available Configurations
+## Available Presets
 
 We provide a variety of configurations to suit different environments and
-frameworks. Here's a list of available configurations:
+frameworks. Here's a list of available presets:
 
 ### 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)                                                 |
+| Environment       | Browser (DOM)                                           | Node                                                                                            |
+| :---------------- | :------------------------------------------------------ | :---------------------------------------------------------------------------------------------- |
+| **EcmaScript/JS** | [`dom`](./src/configs/dom#readme)                       | [`@useinsider/eslint-config`](./src/configs/node#readme)<br>[`node`](./src/configs/node#readme) |
+| **TypeScript**    | [`typescript-dom`](./src/configs/typescript-dom#readme) | [`typescript`](./src/configs/typescript#readme)                                                 |
+| **Config files**  |                                                         | [`config`](./src/configs/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) |
+| Environment | JavaScript                          | TypeScript                                                |
+| :---------- | :---------------------------------- | :-------------------------------------------------------- |
+| **Vue 3**   | [`vue3`](./src/configs/vue3#readme) | [`vue3-typescript`](./src/configs/vue3-typescript#readme) |
+
+---
 
 ### ⏳ Upcoming Configurations
 
-Not available yet!
+Following presets are not available yet!
+
+#### Vanilla 🍦
+
+| Environment       | Browser (DOM)                                   | Node                                    |
+| :---------------- | :---------------------------------------------- | :-------------------------------------- |
+| **Legacy ES5 💀​** | [`legacy-dom`](./src/configs/legacy-dom#readme) | [`legacy`](./src/configs/legacy#readme) |
 
-| Environment       | Browser (DOM)                                                     | Node                                                      |
-| :---------------- | :---------------------------------------------------------------- | :-------------------------------------------------------- |
-| **Legacy ES5 💀​** | [`@useinsider/eslint-config/legacy-dom`](./src/legacy-dom#readme) | [`@useinsider/eslint-config/legacy`](./src/legacy#readme) |
+#### Framework-specific
 
-| Environment | JavaScript                                            | TypeScript                                                                  |
-| :---------- | :---------------------------------------------------- | :-------------------------------------------------------------------------- |
-| **Vue 2**   | [`@useinsider/eslint-config/vue2`](./src/vue2#readme) | [`@useinsider/eslint-config/vue2-typescript`](./src/vue2-typescript#readme) |
+| Environment | JavaScript                          | TypeScript                                                |
+| :---------- | :---------------------------------- | :-------------------------------------------------------- |
+| **Vue 2**   | [`vue2`](./src/configs/vue2#readme) | [`vue2-typescript`](./src/configs/vue2-typescript#readme) |
 
 ## Contributing
 

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@useinsider/eslint-config",
     "type": "module",
-    "version": "1.2.0",
+    "version": "1.3.0-alpha.6",
     "description": "A collection of ESLint configurations provided by @useinsider, offering support for various environments including Vanilla JS, TypeScript, and framework-specific setups such as Vue 3.",
     "keywords": [
         "useinsider",
@@ -12,6 +12,7 @@
         "vanilla",
         "typescript",
         "vue",
+        "vue2",
         "vue3",
         "node"
     ],
@@ -19,14 +20,20 @@
     "license": "MIT",
     "packageManager": "pnpm@8.11.0",
     "scripts": {
-        "lint": "eslint ./",
-        "lint:ci": "pnpm lint --quiet",
+        "dev": "vite",
+        "build": "vite build",
+        "emit-types": "tsc --declaration -p tsconfig.lib.json",
+        "check-types": "tsc --noEmit -p tsconfig.json",
+        "prelint": "pnpm build",
+        "lint": "eslint .",
         "lint:fix": "pnpm lint --fix",
+        "pretest": "pnpm build",
         "test": "vitest",
         "test:ci": "pnpm test",
-        "release": "semantic-release -e semantic-release-monorepo"
+        "prerelease": "pnpm build",
+        "release": "semantic-release"
     },
-    "homepage": "https://github.com/useinsider/config/tree/master/packages/eslint-config#readme",
+    "homepage": "https://github.com/useinsider/config/tree/main/packages/eslint-config#readme",
     "repository": {
         "type": "git",
         "url": "https://github.com/useinsider/config",
@@ -35,46 +42,63 @@
     "bugs": {
         "url": "https://github.com/useinsider/config/issues"
     },
+    "main": "./dist/main.js",
+    "types": "./dist/main.d.ts",
     "exports": {
-        ".": "./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"
+        ".": {
+            "types": "./dist/main.d.ts",
+            "import": "./dist/main.js",
+            "require": "./dist/main.cjs"
+        },
+        "./rules/*": {
+            "import": "./dist/rules/*.js",
+            "require": "./dist/rules/*.cjs"
+        }
     },
     "files": [
-        "src/**/*"
+        "dist"
     ],
     "engines": {
-        "node": "^16.0.0 || >=18.0.0"
+        "node": ">=16",
+        "pnpm": ">=8"
     },
     "dependencies": {
         "@cspell/eslint-plugin": "6.19.2",
+        "@eslint/eslintrc": "3.0.0",
         "@stylistic/eslint-plugin": "1.4.1",
         "@stylistic/eslint-plugin-migrate": "1.4.1",
         "eslint": "8.54.0",
         "eslint-config-airbnb-base": "15.0.0",
         "eslint-plugin-import": "2.29.0",
-        "eslint-plugin-jsdoc": "46.9.0"
+        "eslint-plugin-jsdoc": "48.0.2",
+        "tslib": "2.6.2"
     },
     "devDependencies": {
+        "@eslint/js": "8.56.0",
+        "@rollup/plugin-typescript": "11.1.5",
         "@semantic-release/changelog": "6.0.3",
         "@semantic-release/git": "10.0.1",
-        "@types/eslint": "8.44.8",
+        "@types/eslint": "8.56.2",
+        "@types/eslint__eslintrc": "2.1.1",
+        "@types/eslint__js": "8.42.3",
         "@types/fs-extra": "11.0.4",
         "@types/node": "20.10.2",
         "@typescript-eslint/eslint-plugin": "6.13.2",
         "@useinsider/release-config": "workspace:*",
         "@vitest/coverage-v8": "0.34.6",
         "@vue/eslint-config-typescript": "12.0.0",
+        "eslint-import-resolver-typescript": "3.6.1",
         "eslint-plugin-vue": "9.19.2",
         "eslint-plugin-vue-scoped-css": "2.5.1",
         "fs-extra": "11.2.0",
+        "globals": "13.24.0",
+        "rollup-plugin-typescript-paths": "1.5.0",
+        "rollup-plugin-visualizer": "5.11.0",
         "semantic-release": "19.0.5",
         "semantic-release-monorepo": "7.0.5",
+        "ts-deepmerge": "7.0.0",
+        "vite": "5.0.10",
+        "vite-plugin-dts": "3.7.0",
         "vite-tsconfig-paths": "4.2.2",
         "vitest": "0.34.6",
         "vue": "3.3.13",

package/src/base.cjs

@@ -1,10 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    env: {
-        es2021: true,
-    },
-    plugins: ['import', 'jsdoc', '@stylistic', '@stylistic/migrate'],
-    extends: [
-        'eslint:recommended',
-    ],
-};

package/src/config/README.md

@@ -1,56 +0,0 @@
-# @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/config/index.cjs

@@ -1,7 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    rules: {
-        'import/no-extraneous-dependencies': 'off',
-        'import/prefer-default-export': 'off',
-    },
-};

package/src/dom/README.md

@@ -1,56 +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-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

@@ -1,20 +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/core.cjs'),
-        require.resolve('../rules/cspell.cjs'),
-        require.resolve('../rules/stylistic.cjs'),
-        require.resolve('../rules/jsdoc.cjs'),
-    ],
-    env: {
-        browser: true,
-        es2021: true,
-    },
-    parserOptions: {
-        ecmaVersion: 'latest',
-    },
-};

package/src/node/README.md

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

@@ -1,19 +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/core.cjs'),
-        require.resolve('../rules/cspell.cjs'),
-        require.resolve('../rules/stylistic.cjs'),
-        require.resolve('../rules/jsdoc.cjs'),
-    ],
-    env: {
-        node: true,
-    },
-    parserOptions: {
-        ecmaVersion: 'latest',
-    },
-};

package/src/rules/README.md

@@ -1,6 +0,0 @@
-# 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/core.cjs

@@ -1,168 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    rules: {
-        'arrow-parens': 'off',
-        camelcase: ['error', {
-            allow: ['^\\$_'],
-        }],
-        'class-methods-use-this': 'off',
-        'comma-dangle': 'off',
-        'consistent-return': ['error'],
-        curly: ['error', 'all'],
-        'dot-notation': ['error'],
-        'function-paren-newline': 'off',
-        'guard-for-in': 'error',
-        'handle-callback-err': ['error'],
-        'import/extensions': ['error', {
-            css: 'always',
-            js: 'never',
-            json: 'always',
-            jsx: 'never',
-            sass: 'always',
-            scss: 'always',
-            svg: 'always',
-            ts: 'never',
-            tsx: 'never',
-            vue: 'always',
-        }],
-        'import/no-cycle': 'off',
-        'import/no-unresolved': 'off',
-        'import/order': ['error', {
-            alphabetize: {
-                caseInsensitive: true,
-                order: 'asc',
-            },
-            groups: ['index', 'builtin', 'object', 'type', 'external', 'parent', 'internal', 'sibling'],
-            pathGroups: [{
-                group: 'internal',
-                pattern: '@/**',
-            }],
-        }],
-        'import/prefer-default-export': 'off',
-        indent: 'off',
-        'max-len': 'off',
-        'new-cap': ['error'],
-        'no-alert': ['error'],
-        'no-bitwise': ['error', {
-            allow: ['~'],
-        }],
-        'no-caller': ['error'],
-        'no-case-declarations': ['error'],
-        'no-confusing-arrow': ['error', {
-            allowParens: true,
-        }],
-        'no-console': ['error'],
-        'no-debugger': ['error'],
-        'no-div-regex': ['error'],
-        'no-dupe-args': ['error'],
-        'no-dupe-keys': ['error'],
-        'no-duplicate-case': ['error'],
-        'no-else-return': ['error'],
-        'no-empty': ['error'],
-        'no-extra-bind': ['error'],
-        'no-extra-boolean-cast': 'error',
-        'no-fallthrough': ['error'],
-        'no-implicit-coercion': ['error', {
-            boolean: true,
-            number: true,
-            string: true,
-        }],
-        'implicit-arrow-linebreak': 'off',
-        'no-invalid-regexp': ['error'],
-        'no-iterator': ['error'],
-        'no-mixed-operators': 'off',
-        'no-multi-spaces': 'off',
-        'no-multi-str': ['error'],
-        'no-multiple-empty-lines': 'off',
-        'no-native-reassign': 'error',
-        'no-nested-ternary': ['error'],
-        'no-new': 'off',
-        'no-new-object': ['error'],
-        'no-new-require': ['error'],
-        'no-param-reassign': ['error', {
-            props: false,
-        }],
-        'no-plusplus': 'off',
-        'no-process-exit': ['error'],
-        'no-promise-executor-return': ['error', {
-            allowVoid: true,
-        }],
-        'no-return-assign': ['error', 'except-parens'],
-        'no-self-compare': ['error'],
-        'no-sequences': ['error'],
-        'no-shadow': ['error', {
-            allow: ['state'],
-        }],
-        'no-undef': ['error'],
-        'no-underscore-dangle': 'off',
-        'no-unexpected-multiline': ['error'],
-        'no-unreachable': ['error'],
-        'no-unused-vars': ['error'],
-        'no-use-before-define': 'error',
-        'no-useless-call': ['error'],
-        'no-void': 'off',
-        'no-with': ['error'],
-        'object-curly-newline': 'off',
-        'object-shorthand': ['error', 'always'],
-        'padded-blocks': 'off',
-        'padding-line-between-statements': [
-            'error',
-            {
-                blankLine: 'always',
-                next: '*',
-                prev: ['const', 'let', 'var', 'if', 'block-like', 'directive'],
-            },
-            {
-                blankLine: 'always',
-                next: ['const', 'let', 'var', 'if', 'directive', 'return', 'break', 'default', 'cjs-export', 'export'],
-                prev: '*',
-            },
-            {
-                blankLine: 'any',
-                next: ['cjs-export', 'export'],
-                prev: ['cjs-export', 'export'],
-            },
-            {
-                blankLine: 'any',
-                next: ['const', 'let', 'var', 'directive'],
-                prev: ['const', 'let', 'var', 'directive'],
-            },
-            {
-                blankLine: 'never',
-                next: ['singleline-const', 'singleline-let', 'singleline-var'],
-                prev: ['singleline-const', 'singleline-let', 'singleline-var'],
-            },
-            {
-                blankLine: 'always',
-                next: ['multiline-block-like'],
-                prev: ['*'],
-            },
-            {
-                blankLine: 'always',
-                next: ['*'],
-                prev: ['multiline-block-like'],
-            },
-            {
-                blankLine: 'any',
-                next: ['case'],
-                prev: ['case'],
-            },
-            {
-                blankLine: 'any',
-                next: ['singleline-const', 'singleline-let', 'singleline-var'],
-                prev: ['cjs-import'],
-            },
-        ],
-        'prefer-const': ['error', {
-            destructuring: 'all',
-        }],
-        'prefer-destructuring': ['error'],
-        radix: ['error', 'as-needed'],
-        semi: 'off',
-        'space-before-function-paren': 'off',
-        'space-in-parens': 'off',
-        strict: ['error'],
-        'use-isnan': ['error'],
-        'valid-typeof': ['error'],
-    },
-};

package/src/rules/cspell.cjs

@@ -1,6 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-    rules: {
-        '@cspell/spellchecker': 'error',
-    },
-};