@kitschpatrol/eslint-config 4.7.12 → 5.0.0

package/init/.vscode/settings.json

@@ -1,18 +1,28 @@
 {
 	"editor.codeActionsOnSave": {
-		"source.fixAll": "explicit"
+		"source.fixAll": "explicit",
+		"source.organizeImports": "never"
 	},
 	"eslint.enable": true,
+	"eslint.runtime": "node",
 	"eslint.validate": [
 		"astro",
 		"html",
 		"javascript",
 		"javascriptreact",
+		"json",
+		"json5",
+		"jsonc",
 		"markdown",
 		"mdx",
 		"svelte",
+		"toml",
 		"typescript",
-		"typescriptreact"
+		"typescriptreact",
+		"xml",
+		"yaml"
 	],
-	"typescript.tsdk": "node_modules/typescript/lib"
+	"eslint.useFlatConfig": true,
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"typescript.enablePromptUseWorkspaceTsdk": true
 }

package/init/eslint.config.ts

@@ -0,0 +1,9 @@
+import { eslintConfig } from '@kitschpatrol/eslint-config'
+
+export default eslintConfig({
+	// Enable as needed:
+	// astro: true,
+	// react: true,
+	// svelte: true,
+	// type: 'lib',
+})

package/license.txt

@@ -1,6 +1,9 @@
 MIT License
 
-Copyright (c) 2023-2024 Eric Mika
+Copyright (c) 2023-2025 Eric Mika
+
+Portions of this configuration are based on the MIT-licensed
+"@antfu/eslint-config" project by Anthony Fu.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,67 +1,108 @@
 {
   "name": "@kitschpatrol/eslint-config",
-  "version": "4.7.12",
-  "type": "module",
+  "version": "5.0.0",
   "description": "ESLint configuration for @kitschpatrol/shared-config.",
+  "keywords": [
+    "shared-config",
+    "eslint-config",
+    "eslint",
+    "cli",
+    "kpi",
+    "kpi-eslint"
+  ],
+  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kitschpatrol/shared-config/cli.git",
     "directory": "packages/eslint-config"
   },
-  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
+  "license": "MIT",
   "author": {
     "name": "Eric Mika",
     "email": "eric@ericmika.com",
     "url": "https://ericmika.com"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=18.0.0",
-    "pnpm": ">=8.0.0"
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
-    "eslint-config": "bin/cli.js"
+    "kpi-eslint": "bin/cli.js"
   },
-  "main": "./eslint.config.cjs",
   "files": [
     "bin/*",
+    "dist/*",
     "init/*"
   ],
