Skip to content

docs(linter): Add a note that the typeAware and typeCheck options require oxlint-tsgolint #19940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Mar 3, 2026
Merged

docs(linter): Add a note that the typeAware and typeCheck options require oxlint-tsgolint #19940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions apps/oxlint/src-js/package/config.generated.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,12 +328,16 @@ export interface OxlintOptions {
* Enable rules that require type information.
*
* Equivalent to passing `--type-aware` on the CLI.
*
* Note that this requires the `oxlint-tsgolint` package to be installed.
*/
typeAware?: boolean | null;
/**
* Enable experimental type checking (includes TypeScript compiler diagnostics).
*
* Equivalent to passing `--type-check` on the CLI.
*
* Note that this requires the `oxlint-tsgolint` package to be installed.
*/
typeCheck?: boolean | null;
}
Expand Down
4 changes: 4 additions & 0 deletions crates/oxc_linter/src/config/oxlintrc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,15 @@ pub struct OxlintOptions {
/// Enable rules that require type information.
///
/// Equivalent to passing `--type-aware` on the CLI.
///
/// Note that this requires the `oxlint-tsgolint` package to be installed.
#[serde(skip_serializing_if = "Option::is_none")]
pub type_aware: Option<bool>,
/// Enable experimental type checking (includes TypeScript compiler diagnostics).
///
/// Equivalent to passing `--type-check` on the CLI.
///
/// Note that this requires the `oxlint-tsgolint` package to be installed.
#[serde(skip_serializing_if = "Option::is_none")]
pub type_check: Option<bool>,
/// Ensure warnings produce a non-zero exit code.
Expand Down
8 changes: 4 additions & 4 deletions npm/oxlint/configuration_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,20 +513,20 @@
"markdownDescription": "Specify a warning threshold. Exits with an error status if warnings exceed this value.\n\nEquivalent to passing `--max-warnings` on the CLI."
},
"typeAware": {
"description": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI.",
"description": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed.",
"type": [
"boolean",
"null"
],
"markdownDescription": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI."
"markdownDescription": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed."
},
"typeCheck": {
"description": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI.",
"description": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed.",
"type": [
"boolean",
"null"
],
"markdownDescription": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI."
"markdownDescription": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed."
}
},
"additionalProperties": false,
Expand Down
8 changes: 4 additions & 4 deletions tasks/website_linter/src/snapshots/schema_json.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,20 +517,20 @@ expression: json
"markdownDescription": "Specify a warning threshold. Exits with an error status if warnings exceed this value.\n\nEquivalent to passing `--max-warnings` on the CLI."
},
"typeAware": {
"description": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI.",
"description": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed.",
"type": [
"boolean",
"null"
],
"markdownDescription": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI."
"markdownDescription": "Enable rules that require type information.\n\nEquivalent to passing `--type-aware` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed."
},
"typeCheck": {
"description": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI.",
"description": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed.",
"type": [
"boolean",
"null"
],
"markdownDescription": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI."
"markdownDescription": "Enable experimental type checking (includes TypeScript compiler diagnostics).\n\nEquivalent to passing `--type-check` on the CLI.\n\nNote that this requires the `oxlint-tsgolint` package to be installed."
}
},
"additionalProperties": false,
Expand Down
4 changes: 4 additions & 0 deletions tasks/website_linter/src/snapshots/schema_markdown.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,8 @@ Enable rules that require type information.

Equivalent to passing `--type-aware` on the CLI.

Note that this requires the `oxlint-tsgolint` package to be installed.


### options.typeCheck

Expand All @@ -343,6 +345,8 @@ Enable experimental type checking (includes TypeScript compiler diagnostics).

Equivalent to passing `--type-check` on the CLI.

Note that this requires the `oxlint-tsgolint` package to be installed.


## overrides

Expand Down
Loading