@useinsider/eslint-config 1.0.1-beta.7 → 1.1.0

package/README.md

@@ -1,20 +1,17 @@
-# ESLint Config
-
-Welcome to Insider's shared ESLint configuration! This project offers a set of
-ESLint rules tailored for both EcmaScript/JavaScript and TypeScript. It is
-designed to help you seamlessly integrate Insider's coding style into your
-development workflow.
+# ESLint Configurations
 
 ## Table of Contents
-- [ESLint Config](#eslint-config)
+- [ESLint Configurations](#eslint-configurations)
   - [Table of Contents](#table-of-contents)
   - [Getting Started](#getting-started)
     - [Installation](#installation)
+  - [Versioning Policy](#versioning-policy)
   - [Available Configurations](#available-configurations)
-    - [Upcoming Configurations](#upcoming-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
@@ -24,16 +21,19 @@ 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
      ```
+   - For npm users:
+     ```bash
+     npm install -D -E @useinsider/eslint-config
+     ```
+2. **Create an ESLint config file:**
+   You'll need an ESLint config file in your projects root directory.
 
-2. **Extend the Configuration:**
+   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
     {
@@ -42,28 +42,44 @@ using the `-D` and `-E` flags in your package manager commands.
     }
     ```
 
+[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:
 
-| Environment       | Browser                                                                | Node                                                                                                |
-| :---------------- | :--------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------- |
-| **EcmaScript/JS** | [`@useinsider/eslint-config/dom`](./src/dom.cjs)                       | [`@useinsider/eslint-config`](./src/node.cjs)<br>[`@useinsider/eslint-config/node`](./src/node.cjs) |
-| **TypeScript**    | [`@useinsider/eslint-config/typescript-dom`](./src/typescript-dom.cjs) | [`@useinsider/eslint-config/typescript`](./src/typescript.cjs)                                      |
-| **Vue 3**         | [`@useinsider/eslint-config/vue3`](./src/vue3.cjs)                     | -                                                                                                   |
+### Vanilla 🍦
 
-### Upcoming Configurations
+| 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                                                        | Node                                                   |
-| :---------------- | :------------------------------------------------------------- | :----------------------------------------------------- |
-| **Legacy ES5 💀​** | [`@useinsider/eslint-config/legacy-dom`](./src/legacy-dom.cjs) | [`@useinsider/eslint-config/legacy`](./src/legacy.cjs) |
-| **Vue 2**         | [`@useinsider/eslint-config/vue2`](./src/vue2.cjs)             | -                                                      |
+| 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
 
-Your contributions are welcome!
-Please consult the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how
-to contribute to this project.
+Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on
+how to contribute to this project.

package/package.json

@@ -1,29 +1,37 @@
 {
     "name": "@useinsider/eslint-config",
+    "version": "1.1.0",
+    "keywords": [
+        "useinsider",
+        "eslint",
+        "eslint-config"
+    ],
     "author": "Sahin Deniz <sahin.deniz@useinsider.com>",
     "license": "MIT",
-    "version": "1.0.1-beta.7",
     "packageManager": "pnpm@8.11.0",
     "scripts": {
-        "lint": "eslint --ext .js,.cjs ./",
-        "lint:fix": "pnpm lint --fix"
+        "lint": "eslint ./",
+        "lint:ci": "pnpm lint --quiet",
+        "lint:fix": "pnpm lint --fix",
+        "release": "semantic-release -e semantic-release-monorepo"
     },
-    "homepage": "https://github.com/useinsider/eslint-config#readme",
+    "homepage": "https://github.com/useinsider/config#readme",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/useinsider/eslint-config.git"
+        "url": "git+https://github.com/useinsider/config.git"
     },
     "bugs": {
-        "url": "https://github.com/useinsider/eslint-config/issues"
+        "url": "https://github.com/useinsider/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/**/*"
@@ -44,7 +52,9 @@
         "@semantic-release/git": "10.0.1",
         "@types/eslint": "8.44.8",
         "@types/node": "20.10.2",
-        "semantic-release": "22.0.8"
+        "@useinsider/release-config": "workspace:*",
+        "semantic-release": "19.0.5",
+        "semantic-release-monorepo": "7.0.5"
     },
     "optionalDependencies": {
         "@rushstack/eslint-patch": ">=1.6.0",

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}

@@ -13,7 +13,13 @@ module.exports = {
         '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',
@@ -62,6 +68,7 @@ module.exports = {
         }],
         'no-invalid-regexp': ['error'],
         'no-iterator': ['error'],
+        'no-mixed-operators': 'off',
         'no-multi-str': ['error'],
         'no-native-reassign': 'error',
         'no-nested-ternary': ['error'],
@@ -120,18 +127,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 +151,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

@@ -24,6 +24,10 @@ module.exports = {
         '@stylistic/implicit-arrow-linebreak': ['error', 'beside'],
         '@stylistic/indent': ['error', 4, {
             SwitchCase: 1,
+            ignoredNodes: [
+                'PropertyDefinition[decorators]',
+                'TSUnionType',
+            ],
         }],
         '@stylistic/key-spacing': ['error'],
         '@stylistic/keyword-spacing': ['error'],
@@ -53,6 +57,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/rules/typescript.cjs

@@ -24,13 +24,7 @@ module.exports = {
         'no-useless-constructor': 'off',
         '@typescript-eslint/no-useless-constructor': 'error',
         '@typescript-eslint/array-type': ['error', { default: 'array', readonly: 'array' }],
-        '@typescript-eslint/indent': ['error', 4, {
-            SwitchCase: 1,
-            ignoredNodes: [
-                'PropertyDefinition[decorators]',
-                'TSUnionType',
-            ],
-        }],
+        '@typescript-eslint/indent': 'off',
         semi: 'off',
         '@typescript-eslint/semi': ['error', 'always'],
         '@typescript-eslint/no-misused-promises': ['error', {
@@ -42,9 +36,5 @@ module.exports = {
         '@typescript-eslint/lines-between-class-members': ['error', 'always', {
             exceptAfterSingleLine: true,
         }],
-
-        // TODO enable after SD-80950
-        '@typescript-eslint/no-empty-function': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
     },
 };