generator-test.ts.snap

// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`generator #generate CJS (non-ESM) generates the documentation 1`] = `
"<!-- begin rules list -->

| Name                           | Description   |
| :----------------------------- | :------------ |
| [no-foo](docs/rules/no-foo.md) | disallow foo. |

<!-- end rules list -->"
`;

exports[`generator #generate CJS (non-ESM) generates the documentation 2`] = `
"# Disallow foo (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate Missing plugin package.json \`name\` field throws an error 1`] = `"Could not find \`name\` field in ESLint plugin's package.json."`;

exports[`generator #generate Missing plugin package.json throws an error 1`] = `"Could not find package.json of ESLint plugin."`;

exports[`generator #generate No configs found omits the config column 1`] = `
"<!-- begin rules list -->

| Name                           | Description   |
| :----------------------------- | :------------ |
| [no-foo](docs/rules/no-foo.md) | disallow foo. |

<!-- end rules list -->"
`;

exports[`generator #generate No configs found omits the config column 2`] = `
"# Disallow foo (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate No exported rules object found throws an error 1`] = `"Could not find exported \`rules\` object in ESLint plugin."`;

exports[`generator #generate README missing rule list markers and no rules section throws an error 1`] = `"README.md is missing rules list markers: <!-- begin rules list --><!-- end rules list -->"`;

exports[`generator #generate README missing rule list markers but with rules section adds rule list markers to rule section 1`] = `
"# eslint-plugin-test

Foo.

## Rules
<!-- begin rules list -->

| Name                           | Description            |
| :----------------------------- | :--------------------- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. |

<!-- end rules list -->

Old rules list.

## Other

Bar."
`;

exports[`generator #generate Rule description needs to be formatted capitalizes the first letter and removes the trailing period from the description 1`] = `
"# Disallow foo (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate Scoped plugin name determines the correct plugin prefix 1`] = `
"# Disallow foo (\`@my-scope/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate config that extends another config generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | Description            | ✅  |
| :----------------------------- | :--------------------- | :-- |
| [no-bar](docs/rules/no-bar.md) | Description of no-bar. | ✅  |
| [no-baz](docs/rules/no-baz.md) | Description of no-baz. | ✅  |
| [no-biz](docs/rules/no-biz.md) | Description of no-biz. | ✅  |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | ✅  |

<!-- end rules list -->
"
`;

exports[`generator #generate config that extends another config generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate config that extends another config generates the documentation 3`] = `
"# Description of no-bar (\`test/no-bar\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate config that extends another config generates the documentation 4`] = `
"# Description of no-baz (\`test/no-baz\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate config that extends another config generates the documentation 5`] = `
"# Description of no-biz (\`test/no-biz\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate config with overrides generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | Description            | ✅  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | ✅  |

<!-- end rules list -->
"
`;

exports[`generator #generate config with overrides generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate deprecated function-style rule generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | ✅  |
| :----------------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | ✅  |

<!-- end rules list -->
"
`;

exports[`generator #generate deprecated function-style rule generates the documentation 2`] = `
"# \`test/no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate deprecated rule with no rule doc but --ignore-deprecated-rules omits the rule from the README and does not try to update its non-existent rule doc 1`] = `
"<!-- begin rules list -->

| Name |
| :--- |

<!-- end rules list -->"
`;

exports[`generator #generate deprecated rules updates the documentation 1`] = `
"<!-- begin rules list -->

❌ Deprecated.

| Name                           | Description  | ❌  |
| :----------------------------- | :----------- | :-- |
| [no-bar](docs/rules/no-bar.md) | Description. | ❌  |
| [no-baz](docs/rules/no-baz.md) | Description. | ❌  |
| [no-biz](docs/rules/no-biz.md) | Description. |     |
| [no-foo](docs/rules/no-foo.md) | Description. | ❌  |

<!-- end rules list -->"
`;

exports[`generator #generate deprecated rules updates the documentation 2`] = `
"# Description (\`test/no-foo\`)

❌ This rule is deprecated. It was replaced by [\`no-bar\`](no-bar.md).

<!-- end rule header -->
"
`;

exports[`generator #generate deprecated rules updates the documentation 3`] = `
"# Description (\`test/no-bar\`)

❌ This rule is deprecated.

<!-- end rule header -->
"
`;

