oxc-project / oxc-project/website
Config-file-reference page not updated for `oxlint.config.ts`
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 101
- Forks
- 114
- Avg merge
- 10h 29m
- Merged PRs (30d)
- 35
Description
PR #886 (closing #880) added documentation for oxlint.config.ts to the Configuration guide, but the Config file reference page was not updated.
The reference page currently:
- Opens with a NOTE saying "Only the
.jsonformat is supported" — which is no longer true - Shows only
.oxlintrc.jsonexamples throughout - Has no mention of
defineConfigor the TypeScript config format - Does not show how each field looks when written in
oxlint.config.ts
Maybe it's worth adding a switcher between different config formats using tabs? Like on https://oxc.rs/docs/guide/usage/linter/quickstart.html#install for switching between npm, pnpm, yarn, bun.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Config file reference and Configuration guide linked in the issue, then inspect the tab switcher example in quickstart.html#install. Update the reference to cover oxlint.config.ts, defineConfig, and the TypeScript form of each field, while correcting the outdated JSON-only note; the page should clearly document both formats.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100