prettier-config

prettier-config is a curated prettier configuration that can be across our projects and can be used in your projects. Rather than add this all to a template, it is included as a package enabling updates to be pulled forward into consuming projects.

Installation

1. You'll first need to install Prettier:

npm install prettier --save-dev

2. Next, install prettier-config, run the following command:

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

Or:

pnpm add @kodehort/prettier-config -D

Usage

To use prettier-config, you need to extend it in your prettier configuration file. Here's an example prettier.config.js file

import { baseConfig } from '@kodehort/prettier-config'

/** @type {import("prettier").Config} */
export default {
  ...baseConfig,
  /** Add your project specific configurations here */
}

FAQs

Module type of the repository has an impact in the configuration file

If the package is defined with type module in the package.json file, you need to use the .js extension for the configuration file. This is because the import statement is not supported in CommonJS files.

{
  "type": "module"
}

Otherwise you can use the .mjs extension for the configuration file.