@pplancq/prettier-config

This package provides pplancq prettier as an extensible shared config.

Usage

We export three Prettier configurations for your usage.

Install

npm install --save-dev @pplancq/prettier-config

Prettier config

Use with command to enable the default configuration.

npx init-prettier-config

@pplancq/prettier-config

This is the default configuration. To use, add "prettier": "@pplancq/prettier-config" to your package.json.

⚠️ Breaking Change: ESM Only from v2

As of version 2.x, this package is ESM-only. CommonJS (require) is no longer supported.

Migration from CommonJS to ESM

Old (CommonJS) usage:

// .prettierrc.js or prettier.config.js
module.exports = require("@pplancq/prettier-config");

New (ESM) usage:

// prettier.config.mjs (or prettier.config.js when using "type": "module")
import defaultConfig from "@pplancq/prettier-config";

export default {
  ...defaultConfig,
};

If you are using a .js config file, ensure your environment supports ESM (e.g., Node.js >= 18, or set "type": "module" in your package.json).

Migration from v3 to v4

Version 4 aligns the shared config with Prettier's default recommendations. The following options are no longer overridden:

• singleQuote: previously set to true, now uses Prettier's default (false).
• arrowParens: previously set to "avoid", now uses Prettier's default ("always").

As a result, strings will be formatted with double quotes and arrow functions with a single argument will include parentheses.

YAML formatting

This preset includes prettier-plugin-yaml, registered last so it takes precedence over any other YAML formatters. It formats *.yaml, *.yml, and YAML front matter files.

The plugin adds extra YAML options. This preset keeps them neutral to stay close to Prettier’s built-in YAML output and limit reformatting across consumer projects:

| Option | Value | Description | | --------------------- | ----------- | ---------------------------------------------------------------- | | yamlQuoteKeys | false | Only quote mapping keys that require quoting. | | yamlQuoteValues | false | Only quote string values that require quoting. | | yamlCollectionStyle | undefined | Use Prettier’s default heuristics for block or flow collections. | | yamlBlockStyle | undefined | Use Prettier’s default heuristics for multi-line string blocks. |

You can override these values in your own Prettier config if needed.

How to migrate

After upgrading, run Prettier on your codebase to apply the new formatting:

npx prettier --write .