Merge pull request #147 from yinm/tweak-scaffolding

Tweak `generate-rule`
storybookjs · May 17, 2024 · eef5e25 · eef5e25
2 parents bd1b02e + a2fc883
commit eef5e25
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/tools/generate-rule.ts b/tools/generate-rule.ts
@@ -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\`
@@ -138,7 +138,9 @@ const generateRule = async () => {
             },
           }
         },
-      })\n`)
+      })
+
+`)
   )
 
   logger.log(`creating tests/lib/rules/${ruleId}.test.ts`)
@@ -178,7 +180,8 @@ const generateRule = async () => {
             },
           ],
         })
-    `)
+
+`)
   )
 
   logger.log(`creating docs/rules/${ruleId}.md`)
@@ -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
@@ -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({