readme.md

@kitschpatrol/prettier-config

Prettier configuration for @kitschpatrol/shared-config.

Overview

It's a shared Prettier config.

See @kitschpatrol/shared-config for the recommended single-package approach.

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 prettier-config --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": "prettier-config --check"
  "format": "prettier-config --fix"
}

You might need to pass certain plugins in explicitly. The shared-config --fix and shared-config --lint scripts take care of this for you.

CLI

Command: prettier-config

Prettier configuration for @kitschpatrol/shared-config.

Usage:

prettier-config [<file|glob> ...]

Option	Alias	Argument	Description
--check	-c		Check for and report issues. Same as prettier-config.
--fix	-f		Fix all auto-fixable issues, and report the un-fixable.
--init	-i		Initialize by copying starter config files to your project root.
--print-config	-p	<path>	Print the effective configuration at a certain path.
--help	-h		Print this help info.
--version	-v		Print the package version.

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.

License

MIT © Eric Mika