Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tweak generate-rule #147

Merged
merged 3 commits into from May 17, 2024
Merged

Tweak generate-rule #147

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02b202b
Insert newline at end of file
yinm Dec 28, 2023
ea03039
Remove lines to match Prettier
yinm Dec 28, 2023
a2fc883
Use `ruleDescription` by user input
yinm Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions tools/generate-rule.ts
View file
Open in desktop
Expand Up @@ -81,7 +81,7 @@ const generateRule = async () => {
meta: {
type: 'problem', // \`problem\`, \`suggestion\`, or \`layout\`
docs: {
description: 'Fill me in',
description: '${ruleDescription}',
// Add the categories that suit this rule.
categories: [CategoryId.RECOMMENDED],
recommended: 'warn', // \`warn\` or \`error\`
Expand Down Expand Up @@ -138,7 +138,9 @@ const generateRule = async () => {
},
}
},
})\n`)
})

`)
)

logger.log(`creating tests/lib/rules/${ruleId}.test.ts`)
Expand Down Expand Up @@ -178,7 +180,8 @@ const generateRule = async () => {
},
],
})
`)

`)
)

logger.log(`creating docs/rules/${ruleId}.md`)
Expand All @@ -197,17 +200,13 @@ const generateRule = async () => {
Examples of **incorrect** code for this rule:

\`\`\`js

// fill me in

\`\`\`

Examples of **correct** code for this rule:

\`\`\`js

// fill me in

\`\`\`

### Options
Expand All @@ -221,7 +220,8 @@ const generateRule = async () => {
## Further Reading

If there are other links that describe the issue this rule addresses, please include them here in a bulleted list. Otherwise, delete this section.
`)

`)
)

const { shouldOpenInVSCode } = await prompts({
Expand Down