eslint-doc-generator - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0

dist/lib/legend.js

@@ -16,4 +16,4 @@ import { EMOJI_DEPRECATED, EMOJI_FIXABLE, EMOJI_HAS_SUGGESTIONS, EMOJI_CONFIGS, EMOJI_CONFIG_RECOMMENDED, EMOJI_REQUIRES_TYPE_CHECKING, } from './emojis.js';
         [COLUMN_TYPE.DEPRECATED]: `${EMOJI_DEPRECATED} Deprecated.`,
-        [COLUMN_TYPE.FIXABLE]: `${EMOJI_FIXABLE} Fixable with [\`eslint --fix\`](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).`,
-        [COLUMN_TYPE.HAS_SUGGESTIONS]: `${EMOJI_HAS_SUGGESTIONS} Provides editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`,
+        [COLUMN_TYPE.FIXABLE]: `${EMOJI_FIXABLE} Automatically fixable by the \`--fix\` [CLI option](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).`,
+        [COLUMN_TYPE.HAS_SUGGESTIONS]: `${EMOJI_HAS_SUGGESTIONS} Manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`,
         [COLUMN_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} Requires type information.`,
@@ -20,0 +20,0 @@ };

dist/lib/rule-doc-title-format.d.ts

@@ -1,3 +0,3 @@
-export declare const RULE_DOC_TITLE_FORMATS: readonly ["desc-parens-prefix-name", "desc-parens-name", "prefix-name", "name"];
+export declare const RULE_DOC_TITLE_FORMATS: readonly ["desc", "desc-parens-name", "desc-parens-prefix-name", "name", "prefix-name"];
 export declare type RuleDocTitleFormat = typeof RULE_DOC_TITLE_FORMATS[number];
 export declare const RULE_DOC_TITLE_FORMAT_DEFAULT: RuleDocTitleFormat;

dist/lib/rule-doc-title-format.js

 export const RULE_DOC_TITLE_FORMATS = [
+    'desc',
+    'desc-parens-name',
     'desc-parens-prefix-name',
-    'desc-parens-name',
+    'name',
     'prefix-name',
-    'name',
 ];
 export const RULE_DOC_TITLE_FORMAT_DEFAULT = 'desc-parens-prefix-name';

dist/lib/rule-list-columns.js

@@ -21,3 +21,3 @@ import { hasCustomConfigs, hasAnyConfigs } from './configs.js';
     [COLUMN_TYPE.HAS_SUGGESTIONS]: EMOJI_HAS_SUGGESTIONS,
-    [COLUMN_TYPE.NAME]: 'Rule',
+    [COLUMN_TYPE.NAME]: 'Name',
     [COLUMN_TYPE.REQUIRES_TYPE_CHECKING]: EMOJI_REQUIRES_TYPE_CHECKING,
@@ -24,0 +24,0 @@ };

dist/lib/rule-list.js

@@ -60,3 +60,3 @@ import { BEGIN_RULE_LIST_MARKER, END_RULE_LIST_MARKER } from './markers.js';
     });
-    const listSpacerRow = Array.from({ length: listHeaderRow.length }).fill('-');
+    const listSpacerRow = Array.from({ length: listHeaderRow.length }).fill(':--'); // Left-align header with colon.
     return [
@@ -63,0 +63,0 @@ listHeaderRow,

dist/lib/rule-notices.js

@@ -20,4 +20,4 @@ import { END_RULE_HEADER_MARKER } from './markers.js';
         [MESSAGE_TYPE.DEPRECATED]: `${EMOJI_DEPRECATED} This rule is deprecated.`,
-        [MESSAGE_TYPE.FIXABLE]: `${EMOJI_FIXABLE} This rule is automatically fixable using the \`--fix\` [option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) on the command line.`,
-        [MESSAGE_TYPE.HAS_SUGGESTIONS]: `${EMOJI_HAS_SUGGESTIONS} This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions) that can be applied manually.`,
+        [MESSAGE_TYPE.FIXABLE]: `${EMOJI_FIXABLE} This rule is automatically fixable by the \`--fix\` [CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).`,
+        [MESSAGE_TYPE.HAS_SUGGESTIONS]: `${EMOJI_HAS_SUGGESTIONS} This rule is manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`,
     };
@@ -112,10 +112,12 @@ return MESSAGES;
     switch (ruleDocTitleFormatWithFallback) {
+        case 'desc':
+            return `# ${descriptionFormatted}`;
+        case 'desc-parens-name':
+            return `# ${descriptionFormatted} (\`${name}\`)`;
         case 'desc-parens-prefix-name':
             return `# ${descriptionFormatted} (\`${pluginPrefix}/${name}\`)`;
-        case 'desc-parens-name':
-            return `# ${descriptionFormatted} (\`${name}\`)`;
+        case 'name':
+            return `# \`${name}\``;
         case 'prefix-name':
             return `# \`${pluginPrefix}/${name}\``;
-        case 'name':
-            return `# \`${name}\``;
         /* istanbul ignore next -- this shouldn't happen */
@@ -122,0 +124,0 @@ default:

package.json

 {
   "name": "eslint-doc-generator",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Automatic documentation generator for ESLint plugins and rules.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -64,5 +64,5 @@ # eslint-doc-generator
 
-🔧 This rule is automatically fixable using the `--fix` [option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) on the command line.
+🔧 This rule is automatically fixable by the `--fix` [CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions) that can be applied manually.
+💡 This rule is manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
@@ -93,4 +93,4 @@ ❌ This rule is deprecated. It was replaced by [some-new-rule](some-new-rule.md).
 💼 Configurations enabled in.\
-🔧 Fixable with [`eslint --fix`](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).\
-💡 Provides editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
+🔧 Automatically fixable by the `--fix` [CLI option](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).\
+💡 Manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
 💭 Requires type information.\
@@ -100,3 +100,3 @@ ❌ Deprecated.
 | Rule                                                           | Description                                       | ✅  | 🔧  | 💡  | 💭  |
-| -------------------------------------------------------------- | ------------------------------------------------- | --- | --- | --- | --- |
+| :------------------------------------------------------------- | :------------------------------------------------ | :-- | :-- | :-- | :-- |
 | [max-nested-describe](docs/rules/max-nested-describe.md)       | Enforces a maximum depth to nested describe calls |     |     |     |     |
@@ -125,3 +125,3 @@ | [no-alias-methods](docs/rules/no-alias-methods.md)             | Disallow alias methods                            | ✅  | 🔧  |     |     |
 | Name | Description |
-| --- | --- |
+| :-- | :-- |
 | `--ignore-config` | (optional) Config to ignore from being displayed (often used for an `all` config) (option can be repeated). |
@@ -131,3 +131,3 @@ | `--ignore-deprecated-rules` | (optional) Whether to ignore deprecated rules from being checked, displayed, or updated (default: `false`). |
 | `--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. |
@@ -134,0 +134,0 @@

No alert changes

Improved metrics

Total package byte prevSize

47394

increased by0.3%

Lines of code

845

increased by0.36%

No dependency changes