@kitschpatrol/prettier-config

Prettier configuration for @kitschpatrol/shared-config.

Overview

It's a shared Prettier config, plus a command-line tool kpi-prettier to perform Prettier-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 Prettier config in isolation:

1. Install the .npmrc in your project root. This is required for correct PNPM behavior:

   pnpm dlx @kitschpatrol/repo-config init

2. Add the package:

   pnpm add -D @kitschpatrol/prettier-config

3. Add the starter .prettierrc.js and .prettierignore files to your project root, and add any customizations you'd like:

   pnpm exec kpi-prettier init

Usage

The Prettier 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": "kpi-prettier lint",
    "fix": "kpi-prettier fix"
  }
}

You might need to pass certain plugins in explicitly if you're calling prettier directly. The kpi-prettier fix and kpi-prettier lint scripts take care of this for you.

Configuration

To create a prettier.config.js in your project root:

pnpm exec kpi-prettier init

(Note that this will delete the prettier property in your package.json!)

Or

To create a prettier property in package.json:

pnpm exec kpi-prettier init --location package

(Note that this will delete the prettier.config.js file in your project root!)

CLI

Command: kpi-prettier

Kitschpatrol's Prettier shared configuration tools.

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

Usage:

kpi-prettier <command>

| Command | Argument | Description | | -------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------- | | init | | Initialize by copying starter config files to your project root or to your package.json file. | | lint | [files..] | Check that files are formatted according to your Prettier configuration. Matches files below the current working directory by default. | | fix | [files..] | Format files according to your Prettier configuration. Matches files below the current working directory by default. | | print-config | | Print the effective Prettier configuration. Package-scoped.. Searches up to the root of a monorepo if necessary.. |

| 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-prettier init

Initialize by copying starter config files to your project root or to your package.json file.

Usage:

kpi-prettier init

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

Subcommand: kpi-prettier lint

Check that files are formatted according to your Prettier configuration. Matches files below the current working directory by default.

Usage:

kpi-prettier 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-prettier fix

Format files according to your Prettier configuration. Matches files below the current working directory by default.

Usage:

kpi-prettier 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-prettier print-config

Print the effective Prettier configuration. Package-scoped.. Searches up to the root of a monorepo if necessary..

Usage:

kpi-prettier print-config

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Ruby support

Ruby formatting Expects a global Ruby install >=2.7 via rbenv at ~/.rbenv/shims/ruby with the following gems:

• bundler
• prettier_print
• syntax_tree
• syntax_tree-haml
• syntax_tree-rbs

Note: Do not add plugins: ['prettier-plugin-ruby'] to the per-file scope, it must be global.

Tabs vs. spaces

Tabs are unambiguously preferred wherever the file format specification does not mandate spaces.

Note that despite widely-accepted FUD regarding JSON requiring spaces, the specification indicates otherwise. So we use tabs.

The reluctant exceptions are:

YAML

Spaces are required by the specification.

Markdown and MDX

Spaces are not technically required, but are specified in alignment with the Remark project's conclusions and to prevent fragility in YAML frontmatter. (TODO: Need 4 spaces instead of 2?)

License

MIT © Eric Mika