Skip to content

docs(linter/usage): move installation section above type aware installation #522

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
merged 1 commit into from
Oct 2, 2025
Merged

docs(linter/usage): move installation section above type aware installation #522

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
34 changes: 17 additions & 17 deletions src/docs/guide/usage/linter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,6 @@ and run Oxlint before ESLint in your local or CI setup for a quicker feedback lo
- No support for:
- [stylistic rules](https://eslint.style).

### Type-Aware Linting (Preview)

Oxlint supports type-aware rules in preview mode. To enable type-aware linting:

1. Install the required dependency:
```bash
pnpm add -D oxlint-tsgolint@latest
```

2. Run oxlint with the `--type-aware` flag:
```bash
pnpm dlx oxlint --type-aware
```

For more details and the list of supported type-aware rules, see the
[type-aware linting announcement](/blog/2025-08-17-oxlint-type-aware).

## Installation

Run `oxlint` directly at the root of your repository:
Expand Down Expand Up @@ -114,6 +97,23 @@ $ bun add -D oxlint
`oxlint` does not require Node.js, the binaries can be downloaded from the
[latest GitHub releases](https://github.com/oxc-project/oxc/releases/latest).

### Type-Aware Linting (Preview)

Oxlint supports type-aware rules in preview mode. To enable type-aware linting:

1. Install the required dependency:
```bash
pnpm add -D oxlint-tsgolint@latest
```

2. Run oxlint with the `--type-aware` flag:
```bash
pnpm dlx oxlint --type-aware
```

For more details and the list of supported type-aware rules, see the
[type-aware linting announcement](/blog/2025-08-17-oxlint-type-aware).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Sysix should we link to here? or to https://github.com/oxc-project/oxc-project.github.io/blob/e50f9135876206c239105d7449b5eb01155e142d/src/docs/guide/usage/linter/type-aware.md#L0-L1


## Command-line Interface

See [Command-line Interface](./linter/cli)
Expand Down