feat(eslint-config)!: split config packages (#50)

viamrobotics · Dec 3, 2024 · e7d663f · e7d663f
1 parent ff06fba
commit e7d663f
Show file tree

Hide file tree

Showing 15 changed files with 179 additions and 76 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -10,4 +10,26 @@ module.exports = {
   env: {
     node: true,
   },
+  overrides: [
+    {
+      files: [
+        'packages/eslint-config/**/*.js',
+        'packages/eslint-config-svelte/**/*.js',
+      ],
+      parserOptions: {
+        sourceType: 'script',
+      },
+      env: {
+        commonjs: true,
+      },
+      rules: {
+        '@typescript-eslint/no-require-imports': 'off',
+        '@typescript-eslint/no-unsafe-member-access': 'off',
+        '@typescript-eslint/no-unsafe-call': 'off',
+        '@typescript-eslint/no-unsafe-assignment': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        'unicorn/prefer-module': 'off',
+      },
+    },
+  ],
 };
diff --git a/README.md b/README.md
@@ -4,18 +4,26 @@ Shared configuration for JavaScript and TypeScript tools.
 
 ## Libraries
 
-| Tool                          | NPM Module                        | Version                                   |
-| ----------------------------- | --------------------------------- | ----------------------------------------- |
-| [ESLint][eslint docs]         | `@viamrobotics/eslint-config`     | [![eslint version][]][eslint npm]         |
-| [Prettier][prettier docs]     | `@viamrobotics/prettier-config`   | [![prettier version][]][prettier npm]     |
-| [TypeScript][typescript docs] | `@viamrobotics/typescript-config` | [![typescript version][]][typescript npm] |
+| Tool                                      | NPM Module                             | Version                                             |
+| ----------------------------------------- | -------------------------------------- | --------------------------------------------------- |
+| [ESLint][eslint docs]                     | `@viamrobotics/eslint-config`          | [![eslint version][]][eslint npm]                   |
+| [ESLint + Svelte][eslint-svelte docs]     | `@viamrobotics/eslint-config-svelte`   | [![eslint-svelte version][]][eslint-svelte npm]     |
+| [Prettier][prettier docs]                 | `@viamrobotics/prettier-config`        | [![prettier version][]][prettier npm]               |
+| [Prettier + Svelte][prettier-svelte docs] | `@viamrobotics/prettier-config-svelte` | [![prettier-svelte version][]][prettier-svelte npm] |
+| [TypeScript][typescript docs]             | `@viamrobotics/typescript-config`      | [![typescript version][]][typescript npm]           |
 
 [eslint docs]: ./packages/eslint-config
 [eslint npm]: https://www.npmjs.com/package/@viamrobotics/eslint-config
 [eslint version]: https://img.shields.io/npm/v/@viamrobotics/eslint-config?style=flat-square
+[eslint-svelte docs]: ./packages/eslint-config-svelte
+[eslint-svelte npm]: https://www.npmjs.com/package/@viamrobotics/eslint-config-svelte
+[eslint-svelte version]: https://img.shields.io/npm/v/@viamrobotics/eslint-config-svelte?style=flat-square
 [prettier docs]: ./packages/prettier-config
 [prettier npm]: https://www.npmjs.com/package/@viamrobotics/prettier-config
 [prettier version]: https://img.shields.io/npm/v/@viamrobotics/prettier-config?style=flat-square
+[prettier-svelte docs]: ./packages/prettier-config-svelte
+[prettier-svelte npm]: https://www.npmjs.com/package/@viamrobotics/prettier-config-svelte
+[prettier-svelte version]: https://img.shields.io/npm/v/@viamrobotics/prettier-config-svelte?style=flat-square
 [typescript docs]: ./packages/typescript-config
 [typescript npm]: https://www.npmjs.com/package/@viamrobotics/typescript-config
 [typescript version]: https://img.shields.io/npm/v/@viamrobotics/typescript-config?style=flat-square

diff --git a/packages/eslint-config-svelte/.npmignore b/packages/eslint-config-svelte/.npmignore
@@ -0,0 +1,2 @@
+tsconfig.json
+*.tsbuildinfo
diff --git a/packages/eslint-config-svelte/README.md b/packages/eslint-config-svelte/README.md
@@ -0,0 +1,45 @@
+# Viam's ESLint Config for Svelte
+
+This module contains [Viam][]'s shared [ESLint][] configurations for ESLint v8 in [Svelte][] projects.
+
+[viam]: https://www.viam.com/
+[eslint]: https://eslint.org/
+[svelte]: https://svelte.dev/
+
+## Base config
+
+Extend the [config](./eslint-config-svelte.js) in `.eslintrc.cjs`.
+
+```shell
+pnpm add --save-dev \
+  eslint@^8.56.0 \
+  @viamrobotics/eslint-config-svelte \
+  @typescript-eslint/parser \
+  @typescript-eslint/eslint-plugin \
+  eslint-config-prettier \
+  eslint-plugin-jest-dom \
+  eslint-plugin-simple-import-sort \
+  eslint-plugin-svelte \
+  eslint-plugin-tailwindcss \
+  eslint-plugin-testing-library \
+  eslint-plugin-unicorn \
+  eslint-plugin-vitest
+```
+
+```js
+// .eslintrc.cjs
+'use strict';
+
+module.exports = {
+  root: true,
+  extends: ['@viamrobotics/eslint-config-svelte'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    projectService: true,
+  },
+};
+```
+
+## Non-Svelte projects
+
+See [@viamrobotics/eslint-config](../eslint-config/)
diff --git a/packages/eslint-config/svelte.cjs → ...int-config-svelte/eslint-config-svelte.js b/packages/eslint-config/svelte.cjs → ...int-config-svelte/eslint-config-svelte.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const baseConfig = require('./base.cjs');
+const baseConfig = require('@viamrobotics/eslint-config');
 
 module.exports = {
   ...baseConfig,
@@ -11,6 +11,12 @@ module.exports = {
     'plugin:svelte/prettier',
   ],
   settings: {
+    svelte: {
+      ignoreWarnings: [
+        '@typescript-eslint/no-unsafe-assignment',
+        '@typescript-eslint/no-unsafe-member-access',
+      ],
+    },
     tailwindcss: {
       callees: ['classnames', 'cx'],
       classRegex: '^(?:class|cx)$',
@@ -29,6 +35,8 @@ module.exports = {
         parser: '@typescript-eslint/parser',
       },
       rules: {
+        // Redundant with `svelte-check` and build
+        'svelte/valid-compile': 'off',
         // Allows us to set option props to `undefined` by default
         'no-undef-init': 'off',
       },

diff --git a/packages/eslint-config-svelte/package.json b/packages/eslint-config-svelte/package.json
@@ -0,0 +1,46 @@
+{
+  "name": "@viamrobotics/eslint-config-svelte",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.8.0",
+  "description": "ESLint configuration for Svelte projects at Viam.",
+  "type": "commonjs",
+  "main": "./eslint-config-svelte.js",
+  "types": "./dist/eslint-config-svelte.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/eslint-config-svelte.d.ts",
+      "default": "./eslint-config-svelte.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/viamrobotics/js-config.git",
+    "directory": "packages/eslint-config-svelte"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "svelte"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@viamrobotics/eslint-config": "workspace:*"
+  },
+  "peerDependencies": {
+    "@typescript-eslint/eslint-plugin": ">=6 <9",
+    "@typescript-eslint/parser": ">=6 <9",
+    "eslint": ">=8 <9",
+    "eslint-config-prettier": ">=9 <10",
+    "eslint-plugin-jest-dom": ">=5 <6",
+    "eslint-plugin-simple-import-sort": ">=12 <13",
+    "eslint-plugin-svelte": ">=2 <3",
+    "eslint-plugin-tailwindcss": ">=3 <4",
+    "eslint-plugin-testing-library": ">=6 <8",
+    "eslint-plugin-unicorn": ">=47 <57",
+    "eslint-plugin-vitest": ">=0.5 <0.6",
+    "typescript": ">=5 <6",
+    "vitest": "*"
+  }
+}
diff --git a/packages/eslint-config-svelte/tsconfig.json b/packages/eslint-config-svelte/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "extends": "@viamrobotics/typescript-config/base.json",
+  "compilerOptions": {
+    "types": ["node"],
+    "composite": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist"
+  },
+  "references": [{ "path": "../eslint-config" }],
+  "include": ["*.js"]
+}
diff --git a/packages/eslint-config/.npmignore b/packages/eslint-config/.npmignore
@@ -0,0 +1,2 @@
+tsconfig.json
+*.tsbuildinfo
diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md
@@ -1,4 +1,4 @@
-# Shared ESLint Config for Viam
+# Viam's ESLint Config
 
 This module contains [Viam][]'s shared [ESLint][] configurations for ESLint v8.
 
@@ -7,15 +7,16 @@ This module contains [Viam][]'s shared [ESLint][] configurations for ESLint v8.
 
 ## Base config
 
-Use the [base config](./base.cjs) for vanilla JavaScript / TypeScript projects. Be sure to add your `tsconfig.json` files to `parserOptions.project` and `settings['import/resolver'].typescript.project`.
+Extend the [config](./eslint-config.js) in `.eslintrc.cjs`.
 
 ```shell
 pnpm add --save-dev \
+  eslint@^8.56.0 \
   @viamrobotics/eslint-config \
   @typescript-eslint/parser \
   @typescript-eslint/eslint-plugin \
-  eslint \
   eslint-config-prettier \
+  eslint-plugin-simple-import-sort \
   eslint-plugin-unicorn \
   eslint-plugin-vitest
 ```
@@ -28,39 +29,12 @@ module.exports = {
   root: true,
   extends: ['@viamrobotics/eslint-config'],
   parserOptions: {
-    project: ['./tsconfig.json'],
+    tsconfigRootDir: __dirname,
+    projectService: true,
   },
 };
 ```
 
 ## Svelte config
 
-Use the [Svelte config](./svelte.cjs) for Svelte projects.
-
-```shell
-pnpm add --save-dev \
-  @viamrobotics/eslint-config \
-  @typescript-eslint/parser \
-  @typescript-eslint/eslint-plugin \
-  eslint \
-  eslint-config-prettier \
-  eslint-plugin-jest-dom \
-  eslint-plugin-svelte \
-  eslint-plugin-tailwindcss \
-  eslint-plugin-testing-library \
-  eslint-plugin-unicorn \
-  eslint-plugin-vitest
-```
-
-```js
-// .eslintrc.cjs
-'use strict';
-
-module.exports = {
-  root: true,
-  extends: ['@viamrobotics/eslint-config/svelte'],
-  parserOptions: {
-    project: ['./tsconfig.json'],
-  },
-};
-```
+See [@viamrobotics/eslint-config-svelte](../eslint-config-svelte/)
diff --git a/packages/eslint-config/base.cjs → packages/eslint-config/eslint-config.js b/packages/eslint-config/base.cjs → packages/eslint-config/eslint-config.js
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -4,28 +4,15 @@
     "access": "public",
     "provenance": true
   },
-  "version": "0.7.1",
-  "description": "Common ESLint configuration for Viam projects.",
-  "files": [
-    "**/*",
-    "!tsconfig.json"
-  ],
-  "types": "dist/base.d.cts",
-  "typesVersions": {
-    "*": {
-      "svelte": [
-        "dist/svelte.d.cts"
-      ]
-    }
-  },
+  "version": "0.8.0",
+  "description": "ESLint configuration for projects at Viam.",
+  "type": "commonjs",
+  "main": "./eslint-config.js",
+  "types": "./dist/eslint-config.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/base.d.cts",
-      "default": "./base.cjs"
-    },
-    "./svelte": {
-      "types": "./dist/svelte.d.cts",
-      "default": "./svelte.cjs"
+      "types": "./dist/eslint-config.d.ts",
+      "default": "./eslint-config.js"
     }
   },
   "repository": {
@@ -43,28 +30,17 @@
     "@typescript-eslint/parser": ">=6 <9",
     "eslint": ">=8 <9",
     "eslint-config-prettier": ">=9 <10",
-    "eslint-plugin-jest-dom": ">=5 <6",
     "eslint-plugin-simple-import-sort": ">=12 <13",
-    "eslint-plugin-svelte": ">=2 <3",
-    "eslint-plugin-tailwindcss": ">=3 <4",
-    "eslint-plugin-testing-library": ">=6 <8",
     "eslint-plugin-unicorn": ">=47 <57",
-    "eslint-plugin-vitest": ">=0.5 <0.6"
+    "eslint-plugin-vitest": ">=0.5 <0.6",
+    "typescript": ">=5 <6",
+    "vitest": "*"
   },
   "peerDependenciesMeta": {
-    "eslint-plugin-jest-dom": {
-      "optional": true
-    },
-    "eslint-plugin-svelte": {
-      "optional": true
-    },
-    "eslint-plugin-tailwindcss": {
-      "optional": true
-    },
-    "eslint-plugin-testing-library": {
+    "eslint-plugin-vitest": {
       "optional": true
     },
-    "eslint-plugin-vitest": {
+    "vitest": {
       "optional": true
     }
   }

diff --git a/packages/eslint-config/tsconfig.json b/packages/eslint-config/tsconfig.json
@@ -7,5 +7,5 @@
     "emitDeclarationOnly": true,
     "outDir": "dist"
   },
-  "include": ["**/*.cjs"]
+  "include": ["*.js"]
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/peers.spec.ts b/tests/peers.spec.ts
@@ -14,6 +14,7 @@ interface PackageJSON {
 const repo = path.join(url.fileURLToPath(import.meta.url), '../..');
 const packages = [
   'eslint-config',
+  'eslint-config-svelte',
   'prettier-config',
   'prettier-config-svelte',
   'typescript-config',

diff --git a/tsconfig.json b/tsconfig.json
@@ -6,6 +6,7 @@
   },
   "references": [
     { "path": "./packages/eslint-config" },
+    { "path": "./packages/eslint-config-svelte" },
     { "path": "./packages/prettier-config" },
     { "path": "./packages/prettier-config-svelte" }
   ],