Skip to content

Latest commit

 

History

History
403 lines (269 loc) · 17.7 KB

readme.md

File metadata and controls

403 lines (269 loc) · 17.7 KB

🔬 @kitschpatrol/shared-config

NPM Package @kitschpatrol/shared-config License: MIT

A collection of shared configurations for various linters and formatting tools. All managed as a single dependency, and invoked via a single command.

Table of contents

Overview

This project attempts to consolidate most of the configuration and tooling shared by my open-source and internal TypeScript / Node based projects into a single dependency with a single CLI meta-command to lint and fix issues.

By installing @kitschpatrol/shared-config and then running kpi, you can run a half-dozen pre-configured code quality and linting tools in one shot. This spares you from cluttering your project's devDependencies with packages tangential to the task at hand.

If you don't plan to customize tool configurations, @kitschpatrol/shared-config init exposes an option to store references to each tool's shared configuration in your package.json instead of in files in your project root (at least where permitted by the tool). This can save a bit of file clutter in your project's root directory, at the expense of the immediate discoverability of the tools.

In addition, each tool exports a typed configuration factory function to simplify specifying and extending the default configuration.

The command name kpi might stand for "Kitschpatrol Project Inspector", or the more McKinseyan "Key Performance Indicators".

Tools

It takes care of dependencies, configuration, invocation, and reporting for the following tools:

  • ESLint (including Svelte, Astro, React, and TypeScript support — including type-checked rules)
  • Prettier (including a bunch of extra plugins)
  • Stylelint
  • TypeScript (including a shared TSConfig)
  • CSpell (bundled with a number of custom dictionaries, and a custom unused-word detector)
  • Case Police
  • Knip
  • VS Code (extension recommendations and extension settings)
  • Mdat (my markdown templating and expansion tool)
  • remarklint
  • Basic repo boilerplate (.npmrc, .gitignore, etc.)

Packages

This particular readme is for the @kitschpatrol/shared-config package, which depends on a number of tool-specific packages included in the kitschpatrol/shared-config monorepo on GitHub, each of which is documented in additional detail its respective readme.

Primary package

Sub-packages

Important

Any of these packages may be installed and run on their own via CLI if desired. However, in general, the idea is to use @kitschpatrol/shared-config to easily run them all simultaneously over a repo with a single command with options to either check or (where possible) fix problems, with output aggregated into a single report.

Running kpi <command> calls the same command across the entire collection of sub-packages.

So assuming you've installed @kitschpatrol/shared-config...

Running:

kpi init

Is the same as running:

kpi-cspell init
kpi-eslint init
kpi-knip init
kpi-mdat init
kpi-prettier init
kpi-remark init
kpi-repo init
kpi-stylelint init
kpi-typescript init

The top-level kpi command also takes care of some nuances in terms of which sub-packages implement which commands, and which subcommands take arguments.

Getting started

Dependencies

Node 22+ and pnpm 10+ are required. It might work with NPM and yarn, but I haven't tested it.

Installation

Quick start from scratch:

Bootstrap a new project and open in VS Code:

git init && pnpm init && pnpm pkg set type="module" && pnpm dlx @kitschpatrol/repo-config init && pnpm add -D @kitschpatrol/shared-config && pnpm kpi init --location package && pnpm i && code .

The --location package flag will put as much configuration in your package.json as possible instead of in discrete files in your project root. This saves some clutter but can make it clunkier to extend or customize configurations. At any point, you can call kpi init with or without a --location package or --location file flag to reinitialize your configuration files in one place ot he other to.

Quick add to an existing project:

This might overwrite certain config files, so commit first:

pnpm dlx @kitschpatrol/repo-config init && pnpm i && pnpm add -D @kitschpatrol/shared-config && pnpm kpi init --location package

Step-by-step:

  1. Install the requisite .npmrc:

    pnpm dlx @kitschpatrol/repo-config init

  2. Install the package:

    pnpm add -D @kitschpatrol/shared-config

  3. Add default config files for all the tools to your project root:

    pnpm kpi init

    Or, if you don't plan to customize tool configurations, you might want to put as much config as possible under tool-specific keys in 'package.json':

    pnpm kpi init --location package

  4. Add helper scripts to your package.json:

    These work a bit like npm-run-all to invoke all of the bundled tools.

    {
  "scripts": {
    "fix": "kpi fix",
    "lint": "kpi lint"
  }
}

  5. Set up GitHub action credentials (if desired)

    The GitHub actions included in @kitschpatrol/repo-config require permissions to create releases and update your repository metadata. You can add these through the GitHub website under the Settings → Secrets and variables → Actions page under the key PERSONAL_ACCESS_TOKEN, or with the GitHub CLI and a credential manager like 1Password CLI:

    gh secret set PERSONAL_ACCESS_TOKEN --app actions --body $(op read 'op://Personal/GitHub Mika/PERSONAL_ACCESS_TOKEN')

    See the @kitschpatrol/repo-config readme for more details.

