@kitschpatrol/eslint-config

v5.0.5

Published

10 days ago

ESLint configuration for @kitschpatrol/shared-config.

Downloads

622

0High
0Medium
0Low

kitschpatrol

shared-config eslint-config eslint cli kpi kpi-eslint

@kitschpatrol/eslint-config

ESLint configuration for @kitschpatrol/shared-config.

Overview

It's a shared ESLint config, plus a command-line tool kpi-eslint to perform ESLint-related project initialization, linting, and fixing.

[!IMPORTANT]
You can use this package on its own, but it's recommended to use @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, which also automatically invokes the command line functionality in this package via its kpi command

Setup

To use just this ESLint config in isolation:

Install the .npmrc in your project root. This is required for correct PNPM behavior:
```
pnpm dlx @kitschpatrol/repo-config init
```
Install and initialize the required TypeScript tsconfig.json configuration in your project root:
```
pnpm add -D @kitschpatrol/typescript-config
pnpm dlx @kitschpatrol/typescript-config init
```
Add the package:
```
pnpm add -D @kitschpatrol/eslint-config
```
Add the starter eslint.config.ts config files to your project root, and add any overrides you'd like:
```
pnpm exec eslint-kpi init
```

Usage

The ESLint binary should be picked up automatically by VS Code plugins.

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:

{
  "scripts": {
    "lint": "eslint-config lint",
    "fix": "eslint-config fix"
  }
}

CLI

Command: `kpi-eslint`

Kitschpatrol's ESLint shared configuration tools.

This section lists top-level commands for kpi-eslint.

Usage:

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. |