anthony-j-castro / prettier-config

Reusable Prettier config for projects by @anthony-j-castro.

@anthony-j-castro/prettier-config

Reusable Prettier config for projects by @anthony-j-castro.

Installation

To install the latest version as a dependency of a project:

npm install --save-dev "https://github.com/anthony-j-castro/prettier-config.git#semver:1.0.0"

Then, copy and paste the config name as a string in a new .prettierrc.json file:

"@anthony-j-castro/prettier-config"

Important

In order to override or extend the shared configuration, you must use a .prettierrc.js file instead:

const prettierConfig = require("@anthony-j-castro/prettier-config");

module.exports = {
  ...prettierConfig,
  // Add or overwrite properties here
};

See more in the documentation.

Releasing a new version

This repo uses semantic-release to automatically create and tag new versions.

To release a new version:

1. Navigate to the "Create release" workflow.
2. Click on the "Run workflow" dropdown, ensure the "Run with dry-run flag" option is checked, and click "Run workflow".
3. Review the proposed version number and release notes in the workflow logs.
4. If everything is correct, repeat steps 1 and 2 but uncheck the "Run with dry-run flag" option.