tslint-config-prettier

What is tslint-config-prettier?

The `tslint-config-prettier` package is a TSLint configuration that disables all rules that are unnecessary or might conflict with Prettier. This allows you to use TSLint for code quality checks while letting Prettier handle code formatting.

What are tslint-config-prettier's main functionalities?

Disable conflicting rules

By extending `tslint-config-prettier` in your TSLint configuration, you disable all TSLint rules that might conflict with Prettier, ensuring that the two tools work together seamlessly.

{
  "extends": [
    "tslint-config-prettier"
  ]
}

Integration with existing TSLint configurations

You can integrate `tslint-config-prettier` with your existing TSLint configurations. This example shows how to extend both `tslint:recommended` and `tslint-config-prettier` to use recommended TSLint rules while avoiding conflicts with Prettier.

{
  "extends": [
    "tslint:recommended",
    "tslint-config-prettier"
  ]
}

Other packages similar to tslint-config-prettier

eslint-config-prettier

`eslint-config-prettier` is an ESLint configuration that disables all rules that are unnecessary or might conflict with Prettier. It serves a similar purpose as `tslint-config-prettier` but is used with ESLint instead of TSLint.

stylelint-config-prettier

`stylelint-config-prettier` is a Stylelint configuration that disables all rules that are unnecessary or might conflict with Prettier. It is used for CSS and other style-related linting, ensuring compatibility with Prettier.

README

tslint-config-prettier

:cop: TSLint + :nail_care: Prettier = :heart_eyes:

Do you want to use TSLint and Prettier without conflicts? tslint-config-prettier disables all conflicting rules that may cause such problems. Prettier takes care of the formatting whereas tslint takes care of all the other things.

Check how it works in this tutorial.

Get started

yarn add --dev tslint-config-prettier
# or
npm install --save-dev tslint-config-prettier

Make sure you've already set up TSLint and Prettier.

Then, extend your tslint.json, and make sure tslint-config-prettier is at the end:

{
  "extends": [
    "tslint:latest",
    "tslint-config-prettier"
  ]
}

More configuration

tslint-config-prettier also turns off formatting rules from the following rulesets, so you can use them safely.

• codelyzer
• tslint
• tslint-consistent-codestyle
• tslint-divid
• tslint-eslint-rules
• tslint-immutable
• tslint-microsoft-contrib
• tslint-misc-rules
• tslint-react
• vrsource-tslint-rules

{
  "extends": [
    "tslint:latest",
    "tslint-react",
    "tslint-eslint-rules",
    "tslint-config-prettier"
  ]
}

CLI helper tool

tslint-config-prettier is shipped with a little CLI tool to help you check if your configuration contains any rules that are in conflict with Prettier. (require tslint installed)

In order to execute the CLI tool, first add a script for it to package.json:

{
  "scripts": {
    "tslint-check": "tslint-config-prettier-check ./tslint.json"
  }
}

Then run yarn tslint-check or npm run tslint-check.

Tutorials

• Using TSlint with Prettier
• Use Prettier with TSLint without conflicts (video)

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Related

• tslint-plugin-prettier - Runs Prettier as a TSLint rule and reports differences as individual TSLint issues.

Credits

Made with :heart: by @alexjoverm and all its contributors