Skip to content

Commit 2ecc766

Browse files
authored
Update create-rule script to allow choosing fixable "whitespace" (#934)
1 parent 17bf27c commit 2ecc766

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

scripts/create-rule.js

+17-9
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ function updateReadmeRules(data) {
110110
const RULE_START = '## Rules\n\n';
111111
const RULE_END = '\n\n## Deprecated Rules';
112112
let ruleContent = `- [${data.id}](docs/rules/${data.id}.md) - ${data.description}`;
113-
if (data.isFixable === true) {
114-
ruleContent += ' *(fixable)*';
115-
} else if (data.isFixable === 'partly') {
113+
if (data.isFixable && data.isFixable.partly) {
116114
ruleContent += ' *(partly fixable)*';
115+
} else if (data.isFixable) {
116+
ruleContent += ' *(fixable)*';
117117
}
118118

119119
const file = path.join(ROOT, 'readme.md');
@@ -178,16 +178,24 @@ function updateReadme(data) {
178178
message: 'Is it fixable?',
179179
choices: [
180180
{
181-
name: true,
182-
message: 'Yes'
181+
message: 'Code',
182+
value: {type: 'code'}
183+
},
184+
{
185+
message: 'Code (Partly)',
186+
value: {type: 'code', partly: true}
187+
},
188+
{
189+
message: 'Whitespace',
190+
value: {type: 'whitespace'}
183191
},
184192
{
185-
name: 'partly',
186-
message: 'Partly'
193+
message: 'Whitespace (Partly)',
194+
value: {type: 'whitespace', partly: true}
187195
},
188196
{
189-
name: false,
190-
message: 'No'
197+
message: 'No',
198+
value: false
191199
}
192200
]
193201
},

scripts/template/documentation.md.jst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# <%= description %>
22

33
<!-- More detailed description. Remove this comment. -->
4-
<% if (isFixable === true) { %>
5-
This rule is fixable.
6-
<% } else if (isFixable === 'partly') { %>
4+
<% if (isFixable && isFixable.partly) { %>
75
This rule is partly fixable.
6+
<% } else if (isFixable) { %>
7+
This rule is fixable.
88
<% } %>
99
## Fail
1010

scripts/template/rule.js.jst

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ module.exports = {
3535
docs: {
3636
url: getDocumentationUrl(__filename)
3737
},<% if (isFixable) { %>
38-
fixable: 'code',<% } %>
38+
fixable: '<%= isFixable.type %>',<% } %>
3939
schema,
4040
messages
4141
}

0 commit comments

Comments
 (0)