chore: update documentation headers and package eslint-doc-generator to v3.0.2

[aladdin-add]

What is the purpose of this pull request?

What changes did you make? (Give an overview)

This pull request updates the documentation headers for several ESLint plugin rules to improve clarity and consistency. The changes standardize the rule documentation by moving the rule name to a dedicated header, adding a brief description, and ensuring consistent formatting across all rule docs.

Documentation improvements:

• Updated headers in multiple rule documentation files to use the format # eslint-plugin/<rule-name>, followed by a concise description of each rule. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20]

• Added or clarified short summary lines (with the 📝 emoji) under each rule header to quickly explain the rule’s purpose. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20]

Related Issues

Is there anything you'd like reviewers to focus on?

[Copilot]

Pull request overview

This PR updates the rule documentation header format across docs/rules/* for improved consistency, and bumps eslint-doc-generator to a newer major version.

Changes:

• Bump eslint-doc-generator devDependency from ^2.2.2 to ^3.0.2.
• Standardize rule doc headers to # eslint-plugin/<rule-name> plus a one-line 📝 summary.

Reviewed changes

Copilot reviewed 36 out of 36 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
package.json	Bumps eslint-doc-generator to ^3.0.2.
docs/rules/unique-test-case-names.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/test-case-shorthand-strings.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/test-case-property-ordering.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-test-case-name.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-type.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-schema.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-schema-description.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-has-suggestions.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-fixable.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-docs-url.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-docs-recommended.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-docs-description.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/require-meta-default-options.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/report-message-format.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/prefer-replace-text.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/prefer-placeholders.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/prefer-output-null.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/prefer-object-rule.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/prefer-message-ids.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-useless-token-range.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-unused-placeholders.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-unused-message-ids.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-property-in-node.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-only-tests.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-missing-placeholders.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-missing-message-ids.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-meta-schema-default.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-meta-replaced-by.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-matching-violation-suggest-message-ids.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-identical-tests.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-deprecated-report-api.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/no-deprecated-context-methods.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/meta-property-ordering.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/fixer-return.md	Standardizes rule doc header + adds 📝 summary line.
docs/rules/consistent-output.md	Standardizes rule doc header + adds 📝 summary line.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

eslint-doc-generator was bumped to ^3.0.2, but e2e/package-lock.json still pins eslint-doc-generator at ^2.2.2 (under the ".." workspace entry). To keep e2e installs reproducible and avoid lockfile churn during npm install in e2e/, update the e2e lockfile to match the new version.

[Copilot]

Grammar nit: this should use the possessive form (e.g., "rules' meta.schema properties") rather than "rules meta.schema properties".

Suggested change

	📝 Disallow rules `meta.schema` properties to include defaults.
	📝 Disallow rules' `meta.schema` properties to include defaults.

[Copilot]

Grammar nit: this should use the possessive form (e.g., "rules' meta.schema properties") rather than "rules meta.schema properties".

Suggested change

	📝 Require rules `meta.schema` properties to include descriptions.
	📝 Require rules' `meta.schema` properties to include descriptions.

[bmish]

Thanks!