fix(linter): correct capitalized-comments rule config schema to tuple format

[Copilot]

Fix capitalized-comments rule configuration documentation

Resolves the issue where the capitalized-comments rule had incorrect configuration option docs that didn't match ESLint's format.

Changes Made

1. Created proper tuple schema (CapitalizedCommentsSchema)

   • Represents the configuration as a tuple: [capitalize_option, options]
   • First element: "always" | "never" enum
   • Second element: Optional configuration object

2. Added comprehensive field descriptions for all configuration options using doc comments:

   • ignorePattern: Pattern for comments to ignore
   • ignoreInlineComments: Whether to ignore inline comments
   • ignoreConsecutiveComments: Whether to ignore consecutive comments
   • line: Configuration specific to line comments
   • block: Configuration specific to block comments

3. Updated schema generation

   • Changed config = OptionsJson to config = CapitalizedCommentsSchema in declare_oxc_lint!
   • Documentation now properly shows tuple array format matching ESLint
   • Uses /// doc comments instead of #[schemars(description)] attributes per codebase convention

Verification

• ✅ All 886 linter tests pass
• ✅ Configuration parsing works correctly
• ✅ Rule execution verified with test configurations
• ✅ Documentation generation produces correct tuple format
• ✅ No clippy warnings
• ✅ Tested with real configuration file and JavaScript code

Example Generated Documentation

## Configuration

Configuration schema for the rule.
The rule accepts a tuple array configuration: `[capitalize_option, options]`

- First element: `"always"` (default) or `"never"` - controls whether comments should be capitalized
- Second element: Optional object with additional configuration properties

### The 1st option
type: `"always" | "never"`

### The 2nd option
type: `object | null`

Example Configuration

{
  "rules": {
    "capitalized-comments": ["warn", "always", {
      "ignorePattern": "pragma|ignored",
      "ignoreInlineComments": true,
      "ignoreConsecutiveComments": true,
      "line": {
        "ignorePattern": "pragma|ignored"
      },
      "block": {
        "ignorePattern": "ignored"
      }
    }]
  }
}

Original prompt

---

This section details on the original issue you should resolve

<issue_title>linter: capitalized-comments rule has incorrect config option docs</issue_title>
<issue_description>### What version of Oxlint are you using?

0.34.0

What command did you run?

N/A

What does your .oxlintrc.json config file look like?

N/A

What happened?

See the original ESLint rule for comparison: https://eslint.org/docs/latest/rules/capitalized-comments#rule-details

And the format of the options passed in for the rule's tests:

oxc/crates/oxc_linter/src/rules/eslint/capitalized_comments.rs

