Skip to content

Commit 1169829

Browse files
committed
Document the recommended set
1 parent 285a86b commit 1169829

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,30 @@ Also, this plugin doesn't come with a recommended set of rules (that you often p
2828

2929
## Recommended configuration
3030

31-
You can merge your existing `.template-lintrc.js` configuration with this object:
32-
31+
A recommended configuration is available. To use it, merge the following object
32+
to your `.templatelintrc.js` file:
3333
```
3434
module.exports = {
3535
plugins: ["ember-template-lint-plugin-prettier"],
3636
37+
extends: ["recommend", "ember-template-lint-plugin-prettier:recommended"],
38+
},
39+
};
40+
```
41+
42+
The recommended set will apply the following rules:
43+
```
44+
module.exports = {
3745
rules: {
3846
prettier: true, // turn this plugin's rule on
3947
4048
// if you use ember-template-lint's recommended set of rules
41-
// through `extends: "recommended"`,
42-
// these two rules need to be disabled
49+
// the following stylistic rules need to be disabled
4350
// to let Prettier handle formatting
4451
"block-indentation": false,
45-
"self-closing-void-elements": false,
52+
"linebreak-style": false,
53+
quotes: false,
54+
"self-closing-void-elements": false
4655
},
4756
};
4857
```

0 commit comments

Comments
 (0)