exports[`generator #generate deprecated rules updates the documentation 4`] = `
"# Description (\`test/no-baz\`)

❌ This rule is deprecated.

<!-- end rule header -->
"
`;

exports[`generator #generate deprecated rules updates the documentation 5`] = `
"# Description (\`test/no-biz\`)

<!-- end rule header -->
"
`;

exports[`generator #generate lowercase README file generates the documentation 1`] = `
"<!-- begin rules list -->

| Name                           |
| :----------------------------- |
| [no-foo](docs/rules/no-foo.md) |

<!-- end rules list -->"
`;

exports[`generator #generate no existing comment markers - minimal doc content generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                           | Description            | 🔧  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🔧  |

<!-- end rules list -->
"
`;

exports[`generator #generate no existing comment markers - minimal doc content generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->
"
`;

exports[`generator #generate no existing comment markers - with no blank lines in existing content generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                           | Description            | 🔧  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🔧  |

<!-- end rules list -->
Existing rules section content."
`;

exports[`generator #generate no existing comment markers - with no blank lines in existing content generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->
Existing rule doc content."
`;

exports[`generator #generate no existing comment markers - with one blank line around existing content generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                           | Description            | 🔧  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🔧  |

<!-- end rules list -->

Existing rules section content."
`;

exports[`generator #generate no existing comment markers - with one blank line around existing content generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->

Existing rule doc content."
`;

exports[`generator #generate no prettier config generates the documentation 1`] = `
"<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                           | Description            | 🔧  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🔧  |

<!-- end rules list -->"
`;

exports[`generator #generate no prettier config generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->
## Rule details
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 no rules with description generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

| Name                           |
| :----------------------------- |
| [no-foo](docs/rules/no-foo.md) |

<!-- end rules list -->
"
`;

exports[`generator #generate no rules with description generates the documentation 2`] = `
"# \`test/no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate one rule missing description generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

| Name                           | Description             |
| :----------------------------- | :---------------------- |
| [no-bar](docs/rules/no-bar.md) |                         |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. |

<!-- end rules list -->
"
`;

exports[`generator #generate one rule missing description generates the documentation 2`] = `
"# Description for no-foo (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate one rule missing description generates the documentation 3`] = `
"# \`test/no-bar\`

<!-- end rule header -->
"
`;

exports[`generator #generate only a \`recommended\` config updates the documentation 1`] = `
"<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | Description  | ✅  |
| :----------------------------- | :----------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description. | ✅  |

<!-- end rules list -->"
`;

exports[`generator #generate only a \`recommended\` config updates the documentation 2`] = `
"# Description (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate rule config with options generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | Description            | ✅  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | ✅  |

<!-- end rules list -->
"
`;

exports[`generator #generate rule config with options generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate rule doc without header marker but pre-existing header updates the documentation 1`] = `
"# Description (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
Pre-existing notice about the rule being recommended.
## Rule details
Details."
`;

exports[`generator #generate rule with long-enough description to require name column wrapping avoidance adds spaces to the name column 1`] = `
"## Rules
<!-- begin rules list -->

| Name&nbsp;&nbsp;               | Description                                                                         |
| :----------------------------- | :---------------------------------------------------------------------------------- |
| [no-foo](docs/rules/no-foo.md) | over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars |

<!-- end rules list -->
"
`;

exports[`generator #generate rule with long-enough description to require name column wrapping avoidance adds spaces to the name column 2`] = `
"# Over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate rule with long-enough description to require name column wrapping avoidance but rule name too short does not add spaces to name column 1`] = `
"## Rules
<!-- begin rules list -->

| Name                     | Description                                                                         |
| :----------------------- | :---------------------------------------------------------------------------------- |
| [foo](docs/rules/foo.md) | over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars |

<!-- end rules list -->
"
`;

exports[`generator #generate rule with long-enough description to require name column wrapping avoidance but rule name too short does not add spaces to name column 2`] = `
"# Over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars over 60 chars (\`test/foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column enabled displays the type 1`] = `
"## Rules
<!-- begin rules list -->

🗂️ The type of rule.\\
❗ Identifies problems that could cause errors or unexpected behavior.\\
📖 Identifies potential improvements.\\
📏 Focuses on code formatting.

| Name                           | 🗂️  |
| :----------------------------- | :-- |
| [no-bar](docs/rules/no-bar.md) | 📖  |
| [no-biz](docs/rules/no-biz.md) | 📏  |
| [no-boz](docs/rules/no-boz.md) |     |
| [no-buz](docs/rules/no-buz.md) |     |
| [no-foo](docs/rules/no-foo.md) | ❗  |

<!-- end rules list -->
"
`;

exports[`generator #generate rule with type, type column enabled displays the type 2`] = `
"# \`test/no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column enabled displays the type 3`] = `
"# \`test/no-bar\`

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column enabled displays the type 4`] = `
"# \`test/no-biz\`

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column enabled displays the type 5`] = `
"# \`test/no-boz\`

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column enabled displays the type 6`] = `
"# \`test/no-buz\`

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column enabled, but only an unknown type hides the type column and notice 1`] = `
"## Rules
<!-- begin rules list -->

| Name                           |
| :----------------------------- |
| [no-foo](docs/rules/no-foo.md) |

<!-- end rules list -->
"
`;

