Dreams Prettier Config

A shareable configuration for prettier.

Installation

yarn add prettier @dreamstechnology/prettier-config-dreams --dev

Usage

There are multiple ways of loading the prettier preset in your project. It all depends on what kind of project it is.

Add it to your package.json file.

"prettier": "@dreamstechnology/prettier-config-dreams"

Add it to any of the following files and export a string.

• .prettierrc
• .prettierrc.yaml
• .prettierrc.yml
• .prettierrc.json

"@dreamstechnology/prettier-config-dreams"

Add it to any of the following files and export an object.

• prettier.config.js
• .prettierrc.js

module.exports = {
  ...require('@dreamstechnology/prettier-config-dreams'),
};

To run prettier on your project files you need to add prettier to the script section in your package.json file.

{
  "scripts": {
    "format-write": "prettier --write '{**/*,*}.{js,jsx,ts,tsx,css,json,md,yml}'"
  }
}

To check that all files are prettified you will need to add another script with the --check flag.

{
  "scripts": {
    "format-write": "prettier --write '{**/*,*}.{js,jsx,ts,tsx,css,json,md,yml}'",
    "format-check": "prettier --check '{**/*,*}.{js,jsx,ts,tsx,css,json,md,yml}'"
  }
}

This is useful in a CI environment where you want to check that all the commited code is prettified.

For example in a github action:

jobs:
  build:
    steps:
      - run: yarn format-check

Lefthook setup

If you want to integrate prettier with left hook you can use the following setup:

pre-commit:
  parallel: true
  commands:
    prettier:
      glob: '*.{js,jsx,ts,tsx,css,json,md,yml}'
      run: yarn prettier --write {staged_files} && git add {staged_files}

Release

The versioning for the package is handled by semantic-release which will automatically determine the next version number, generate the release notes and publish the package.