Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 950 Bytes

README.md

File metadata and controls

37 lines (25 loc) · 950 Bytes

prettier-config

npm version

This package provides a shared Prettier configuration.

Usage

  1. Install this package as a development dependency:

    # with npm
    npm install --save-dev @calblueprint/prettier-config
    
    # with yarn
    yarn add --dev @calblueprint/prettier-config
  2. Install peer dependencies:

    # with npm or yarn
    npx install-peerdeps --dev @calblueprint/prettier-config
  3. Use the shared Prettier config in your project's .prettierrc.js:

    module.exports = {
      ...require('@calblueprint/prettier-config'),
      // Add any overrides here
    };

    Note: you may need to remove or merge any other existing prettier config files.

  4. Test that the config is working by running npx prettier --check . in your project's root directory.