-  "keywords": [
-    "shared-config",
-    "eslint-config",
-    "eslint",
-    "cli"
-  ],
-  "peerDependencies": {
-    "eslint": "^8.57.1"
-  },
   "dependencies": {
-    "@html-eslint/eslint-plugin": "^0.26.0",
-    "@html-eslint/parser": "^0.26.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
+    "@eslint-react/eslint-plugin": "^1.26.2",
+    "@html-eslint/eslint-plugin": "^0.34.0",
+    "@html-eslint/parser": "^0.34.0",
     "@pinojs/json-colorizer": "^4.0.0",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "astro-eslint-parser": "^1.0.3",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-xo": "^0.45.0",
-    "eslint-config-xo-typescript": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.23.0",
+    "@typescript-eslint/parser": "^8.23.0",
+    "@vitest/eslint-plugin": "^1.1.25",
+    "astro-eslint-parser": "^1.2.1",
+    "eslint": "^9.19.0",
+    "eslint-config-flat-gitignore": "^2.0.0",
+    "eslint-flat-config-utils": "^2.0.1",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-mdx": "^3.1.5",
     "eslint-plugin-astro": "^1.3.1",
+    "eslint-plugin-depend": "^0.12.0",
     "eslint-plugin-html": "^8.1.2",
+    "eslint-plugin-import-x": "^4.6.1",
+    "eslint-plugin-jsdoc": "^50.6.3",
+    "eslint-plugin-jsonc": "^2.19.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-mdx": "^3.1.5",
-    "eslint-plugin-n": "^17.13.1",
-    "eslint-plugin-perfectionist": "^3.9.1",
-    "eslint-plugin-svelte": "^2.46.0",
-    "eslint-plugin-unicorn": "^55.0.0",
-    "execa": "^8.0.1",
-    "fs-extra": "^11.2.0"
+    "eslint-plugin-n": "^17.15.1",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-package-json": "^0.23.0",
+    "eslint-plugin-perfectionist": "^4.8.0",
+    "eslint-plugin-regexp": "^2.7.0",
+    "eslint-plugin-svelte": "^2.46.1",
+    "eslint-plugin-toml": "^0.12.0",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "eslint-plugin-yml": "^1.16.0",
+    "execa": "^9.5.2",
+    "fs-extra": "^11.3.0",
+    "globals": "^15.14.0",
+    "jsonc-eslint-parser": "^2.4.0",
+    "local-pkg": "^1.0.0",
+    "svelte-eslint-parser": "^0.43.0",
+    "toml-eslint-parser": "^0.10.0",
+    "yaml-eslint-parser": "^1.2.3"
+  },
+  "devDependencies": {
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/eslint-plugin-jsx-a11y": "^6.10.0",
+    "dot-prop": "^9.0.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-config-xo-typescript": "^7.0.0",
+    "eslint-typegen": "^1.0.0",
+    "prettier": "^3.4.2",
+    "svelte": "^5.19.9",
+    "tsup": "^8.3.6"
+  },
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "../../scripts/build.ts && pnpm mdat readme",
-    "cli": "node ./bin/cli.js"
+    "build": "pnpm run typegen && tsup --format esm --clean --dts && ../../scripts/build.ts",
+    "cli": "node ./bin/cli.js",
+    "inspect": "npx @eslint/config-inspector --config ./init/eslint.config.ts",
+    "presetgen": "tsx scripts/presetgen.ts && pnpm run typegen && kpi fix",
+    "typegen": "tsx scripts/typegen.ts"
   }
 }

package/readme.md

@@ -21,9 +21,17 @@
 
 ## Overview
 
-It's a shared [ESLint](https://eslint.org) config.
+It's a shared [ESLint](https://eslint.org) config, plus a command-line tool `kpi-eslint` to perform ESLint-related project initialization, linting, and fixing.
 
