fix: Rule doc notice for description should come first

docs/examples/eslint-plugin-test/docs/rules/no-foo.md

@@ -1,5 +1,7 @@
 # test/no-foo
 
+📝 Disallow using foo.
+
 💼 This rule is enabled in the ✅ `recommended` config.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
@@ -10,8 +12,6 @@
 
 ❗ This rule identifies problems that could cause errors or unexpected behavior.
 
-📝 Disallow using foo.
-
 <!-- end auto-generated rule header -->
 
 ## Rule details

docs/examples/eslint-plugin-test/docs/rules/prefer-bar.md

@@ -1,5 +1,7 @@
 # test/prefer-bar
 
+📝 Enforce using bar.
+
 💼⚠️ This rule is enabled in the ✅ `recommended` config. This rule _warns_ in the 🎨 `stylistic` config.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
@@ -8,8 +10,6 @@
 
 📖 This rule identifies potential improvements.
 
-📝 Enforce using bar.
-
 <!-- end auto-generated rule header -->
 
 ## Rule details

docs/examples/eslint-plugin-test/docs/rules/require-baz.md

@@ -1,5 +1,7 @@
 # test/require-baz
 
+📝 Require using baz.
+
 ❌ This rule is deprecated. It was replaced by [`test/prefer-bar`](prefer-bar.md).
 
 🚫 This rule is _disabled_ in the ⌨️ `typescript` config.
@@ -8,8 +10,6 @@
 
 📏 This rule focuses on code formatting.
 
-📝 Require using baz.
-
 <!-- end auto-generated rule header -->
 
 ## Rule details

lib/options.ts

@@ -38,6 +38,7 @@ export const NOTICE_TYPE_DEFAULT_PRESENCE_AND_ORDERING: {
 } = {
   // Object keys ordered in display order.
   // Object values indicate whether the column is displayed by default.
+  [NOTICE_TYPE.DESCRIPTION]: true,
   [NOTICE_TYPE.DEPRECATED]: true, // Most important.
   [NOTICE_TYPE.CONFIGS]: true,
   [NOTICE_TYPE.FIXABLE]: false,
@@ -46,7 +47,6 @@ export const NOTICE_TYPE_DEFAULT_PRESENCE_AND_ORDERING: {
   [NOTICE_TYPE.OPTIONS]: false,
   [NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: true,
   [NOTICE_TYPE.TYPE]: false,
-  [NOTICE_TYPE.DESCRIPTION]: true,
 };
 
 // Using these variables ensures they have the correct type (not just a plain string).

test/fixtures/cjs-config-extends/docs/rules/no-bar.md

@@ -1,7 +1,7 @@
 # test/no-bar
 
-💼 This rule is enabled in the ✅ `recommended` config.
-
 📝 Description of no-bar.
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->

test/fixtures/cjs-config-extends/docs/rules/no-baz.md

@@ -1,7 +1,7 @@
 # test/no-baz
 
-💼 This rule is enabled in the ✅ `recommended` config.
-
 📝 Description of no-baz.
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->

test/fixtures/cjs-config-extends/docs/rules/no-biz.md

@@ -1,7 +1,7 @@
 # test/no-biz
 
-💼 This rule is enabled in the ✅ `recommended` config.
-
 📝 Description of no-biz.
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->

test/fixtures/cjs-config-extends/docs/rules/no-foo.md

@@ -1,7 +1,7 @@
 # test/no-foo
 
-💼 This rule is enabled in the ✅ `recommended` config.
-
 📝 Description of no-foo.
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->

test/lib/generate/__snapshots__/cjs-test.ts.snap

@@ -46,43 +46,43 @@ exports[`generate (cjs) config that extends another config generates the documen
 exports[`generate (cjs) config that extends another config generates the documentation 2`] = `
 "# test/no-foo
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description of no-foo.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 "
 `;
 
 exports[`generate (cjs) config that extends another config generates the documentation 3`] = `
 "# test/no-bar
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description of no-bar.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 "
 `;
 
 exports[`generate (cjs) config that extends another config generates the documentation 4`] = `
 "# test/no-baz
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description of no-baz.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 "
 `;
 
 exports[`generate (cjs) config that extends another config generates the documentation 5`] = `
 "# test/no-biz
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description of no-biz.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 "
 `;

test/lib/generate/__snapshots__/comment-markers-test.ts.snap

@@ -40,10 +40,10 @@ exports[`generate (comment markers) no existing comment markers - minimal doc co
 exports[`generate (comment markers) no existing comment markers - minimal doc content generates the documentation 2`] = `
 "# test/no-foo
 
-🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
 📝 Description of no-foo.
 
+🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 "
 `;
@@ -58,10 +58,10 @@ since: "v0.12.0"
 ---
 # test/no-foo
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 Pre-existing notice about the rule being recommended.
 ## Rule details
@@ -85,10 +85,10 @@ Existing rules section content."
 exports[`generate (comment markers) no existing comment markers - with no blank lines in existing content generates the documentation 2`] = `
 "# test/no-foo
 
-🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
 📝 Description of no-foo.
 
+🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 Existing rule doc content."
 `;
@@ -111,10 +111,10 @@ Existing rules section content."
 exports[`generate (comment markers) no existing comment markers - with one blank line around existing content generates the documentation 2`] = `
 "# test/no-foo
 
-🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
 📝 Description of no-foo.
 
+🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 
 Existing rule doc content."
@@ -130,10 +130,10 @@ since: "v0.12.0"
 ---
 # test/no-foo
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 ## Rule details
 Details."
@@ -149,21 +149,21 @@ since: "v0.12.0"
 ---
 # test/no-foo
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 "
 `;
 
 exports[`generate (comment markers) rule doc without header marker but pre-existing header updates the documentation 1`] = `
 "# test/no-foo
 
-💼 This rule is enabled in the ✅ \`recommended\` config.
-
 📝 Description.
 
+💼 This rule is enabled in the ✅ \`recommended\` config.
+
 <!-- end auto-generated rule header -->
 Pre-existing notice about the rule being recommended.
 ## Rule details
@@ -189,10 +189,10 @@ No blank line before this."
 exports[`generate (comment markers) with no blank lines around comment markers generates the documentation 2`] = `
 "# test/no-foo
 
-🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
 📝 Description of no-foo.
 
+🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 No blank line before this."
 `;
@@ -218,10 +218,10 @@ One blank line before this."
 exports[`generate (comment markers) with one blank line around comment markers generates the documentation 2`] = `
 "# test/no-foo
 
-🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
 📝 Description of no-foo.
 
+🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 
 One blank line before this."