Merge pull request #104 from bmish/desc-title-format

Author: bmish

README.md

@@ -124,7 +124,7 @@ If you have any custom configs (besides `all`, `recommended`), you'll need to de
 | `--ignore-deprecated-rules` | (optional) Whether to ignore deprecated rules from being checked, displayed, or updated (default: `false`). |
 | `--rule-doc-section-include` | (optional) Required section in each rule doc (option can be repeated). |
 | `--rule-doc-section-exclude` | (optional) Disallowed section in each rule doc (option can be repeated). |
-| `--rule-doc-title-format` | (optional) The format to use for rule doc titles. Choices: `desc-parens-prefix-name` (default), `desc-parens-name`, `prefix-name`, `name`. |
+| `--rule-doc-title-format` | (optional) The format to use for rule doc titles. Choices: `desc-parens-prefix-name` (default), `desc`, `desc-parens-name`, `name`, `prefix-name`. |
 | `--url-configs` | (optional) Link to documentation about the ESLint configurations exported by the plugin. |
 
 ## Upcoming features

lib/rule-doc-title-format.ts

@@ -1,8 +1,9 @@
 export const RULE_DOC_TITLE_FORMATS = [
-  'desc-parens-prefix-name',
+  'desc',
   'desc-parens-name',
-  'prefix-name',
+  'desc-parens-prefix-name',
   'name',
+  'prefix-name',
 ] as const;
 
 export type RuleDocTitleFormat = typeof RULE_DOC_TITLE_FORMATS[number];

lib/rule-notices.ts

@@ -164,14 +164,16 @@ function makeTitle(
   }
 
   switch (ruleDocTitleFormatWithFallback) {
-    case 'desc-parens-prefix-name':
-      return `# ${descriptionFormatted} (\`${pluginPrefix}/${name}\`)`;
+    case 'desc':
+      return `# ${descriptionFormatted}`;
     case 'desc-parens-name':
       return `# ${descriptionFormatted} (\`${name}\`)`;
-    case 'prefix-name':
-      return `# \`${pluginPrefix}/${name}\``;
+    case 'desc-parens-prefix-name':
+      return `# ${descriptionFormatted} (\`${pluginPrefix}/${name}\`)`;
     case 'name':
       return `# \`${name}\``;
+    case 'prefix-name':
+      return `# \`${pluginPrefix}/${name}\``;
     /* istanbul ignore next -- this shouldn't happen */
     default:
       throw new Error(

test/lib/__snapshots__/generator-test.ts.snap

@@ -548,6 +548,13 @@ details
 Long line that SHOULD NOT get wrapped by prettier since it's outside the header. Long line that SHOULD NOT get wrapped by prettier since it's outside the header."
 `;
 
+exports[`generator #generate with \`--rule-doc-title-format\` option = desc uses the right rule doc title format 1`] = `
+"# Description for no-foo
+
+<!-- end rule header -->
+"
+`;
+
 exports[`generator #generate with \`--rule-doc-title-format\` option = desc-parens-name uses the right rule doc title format 1`] = `
 "# Description for no-foo (\`no-foo\`)
 

test/lib/generator-test.ts

@@ -1992,6 +1992,46 @@ describe('generator', function () {
       });
     });
 
+    describe('with `--rule-doc-title-format` option = desc', function () {
+      beforeEach(function () {
+        mockFs({
+          'package.json': JSON.stringify({
+            name: 'eslint-plugin-test',
+            main: 'index.js',
+            type: 'module',
+          }),
+
+          'index.js': `
+            export default {
+              rules: {
+                'no-foo': { meta: { docs: { description: 'Description for no-foo.'} }, create(context) {} },
+              },
+            };`,
+
+          'README.md': '## Rules\n',
+
+          'docs/rules/no-foo.md': '',
+
+          // Needed for some of the test infrastructure to work.
+          node_modules: mockFs.load(
+            resolve(__dirname, '..', '..', 'node_modules')
+          ),
+        });
+      });
+
+      afterEach(function () {
+        mockFs.restore();
+        jest.resetModules();
+      });
+
+      it('uses the right rule doc title format', async function () {
+        await generate('.', {
+          ruleDocTitleFormat: 'desc',
+        });
+        expect(readFileSync('docs/rules/no-foo.md', 'utf8')).toMatchSnapshot();
+      });
+    });
+
     describe('with `--rule-doc-title-format` option = prefix-name', function () {
       beforeEach(function () {
         mockFs({