-**See [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) for the recommended single-package approach.**
+<!-- recommendation -->
+
+> [!Important]
+>
+> **You can use this package on its own, but it's recommended to use [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) instead for a single-dependency and single-package approach to linting and fixing your project.**
+>
+> This package is included as a dependency in [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `kpi` command
+
+<!-- /recommendation -->
 
 ## Setup
 
@@ -32,19 +40,26 @@ To use just this ESLint config in isolation:
 1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
 
    ```sh
-   pnpm dlx @kitschpatrol/repo-config --init
+   pnpm dlx @kitschpatrol/repo-config init
+   ```
+
+2. Install and initialize the required TypeScript `tsconfig.json` configuration in your project root:
+
+   ```sh
+   pnpm add -D @kitschpatrol/typescript-config
+   pnpm dlx @kitschpatrol/typescript-config init
    ```
 
-2. Add the package:
+3. Add the package:
 
    ```sh
    pnpm add -D @kitschpatrol/eslint-config
    ```
 
-3. Add the starter `.eslintrc.cjs` config and `.eslintignore` files to your project root, and add any overrides you'd like:
+4. Add the starter `eslint.config.ts` config files to your project root, and add any overrides you'd like:
 
    ```sh
-   pnpm exec eslint-config --init
+   pnpm exec eslint-kpi init
    ```
 
 ## Usage
@@ -56,9 +71,11 @@ You can call it directly, or use the script bundled with the config.
 Integrate with your `package.json` scripts as you see fit, for example:
 
 ```json
-"scripts": {
-  "lint": "eslint-config --check"
-  "fix": "eslint-config --fix"
+{
+  "scripts": {
+    "lint": "eslint-config lint",
+    "fix": "eslint-config fix"
+  }
 }
 ```
 
@@ -66,34 +83,120 @@ Integrate with your `package.json` scripts as you see fit, for example:
 
 <!-- cli-help -->
 
-#### Command: `eslint-config`
+#### Command: `kpi-eslint`
+
+Kitschpatrol's ESLint shared configuration tools.
+
+This section lists top-level commands for `kpi-eslint`.
+
+Usage:
+
+```txt
+kpi-eslint <command>
+```
+
+| Command        | Argument    | Description                                                                                                                                                               |
+| -------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `init`         |             | Initialize by copying starter config files to your project root.                                                                                                          |
+| `lint`         | `[files..]` | Lint your project with ESLint. Matches files below the current working directory by default.                                                                              |
+| `fix`          | `[files..]` | Fix your project with ESLint. Matches files below the current working directory by default.                                                                               |
+| `print-config` | `[file]`    | Print the effective ESLint configuration. Package-scoped by default, file-scoped if a file argument is provided. Use `@eslint/config-inspector` for a more detailed view. |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+_See the sections below for more information on each subcommand._
+
+#### Subcommand: `kpi-eslint init`
+
+Initialize by copying starter config files to your project root.
+
+Usage:
+
+```txt
+kpi-eslint init
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-eslint lint`
+
+Lint your project with ESLint. Matches files below the current working directory by default.
+
+Usage:
+
+```txt
+kpi-eslint lint [files..]
+```
+
+| Positional Argument | Description                    | Type    | Default |
+| ------------------- | ------------------------------ | ------- | ------- |
+| `files`             | Files or glob pattern to lint. | `array` | `"."`   |
 
-ESLint configuration for @kitschpatrol/shared-config.
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-eslint fix`
+
+Fix your project with ESLint. Matches files below the current working directory by default.
 
 Usage:
 
 ```txt
-eslint-config [<file|glob> ...]
+kpi-eslint fix [files..]
 ```
 
-| Option                   | Argument | Description                                                      |
-| ------------------------ | -------- | ---------------------------------------------------------------- |
-| `--check`<br>`-c`        |          | Check for and report issues. Same as `eslint-config`.            |
-| `--fix`<br>`-f`          |          | Fix all auto-fixable issues, and report the un-fixable.          |
-| `--init`<br>`-i`         |          | Initialize by copying starter config files to your project root. |
-| `--print-config`<br>`-p` | `<path>` | Print the effective configuration at a certain path.             |
-| `--help`<br>`-h`         |          | Print this help info.                                            |
-| `--version`<br>`-v`      |          | Print the package version.                                       |
+| Positional Argument | Description                   | Type    | Default |
+| ------------------- | ----------------------------- | ------- | ------- |
+| `files`             | Files or glob pattern to fix. | `array` | `"."`   |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-eslint print-config`
+
+Print the effective ESLint configuration. Package-scoped by default, file-scoped if a file argument is provided. Use `@eslint/config-inspector` for a more detailed view.
+
+Usage:
+
+```txt
+kpi-eslint print-config [file]
+```
+
+| Positional Argument | Description                 | Type     |
+| ------------------- | --------------------------- | -------- |
+| `file`              | File or glob pattern to TK. | `string` |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
 
 <!-- /cli-help -->
 
 ## Notes
 
-The whole flat file config thing is pending...
+Regrettably the `eslint-config init --location package` option is not supported due to ESLint 9's deprecation of support for putting configuration in `package.json`. See ESLint discussion thread [18131](https://github.com/eslint/eslint/discussions/18131).
+
+### Origins
+
+This config is a heavily modified variation on Anthony Fu's [@antfu/eslint-config](https://github.com/antfu/eslint-config). This package is a somewhat leaner approach intended to work with other tools wrapped behind a monolithic CLI instead of handling everything on its own. It mainly leverages the factory / type generation implementation from the original repo, which itself builds on Kevin Deng's [@sxzz/eslint-config](https://github.com/sxzz/eslint-config). See the [modification notes](./modification-notes.md) for more details on what's changed from Anthony's approach.
 
-ESLint does not inherit files and paths from `.gitignore`. Ignored paths must be specified in `.eslintignore`.
+### References
 
-This shared config will also initialize a `tsconfig.json` and a `tsconfig.eslint.json`. These should probably live in a separate configuration package, but they'll reside here for now.
+- [@antfu/eslint-config](https://github.com/antfu/eslint-config)
+- [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)
+- [linting-setup-using-eslint](https://chris.lu/web_development/tutorials/next-js-static-mdx-blog/linting-setup-using-eslint)
+- On [prefer-repository-shorthand](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/223)
 
 <!-- license -->