Usage

Various VS Code plugins for the bundled tools should "just work".

To check / lint your entire project, after configuring the package.json as shown above:

pnpm run lint

To run all of the tools in a potentially destructive "fix" capacity:

pnpm run fix

CLI

Command: kpi

Run aggregated @kitschpatrol/shared-config commands.

This section lists top-level commands for kpi.

Usage:

kpi <command>
Command Argument Description
init Initialize configuration files for the entire suite of @kitschpatrol/shared-config tools. Will use option flags where possible if provided, but some of the invoked tools will ignore them.
lint [files..] Lint your project with multiple tools in one go. Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.
fix [files..] Fix your project with multiple tools in one go. Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.
print-config [file] Print aggregated tool configuration data. Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.
Option Description Type
--help
-h		 Show help boolean
--version
-v		 Show version number boolean

See the sections below for more information on each subcommand.

Subcommand: kpi init

Initialize configuration files for the entire suite of @kitschpatrol/shared-config tools. Will use option flags where possible if provided, but some of the invoked tools will ignore them.

Usage:

kpi init
Option Description Type Default
--location TK "file" "package" "file"
--help
-h		 Show help boolean
--version
-v		 Show version number boolean

Subcommand: kpi lint

Lint your project with multiple tools in one go. Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.

Usage:

kpi lint [files..]
Positional Argument Description Type Default
files Files or glob pattern to lint. array []
Option Description Type
--help
-h		 Show help boolean
--version
-v		 Show version number boolean

Subcommand: kpi fix

Fix your project with multiple tools in one go. Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.

Usage:

kpi fix [files..]
Positional Argument Description Type Default
files Files or glob pattern to fix. array []
Option Description Type
--help
-h		 Show help boolean
--version
-v		 Show version number boolean

Subcommand: kpi print-config

Print aggregated tool configuration data. Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.

Usage:

kpi print-config [file]
Positional Argument Description Type
file File or glob pattern to TK. string
Option Description Type
--help
-h		 Show help boolean
--version
-v		 Show version number boolean

Recall that the @kitschpatrol/shared-config package aggregates integration and invocation of the other tool-specific packages in this monorepo. Running a cli command on kpi effectively runs the same command against all the tool-specific packages.

Implementation notes

check vs lint

This project combines a mix of tools that regard their core task variously as "linting" or "checking" code and prose.

Across all the tools, I've chosen to use the term "lint" instead of "check" to refer to the read-only evaluation process.

Package architecture

Each package has a simple /src/cli.ts file which defines the behavior of its eponymous binary. The build step turns these into node "binary" scripts, providing default implementations where feasible.

The monorepo must be kept intact, as the sub-packages depend on scripts in the parent during build.

Hoisting caveats

The pnpm authors consider module hoisting harmful, and I tend to agree, but certain exceptions are carved out as necessary and accommodated via the .npmrc file included in @kitschpatrol/repo-config:

  • CSpell, remark, mdat, ESLint, and Prettier all need to be hoisted via public-hoist-pattern to be accessible in pnpm exec scripts and to VS Code plugins.

  • Even basic file-only packages like repo-config seem to need to be hoisted via for their bin scripts to be accessible via pnpm exec

  • In earlier version of pnpm, prettier and eslint packages were hoisted by default, but as of pnpm 10 this is no longer the case.

Development notes

The repo uses placeholders for the bin script for each tool to avoid circular dependency issues during pnpm install.

To tell git to ignore changes to the placeholders, run pnpm run bin-ignore.

For local development via pnpm, use file: dependency protocol instead of link:

Something to investigate: An approach to ignoring style rules in VS Code, and possibly migrate all style handling to eslint instead of prettier.

Serial run order:

  1. kpi-repo
  2. kpi-mdat
  3. kpi-typescript
  4. kpi-eslint
  5. kpi-stylelint
  6. kpi-cspell
  7. kpi-knip
  8. kpi-remark
  9. kpi-prettier

Background

Motivation

xo is really, really close to what I'm after here, but I wanted a few extra tools and preferred to use "first party" VS Code plugins where possible.

create-typescript-app is also excellent, and probably the best starting point for most people for most new projects. However, it does not take a "single top-level dependency" / "single unified CLI" approach.

antfu/eslint-config and @sxzz/eslint-config inspired the approach to ESLint integration.

Adjacent projects

License

MIT © Eric Mika