Skip to content
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.

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

docs: improve documentation prior to oxlint beta release #9529

Closed
3 of 7 tasks
Tracked by #5653
camchenry opened this issue Mar 4, 2025 · 2 comments
Closed
3 of 7 tasks
Tracked by #5653

docs: improve documentation prior to oxlint beta release #9529

camchenry opened this issue Mar 4, 2025 · 2 comments
Assignees

Comments

@camchenry
Copy link
Member

camchenry commented Mar 4, 2025

We have not updated the documentation much to reflect the large number of new features released over the last year. Before doing a beta release, we should ensure that the documentation has guides on how to use all of the features available.

  • better general docs on configuration file specification
  • oxlint-disable-* and inline configuration
  • nested configuration
  • extends
  • overrides
  • how to use plugins
  • different formatting / outputs (--format)
@Boshen
Copy link
Member

Boshen commented Mar 13, 2025

For nested configuration, we need to state that the user needs to replace the previous -c .oxlintrc.json argument with --experimental-nested-config. I got confused by this for a second.

@Boshen
Copy link
Member

Boshen commented Mar 13, 2025

The behavior of using extends is really subtle. People may end up not applying the rules they wanted. We need to emphasize this a bit in the doc, and also print some information after running `oxlint.

How does Biome / Ruff deal with extends?

@Boshen Boshen closed this as completed Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants