oxc-project / oxc-project/website

[Linter] Refinement of the description of `overrides[n].files`

Open
#360 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
101
Forks
114
Avg merge
10h 29m
Merged PRs (30d)
35

Description

Eslint v8's glob pattern uses minimatch syntax, while oxlint's glob pattern uses globset, a difference that may cause some problems for users migrating from Eslint.

I would suggest that users be explicitly reminded of this discrepancy in the documentation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation for the linter's overrides[n].files setting and review the existing glob-pattern description alongside the linked minimatch and globset references. Done means the documentation explicitly warns users migrating from ESLint that the two glob syntaxes differ.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.