Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.12 KB

README.md

File metadata and controls

53 lines (41 loc) · 2.12 KB
Raw

code style - Prettier

About

This sub-package hosts the Prettier configuration.

The following versions are available (based on Prettier version):

  • 1.16.x - @nationalbankbelgium/code-style/prettier/1.16.x
  • 1.17.x - @nationalbankbelgium/code-style/prettier/1.17.x
  • 1.18.x - @nationalbankbelgium/code-style/prettier/1.18.x
  • 1.19.x - @nationalbankbelgium/code-style/prettier/1.19.x
  • 2.0.x - @nationalbankbelgium/code-style/prettier/2.0.x
  • 2.1.x - @nationalbankbelgium/code-style/prettier/2.1.x
  • 2.2.x - @nationalbankbelgium/code-style/prettier/2.2.x
  • 2.3.x - @nationalbankbelgium/code-style/prettier/2.3.x
  • 2.4.x - @nationalbankbelgium/code-style/prettier/2.4.x
  • 2.5.x - @nationalbankbelgium/code-style/prettier/2.5.x
  • 2.6.x - @nationalbankbelgium/code-style/prettier/2.6.x
  • 2.7.x - @nationalbankbelgium/code-style/prettier/2.7.x
  • 2.8.x - @nationalbankbelgium/code-style/prettier/2.8.x
  • 3.0.x - @nationalbankbelgium/code-style/prettier/3.0.x
  • 3.1.x - @nationalbankbelgium/code-style/prettier/3.1.x

Usage

Create a .prettierrc.js file and copy the following content inside:

module.exports = require("@nationalbankbelgium/code-style/prettier/3.1.x");

Recommended Additional Configs

In case you are also using TSLint as linter for your codebase, either with the config provided by code style - TSLint or with your own configuration, it is highly recommended to add an additional TSLint configuration preset: tslint-config-prettier to avoid conflicts with TSLint regarding some formatting related rules.

So make sure to adapt your tslint.json as follows:

{
	"extends": ["any tslint preset config", "tslint-config-prettier"],
	"rules": {
		// your rules
	}
}

IMPORTANT: notice that the tslint-config-prettier preset is used at the end of the extends list. The reason for this is that such preset overrides any formatting TSLint rule that was enabled by the precedent presets that may conflict with Prettier.