prettier-config

Reusable Prettier config with a parallel Oxfmt export for migrations.

Install

pnpm add --save-dev --save-exact @shelf/prettier-config

Legacy Prettier Usage

Keep using the package root while a repo still formats through Prettier:

{
  "prettier": "@shelf/prettier-config"
}

The legacy Prettier config stays published at the package root for non-migrated repos.

Oxfmt Usage

For migrated repos, add a local oxfmt.config.ts and import the shared config from @shelf/prettier-config/oxfmt:

import baseConfig, {
  recommendedIgnorePatterns,
} from '@shelf/prettier-config/oxfmt';

export default {
  ...baseConfig,
  ignorePatterns: [...recommendedIgnorePatterns],
};

Shared Oxfmt Config

{
  printWidth: 100,
  singleQuote: true,
  bracketSpacing: false,
  trailingComma: 'es5',
  arrowParens: 'avoid',
  sortPackageJson: false,
}

recommendedIgnorePatterns starts intentionally small:

['coverage/**']

Repo-specific ignore rules should stay local in each repo's oxfmt.config.ts.

Migration Guide

The staged Oxfmt migration guide/prompt/skill lives in the context repository under docs/oxfmt-migration.md.

How to release a new version

Bump the version on the same branch that contains the changes you want to publish:

pnpm version major|minor|patch|x.y.z

Use major, minor, patch, a prerelease increment, or an exact x.y.z version.

pnpm version creates the version commit automatically. Push the branch, open a PR to master, and merge it. After the merge, centralized CircleCI publishes the new version to npm using OIDC.

License

MIT © Shelf