exports[`generator #generate rule with type, type column enabled, but only an unknown type hides the type column and notice 2`] = `
"# \`test/no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate rule with type, type column not enabled hides the type column 1`] = `
"## Rules
<!-- begin rules list -->

| Name                           |
| :----------------------------- |
| [no-foo](docs/rules/no-foo.md) |

<!-- end rules list -->
"
`;

exports[`generator #generate rule with type, type column not enabled hides the type column 2`] = `
"# \`test/no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate rules that are disabled generates the documentation 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | Description            | ✅  |
| :----------------------------- | :--------------------- | :-- |
| [no-bar](docs/rules/no-bar.md) | Description of no-bar. |     |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. |     |

<!-- end rules list -->
"
`;

exports[`generator #generate rules that are disabled generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate rules that are disabled generates the documentation 3`] = `
"# Description of no-bar (\`test/no-bar\`)

<!-- end rule header -->
"
`;

exports[`generator #generate shows column and notice for requiresTypeChecking updates the documentation 1`] = `
"<!-- begin rules list -->

🌐 Enabled in the \`all\` configuration.\\
💭 Requires type information.

| Name                           | Description            | 🌐  | 💭  |
| :----------------------------- | :--------------------- | :-- | :-- |
| [no-bar](docs/rules/no-bar.md) | Description of no-bar. |     | 💭  |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🌐  |     |

<!-- end rules list -->"
`;

exports[`generator #generate shows column and notice for requiresTypeChecking updates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🌐 This rule is enabled in the \`all\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate shows column and notice for requiresTypeChecking updates the documentation 3`] = `
"# Description of no-bar (\`test/no-bar\`)

💭 This rule requires type information.

<!-- end rule header -->
"
`;

exports[`generator #generate successful updates the documentation 1`] = `
"# eslint-plugin-test
Description.
## Rules
<!-- begin rules list -->

💼 Configurations enabled in.\\
🌐 Enabled in the \`all\` configuration.\\
✅ Enabled in the \`recommended\` configuration.\\
🎨 Enabled in the \`style\` configuration.\\
🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

| Name                           | Description            | 💼    | 🔧  | 💡  |
| :----------------------------- | :--------------------- | :---- | :-- | :-- |
| [no-bar](docs/rules/no-bar.md) | Description of no-bar. | 🌐 🎨 | 🔧  |     |
| [no-baz](docs/rules/no-baz.md) | Description of no-boz. |       |     |     |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🌐 ✅ | 🔧  | 💡  |

<!-- end rules list -->
more content."
`;

