Skip to content

Commit

Permalink
Document the recommended set
Browse files Browse the repository at this point in the history
  • Loading branch information
dcyriller committed Nov 24, 2019
1 parent 81dc544 commit 11f3b22
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,30 @@ Also, this plugin doesn't come with a recommended set of rules (that you often p

## Recommended configuration

You can merge your existing `.template-lintrc.js` configuration with this object:

A recommended configuration is available. To use it, merge the following object
to your `.templatelintrc.js` file:
```
module.exports = {
plugins: ["ember-template-lint-plugin-prettier"],
extends: ["recommend", "ember-template-lint-plugin-prettier:recommended"],
},
};
```

The recommended set will apply the following rules:
```
module.exports = {
rules: {
prettier: true, // turn this plugin's rule on
// if you use ember-template-lint's recommended set of rules
// through `extends: "recommended"`,
// these two rules need to be disabled
// the following stylistic rules need to be disabled
// to let Prettier handle formatting
"block-indentation": false,
"self-closing-void-elements": false,
"linebreak-style": false,
quotes: false,
"self-closing-void-elements": false
},
};
```
Expand Down

0 comments on commit 11f3b22

Please sign in to comment.