Lines 873 to 1039 in 853f659

	("// Გ", "// გ", Some(serde_json::json!(["never"]))),
	("// 𑢢", "// 𑣂", Some(serde_json::json!(["never"]))),
	("//* jscs: enable", "//* Jscs: enable", Some(serde_json::json!(["always"]))),
	("//* jscs:disable", "//* Jscs:disable", Some(serde_json::json!(["always"]))),
	("//* eslint-disable-line", "//* Eslint-disable-line", Some(serde_json::json!(["always"]))),
	(
	"//* eslint-disable-next-line",
	"//* Eslint-disable-next-line",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* eslint semi:off */",
	"/*
	* Eslint semi:off */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* eslint-env node */",
	"/*
	* Eslint-env node */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* istanbul ignore next */",
	"/*
	* Istanbul ignore next */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* jshint asi:true */",
	"/*
	* Jshint asi:true */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* jscs: enable */",
	"/*
	* Jscs: enable */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* global var1, var2 */",
	"/*
	* Global var1, var2 */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* global var1:true, var2 */",
	"/*
	* Global var1:true, var2 */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* globals var1, var2 */",
	"/*
	* Globals var1, var2 */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* globals var1:true, var2 */",
	"/*
	* Globals var1:true, var2 */",
	Some(serde_json::json!(["always"])),
	),
	(
	"/*
	* exported myVar */",
	"/*
	* Exported myVar */",
	Some(serde_json::json!(["always"])),
	),
	("foo(/* invalid */a);", "foo(/* Invalid */a);", Some(serde_json::json!(["always"]))),
	(
	"foo(/* invalid */a);",
	"foo(/* Invalid */a);",
	Some(serde_json::json!(["always", { "ignoreInlineComments": false }])),
	),
	(
	"foo(a, // not an inline comment
	b);",
	"foo(a, // Not an inline comment
	b);",
	Some(serde_json::json!(["always", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a, /* not an inline comment */
	b);",
	"foo(a, /* Not an inline comment */
	b);",
	Some(serde_json::json!(["always", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a,
	/* not an inline comment */b);",
	"foo(a,
	/* Not an inline comment */b);",
	Some(serde_json::json!(["always", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a,
	/* not an inline comment */
	b);",
	"foo(a,
	/* Not an inline comment */
	b);",
	Some(serde_json::json!(["always", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a, // Not an inline comment
	b);",
	"foo(a, // not an inline comment
	b);",
	Some(serde_json::json!(["never", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a, /* Not an inline comment */
	b);",
	"foo(a, /* not an inline comment */
	b);",
	Some(serde_json::json!(["never", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a,
	/* Not an inline comment */b);",
	"foo(a,
	/* not an inline comment */b);",
	Some(serde_json::json!(["never", { "ignoreInlineComments": true }])),
	),
	(
	"foo(a,
	/* Not an inline comment */
	b);",
	"foo(a,
	/* not an inline comment */
	b);",
	Some(serde_json::json!(["never", { "ignoreInlineComments": true }])),
	),
	(
	"// not matching",
	"// Not matching",
	Some(serde_json::json!(["always", { "ignorePattern": "ignored?" }])),
	),
	(
	"// Not matching",
	"// not matching",
	Some(serde_json::json!(["never", { "ignorePattern": "ignored?" }])),
	),
	(
	"// should fail. https://github.com",
	"// Should fail. https://github.com",
	Some(serde_json::json!(["always"])),
	),
	(
	"// Should fail. https://github.com",
	"// should fail. https://github.com",
	Some(serde_json::json!(["never"])),
	),
	];

The docs are completely different and very confusing as a result: https://oxc.rs/docs/guide/usage/linter/rules/eslint/capitalized-comments.html#configuration

This rule will need to be updated to use a tuple config and document the options it takes correctly.

Implemented in #16896.</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes linter: capitalized-comments rule has incorrect config option docs #17191

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[codspeed-hq]

CodSpeed Performance Report

Merging #17208 will not alter performance

_{Comparing copilot/fix-capitalized-comments-docs (c159008) with main (529901c)}

Summary

✅ 4 untouched
⏩ 41 skipped¹

Footnotes

1. 41 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

[Copilot]

Pull request overview

This PR fixes the incorrect configuration documentation for the capitalized-comments linter rule to match ESLint's tuple array format.

Key changes:

• Created a dedicated CapitalizedCommentsSchema tuple struct to represent the configuration as [capitalize_option, options]
• Added comprehensive documentation comments to all configuration fields
• Updated the rule declaration to use the new schema for proper documentation generation

---

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

[Copilot]

The deny_unknown_fields attribute is not semantically meaningful for tuple structs. Tuple structs are serialized as arrays with positional elements, not as objects with named fields. This attribute is typically used with named structs to reject JSON objects with unexpected properties. Since this struct is only used for schema generation and not runtime deserialization, consider removing this attribute as it may cause confusion or unexpected schema generation behavior.

Suggested change

#[serde(deny_unknown_fields)]

[connorshea]

I think this is probably true? But my suggestion being applied broke this suggestion so

[connorshea]

Closing in favor of #18748