exports[`generator #generate successful updates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

💼 This rule is enabled in the following configs: 🌐 \`all\`, ✅ \`recommended\`.

🔧💡 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

<!-- end rule header -->
## Rule details
details
## Options
optionToDoSomething1 - explanation
optionToDoSomething2 - explanation"
`;

exports[`generator #generate successful updates the documentation 3`] = `
"# Description of no-bar (\`test/no-bar\`)

💼 This rule is enabled in the following configs: 🌐 \`all\`, 🎨 \`style\`.

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->
## Rule details
details"
`;

exports[`generator #generate successful updates the documentation 4`] = `
"# Description of no-boz (\`test/no-baz\`)

<!-- end rule header -->
## Rule details
details"
`;

exports[`generator #generate uses prettier config from package.json should wrap prose in rule doc header to just 20 chars 1`] = `
"<!-- begin rules list -->

🌐 Enabled in the
\`all\` configuration.

| Name                           | Description            | 🌐  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🌐  |

<!-- end rules list -->"
`;

exports[`generator #generate uses prettier config from package.json should wrap prose in rule doc header to just 20 chars 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🌐 This rule is
enabled in the \`all\`
config.

<!-- end rule header -->
## Rule details
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\`)

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--rule-doc-title-format\` option = desc-parens-prefix-name uses the right rule doc title format, with fallback when missing description 1`] = `
"# Description for no-foo (\`test/no-foo\`)

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--rule-doc-title-format\` option = desc-parens-prefix-name uses the right rule doc title format, with fallback when missing description 2`] = `
"# \`test/no-bar\`

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--rule-doc-title-format\` option = name uses the right rule doc title format 1`] = `
"# \`no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--rule-doc-title-format\` option = prefix-name uses the right rule doc title format 1`] = `
"# \`test/no-foo\`

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--url-configs\` option includes the config link 1`] = `
"## Rules
<!-- begin rules list -->

💼 [Configurations](http://example.com/configs) enabled in.\\
✅ Enabled in the \`recommended\` [configuration](http://example.com/configs).

| Name                           | Description             | 💼                |
| :----------------------------- | :---------------------- | :---------------- |
| [no-bar](docs/rules/no-bar.md) | Description for no-bar. | ![customConfig][] |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | ✅                |

<!-- end rules list -->
"
`;

exports[`generator #generate with \`--url-configs\` option includes the config link 2`] = `
"# Description for no-foo (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` [config](http://example.com/configs).

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--url-configs\` option includes the config link 3`] = `
"# Description for no-bar (\`test/no-bar\`)

💼 This rule is enabled in the \`customConfig\` [config](http://example.com/configs).

<!-- end rule header -->
"
`;

exports[`generator #generate with \`--url-configs\` option with only recommended config includes the config link 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` [configuration](http://example.com/configs).

| Name                           | Description             | ✅  |
| :----------------------------- | :---------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | ✅  |

<!-- end rules list -->
"
`;

exports[`generator #generate with \`--url-configs\` option with only recommended config includes the config link 2`] = `
"# Description for no-foo (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` [config](http://example.com/configs).

<!-- end rule header -->
"
`;

exports[`generator #generate with --check prints the issues, exits with failure, and does not write changes 1`] = `
"## Rules
"
`;

exports[`generator #generate with --check prints the issues, exits with failure, and does not write changes 2`] = `""`;

exports[`generator #generate with --config-emoji and removing default emoji for a config reverts to using a badge for the config 1`] = `
"## Rules
<!-- begin rules list -->

💼 Configurations enabled in.

| Name                           | Description             | 💼               |
| :----------------------------- | :---------------------- | :--------------- |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | ![recommended][] |

<!-- end rules list -->
"
`;

exports[`generator #generate with --config-emoji and removing default emoji for a config reverts to using a badge for the config 2`] = `
"# Description for no-foo (\`test/no-foo\`)

💼 This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate with --config-emoji and using the default config emoji for a config hides the generic config emoji legend to avoid two legends for the same emoji 1`] = `
"## Rules
<!-- begin rules list -->

💼 Enabled in the \`recommended\` configuration.

| Name                           | Description             | 💼  |
| :----------------------------- | :---------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | 💼  |

<!-- end rules list -->
"
`;

exports[`generator #generate with --config-emoji and using the default config emoji for a config hides the generic config emoji legend to avoid two legends for the same emoji 2`] = `
"# Description for no-foo (\`test/no-foo\`)

💼 This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate with --config-emoji shows the correct emojis 1`] = `
"## Rules
<!-- begin rules list -->

💼 Configurations enabled in.\\
🔥 Enabled in the \`recommended\` configuration.\\
🎨 Enabled in the \`stylistic\` configuration.

| Name                           | Description             | 💼                         |
| :----------------------------- | :---------------------- | :------------------------- |
| [no-bar](docs/rules/no-bar.md) | Description for no-bar. | 🔥 🎨                      |
| [no-baz](docs/rules/no-baz.md) | Description for no-boz. | ![configWithoutEmoji][] 🎨 |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | 🔥                         |

<!-- end rules list -->
"
`;

exports[`generator #generate with --config-emoji shows the correct emojis 2`] = `
"# Description for no-foo (\`test/no-foo\`)

🔥 This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate with --config-emoji shows the correct emojis 3`] = `
"# Description for no-bar (\`test/no-bar\`)

💼 This rule is enabled in the following configs: 🔥 \`recommended\`, 🎨 \`stylistic\`.

<!-- end rule header -->
"
`;

exports[`generator #generate with --config-emoji shows the correct emojis 4`] = `
"# Description for no-boz (\`test/no-baz\`)

💼 This rule is enabled in the following configs: \`configWithoutEmoji\`, 🎨 \`stylistic\`.

<!-- end rule header -->
"
`;

exports[`generator #generate with --ignore-config hides the ignored config 1`] = `
"## Rules
<!-- begin rules list -->

✅ Enabled in the \`recommended\` configuration.

| Name                           | Description             | ✅  |
| :----------------------------- | :---------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | ✅  |

<!-- end rules list -->
"
`;

exports[`generator #generate with --ignore-config hides the ignored config 2`] = `
"# Description for no-foo (\`test/no-foo\`)

✅ This rule is enabled in the \`recommended\` config.

<!-- end rule header -->
"
`;

exports[`generator #generate with --rule-doc-notices shows the right rule doc notices 1`] = `
"## Rules
<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\\
❌ Deprecated.

| Name                           | Description             | 🔧  | 💡  | ❌  |
| :----------------------------- | :---------------------- | :-- | :-- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | 🔧  | 💡  | ❌  |

<!-- end rules list -->
"
`;

exports[`generator #generate with --rule-doc-notices shows the right rule doc notices 2`] = `
"# Description for no-foo (\`test/no-foo\`)

💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

❌ This rule is deprecated.

❗ This rule identifies problems that could cause errors or unexpected behavior.

<!-- end rule header -->
"
`;

exports[`generator #generate with --rule-list-columns shows the right columns and legend 1`] = `
"## Rules
<!-- begin rules list -->

💡 Manually fixable by [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#--fix).

| 💡  | 🔧  | Name                           |
| :-- | :-- | :----------------------------- |
| 💡  | 🔧  | [no-foo](docs/rules/no-foo.md) |

<!-- end rules list -->
"
`;

exports[`generator #generate with --rule-list-columns shows the right columns and legend 2`] = `
"# Description for no-foo (\`test/no-foo\`)

❌ This rule is deprecated.

🔧💡 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

<!-- end rule header -->
"
`;

exports[`generator #generate with no blank lines around comment markers generates the documentation 1`] = `
"# Rules

No blank line after this.
<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                           | Description            | 🔧  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🔧  |

<!-- end rules list -->
No blank line before this."
`;

exports[`generator #generate with no blank lines around comment markers generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->
No blank line before this."
`;

exports[`generator #generate with one blank line around comment markers generates the documentation 1`] = `
"# Rules

One blank line after this.

<!-- begin rules list -->

🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                           | Description            | 🔧  |
| :----------------------------- | :--------------------- | :-- |
| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | 🔧  |

<!-- end rules list -->

One blank line before this."
`;

exports[`generator #generate with one blank line around comment markers generates the documentation 2`] = `
"# Description of no-foo (\`test/no-foo\`)

🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end rule header -->

One blank line before this."
`;

exports[`generator #generate with one config that does not have emoji shows the default config emoji 1`] = `
"## Rules
<!-- begin rules list -->

💼 Configurations enabled in.

| Name                           | Description             | 💼                      |
| :----------------------------- | :---------------------- | :---------------------- |
| [no-foo](docs/rules/no-foo.md) | Description for no-foo. | ![configWithoutEmoji][] |

<!-- end rules list -->
"
`;

exports[`generator #generate with one config that does not have emoji shows the default config emoji 2`] = `
"# Description for no-foo (\`test/no-foo\`)

💼 This rule is enabled in the \`configWithoutEmoji\` config.

<!-- end rule header -->
"
`;