Skip to content

feat(oxlint): introduce defineConfig helper#18596

Merged
graphite-app[bot] merged 1 commit intomainfrom
c/01-26-feat_oxlint_introduce_defineconfig_helper
Feb 1, 2026
Merged

feat(oxlint): introduce defineConfig helper#18596
graphite-app[bot] merged 1 commit intomainfrom
c/01-26-feat_oxlint_introduce_defineconfig_helper

Conversation

@camc314
Copy link
Contributor

@camc314 camc314 commented Jan 26, 2026

No description provided.

@github-actions github-actions bot added A-linter Area - Linter A-cli Area - CLI A-linter-plugins Area - Linter JS plugins C-enhancement Category - New feature or request labels Jan 26, 2026
Copy link
Contributor Author

camc314 commented Jan 26, 2026


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch from 9349081 to 9c0b3ff Compare January 26, 2026 20:06
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from a2e021c to e7a8e8d Compare January 26, 2026 20:06
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch 2 times, most recently from 96f46ab to a1c8987 Compare January 26, 2026 20:17
@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch 2 times, most recently from 74fe512 to 2e27db3 Compare January 26, 2026 20:29
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from a1c8987 to 6366c63 Compare January 26, 2026 20:29
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from 5bb84b9 to c8b3456 Compare January 26, 2026 20:32
@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch 2 times, most recently from 04ba7f4 to 921b8e5 Compare January 26, 2026 20:32
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch 2 times, most recently from 6c30b25 to f79a359 Compare January 27, 2026 00:20
@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch from 921b8e5 to ee81897 Compare January 27, 2026 00:20
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from f79a359 to a657b5a Compare January 27, 2026 00:22
@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch from ee81897 to 0244bda Compare January 27, 2026 00:22
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from a657b5a to b55af5a Compare January 28, 2026 13:39
@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch from 0244bda to abd908c Compare January 28, 2026 13:39
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from b55af5a to acafcdd Compare January 28, 2026 14:04
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from 89f9291 to 3def457 Compare February 1, 2026 22:43
@camc314 camc314 marked this pull request as ready for review February 1, 2026 22:43
Copilot AI review requested due to automatic review settings February 1, 2026 22:43
@camc314
Copy link
Contributor Author

camc314 commented Feb 1, 2026

My only major concern is whether we should consider naming this helper defineExperimentalConfig for now?

To make it explicit and enable us to more easily make breaking changes to this API in the next few releases if necessary.

i think this is fine - if we name it "experimental" it means people have to migrate when we make it non-experimental which is a pain.

@camc314 camc314 added the 0-merge Merge with Graphite Merge Queue label Feb 1, 2026
@camc314 camc314 self-assigned this Feb 1, 2026
Copy link
Contributor Author

camc314 commented Feb 1, 2026

Merge activity

  • Feb 1, 10:45 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Feb 1, 11:19 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Feb 1, 11:26 PM UTC: camc314 added this pull request to the Graphite merge queue.
  • Feb 1, 11:33 PM UTC: Merged by the Graphite merge queue.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request introduces a defineConfig helper function for oxlint configuration files, following the pattern established by similar helpers like definePlugin and defineRule. The helper provides type inference for TypeScript config files while being a no-op at runtime.

Changes:

  • Added defineConfig helper and comprehensive TypeScript type definitions for oxlint configuration
  • Exported the new helper and types from the main index module
  • Added test fixture demonstrating usage of defineConfig with the #oxlint import alias

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
apps/oxlint/src-js/package/config.ts Implements defineConfig helper and defines TypeScript types for oxlint configuration including OxlintConfig, OxlintOverride, and related utility types
apps/oxlint/src-js/index.ts Exports defineConfig function and configuration types from the main entry point
apps/oxlint/test/fixtures/js_config_define_config/oxlint.config.ts Test configuration file demonstrating usage of defineConfig with #oxlint import
apps/oxlint/test/fixtures/js_config_define_config/output.snap.md Expected test output snapshot verifying that defineConfig works correctly
apps/oxlint/test/fixtures/js_config_define_config/files/test.js Test input file with linting violations to validate configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from 3def457 to ed15ead Compare February 1, 2026 22:58
@camc314 camc314 force-pushed the c/01-01-draft_feat_linter_implement_oxlint.config.ts_support branch from 8f924b6 to e4c550b Compare February 1, 2026 22:58
@graphite-app graphite-app bot changed the base branch from c/01-01-draft_feat_linter_implement_oxlint.config.ts_support to graphite-base/18596 February 1, 2026 23:10
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from ed15ead to 12beb45 Compare February 1, 2026 23:15
@camc314 camc314 force-pushed the graphite-base/18596 branch from e4c550b to ea97231 Compare February 1, 2026 23:15
@camc314 camc314 changed the base branch from graphite-base/18596 to c/01-01-draft_feat_linter_implement_oxlint.config.ts_support February 1, 2026 23:16
@graphite-app graphite-app bot changed the base branch from c/01-01-draft_feat_linter_implement_oxlint.config.ts_support to main February 1, 2026 23:17
An error occurred while trying to automatically change base from c/01-01-draft_feat_linter_implement_oxlint.config.ts_support to main February 1, 2026 23:17
@camc314 camc314 closed this Feb 1, 2026
@camc314 camc314 reopened this Feb 1, 2026
@camc314 camc314 force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from 12beb45 to 8c291d3 Compare February 1, 2026 23:19
@graphite-app graphite-app bot force-pushed the c/01-26-feat_oxlint_introduce_defineconfig_helper branch from 8c291d3 to 19b4df7 Compare February 1, 2026 23:27
@graphite-app graphite-app bot merged commit 19b4df7 into main Feb 1, 2026
20 checks passed
@graphite-app graphite-app bot deleted the c/01-26-feat_oxlint_introduce_defineconfig_helper branch February 1, 2026 23:33
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Feb 1, 2026
camc314 added a commit that referenced this pull request Feb 2, 2026
# Oxlint
### 💥 BREAKING CHANGES

- b34a155 linter/plugins: [**BREAKING**] `RuleTester` set
`context.filename` to absolute path (#18702) (overlookmotel)

### 🚀 Features

- 1753209 linter/vscode: Run extension when JS configs are detected
(#18832) (camc314)
- c962dd2 linter/lsp: Implement support for oxlint.config.ts (#18826)
(camc314)
- da32203 linter: Auto generate oxlint.config.ts types (#18597)
(camc314)
- 19b4df7 oxlint: Introduce `defineConfig` helper (#18596) (camc314)
- ea97231 linter: Implement `oxlint.config.ts` support (#17563)
(camc314)
- 17ca42d linter: Implement `react/no-multi-comp` rule. (#18794)
(connorshea)
- 88f30e0 linter/plugins: Move eslint compatible plugin conversion to
`eslintCompatPlugin` function (#18791) (overlookmotel)
- 2a72794 linter/plugins: `RuleTester` take `cwd` property (#18756)
(overlookmotel)
- 9f533db linter: Add `find_prev_token_within` method for token search
(#18769) (camc314)
- 772ea70 linter: Introduce `load_js_configs` napi callback (#18767)
(camc314)
- e9690c1 linter: Introduce `DiscoveredConfig` in preparation for JS
configs (#18674) (camc314)
- 558b588 linter/prefer-namespace-keyword: Move to correctness (#18733)
(camc314)
- 7a5c268 oxlint/lsp: Support `jsPlugins` (#17840) (Sysix)
- c07497c linter/prefer-modern-dom-apis: Implement suggestion (#17965)
(Mikhail Baev)
- 8531bc9 linter: Implement `prefer-const` (#18687) (camchenry)
- 8670b18 parser: Error on ambient class accessor implementations
(#18592) (camc314)
- 6b8a5ae linter: Add `eslint-plugin-import/no-nodejs-modules` rule
(#18006) (Mikhail Baev)
- 04f400d linter/no-duplicates: Add support for `considerQueryString`
option (#18657) (camc314)
- 3b7f260 linter/consistent-generic-constructor: Implement fixer
(#18616) (camc314)
- 794f9e4 linter/prefer-exponentation-operator: Implement suggestion
(#18602) (camc314)
- 773d916 linter: `eslint/sort_keys` ignore leading and trailing spreads
in auto-fix (#18485) (Lonami)
- 20d4ede linter: Implement `import/no-relative-parent-imports` rule
(#18513) (Valentin Maerten)
- 0da45ef vscode: Fallback to globally installed oxlint/oxfmt packages
(#18007) (Sysix)

### 🐛 Bug Fixes

- a3417b1 linter/plugins: Clear state when reloading workspace (#18837)
(overlookmotel)
- c879992 linter: Error on arrays passed in as config (#18822) (camc314)
- 5c80422 linter/tsdown: Ensure relative path for globals import starts
with `./` (#18820) (camc314)
- 7419dfb linter: Remove invalid debug assersion, add test (#18819)
(camc314)
- 0ca6269 ci: Fix the repo path normalization logic for tests on
Windows. (#18815) (connorshea)
- c7b0a65 linter: Fix config option docs for `react/jsx-boolean-value`
rule. (#18811) (connorshea)
- cce374e linter/prefer-const: Replace entire declaration over just the
`let` kw (#18814) (camc314)
- 41f92d1 linter: Error when given config options for a lint rule that
has no config options defined. (#18809) (connorshea)
- 0867a36 linter/consistent-index-object-style: False positive with
mapped + generic types (#18801) (camc314)
- 1d34b42 linter: Fix 32 bit build (#18783) (camc314)
- 95df577 linter/plugins: Handle error from `destroyWorkspace` (#18763)
(overlookmotel)
- b3261dc linter: Fix the curly rule config to enforce the shape of the
config and emit correct docs (#18743) (connorshea)
- d981978 linter/plugins: Use non-blocking mode when calling
`destroyWorkspace` (#18762) (overlookmotel)
- 3f43d4c linter: Accept bools as valid values for `fixable` (#18772)
(camc314)
- 005910a linter/plugins: Support plugins outside of workspace (#18755)
(overlookmotel)
- fd92711 vscode: Use `fsPath` for workspace mapping (#18728) (Sysix)
- 358b2c1 linter/consistent-generic-constructors: Check bounds when
searching for `:` token (#18745) (connorshea)
- abd0c28 linter/capitalized-comments: Fix generated rule option docs
(#18748) (connorshea)
- d90a9f6 linter: Add more tests for `prefer-const`'s fixer and fix its
invalid behavior. (#18747) (connorshea)
- f82011b oxlint/lsp: Disable JS plugins support in LSP except in tests
(#18727) (overlookmotel)
- 94505c8 linter/jest: Change `prefer-spy-on` autofix to suggestion
(#18152) (Ben Lowery)
- 6ec1112 linter: Mark unused disable directive fix as suggestion
(#18703) (ddmoney420)
- 49609ec linter/no-useless-constructor: Consider argument
transformation as used (#18706) (ddmoney420)
- 40218de linter: Fix behavior of
jsx-a11y/no-static-element-interactions rule. (#17817) (connorshea)
- db9751d linter/no-html-link-for-pages: Handle `target=_blank`
correctly (#18693) (camc314)
- e440b78 linter/plugins: Pass all args to CFG event handlers when 2
rules use same handler (#18683) (overlookmotel)
- b393430 linter/curly: Fix multi-or-nest and consistent conflict
(#18660) (camc314)
- 2e1fbc2 linter/plugins: Implement `context.parserPath` (#18644)
(overlookmotel)
- 34951ed linter/plugins: `filename` option takes precedence over
`parserOptions.lang` in `RuleTester` (#18643) (overlookmotel)
- 28df160 linter/plugins: Allow line number passed to `report` to be 0
(#18642) (overlookmotel)
- 14fabec vscode: Use built-in `getWorkspaceFolder` for detecting the
right workspace of a given uri (#18583) (Sysix)
- 0ff4cea oxlint/cli: Report error when nested config could not be
parsed (#18504) (Sysix)

### ⚡ Performance

- 9862224 linter/plugins: Reduce cost of workspaces (#18758)
(overlookmotel)
- 6bc0bde linter: Remove string allocation (#18725) (overlookmotel)
- 3a6b41e linter/plugins: Replace ESLint Traverser with lightweight
traverseNode (#18529) (Rintaro Itokawa)

### 📚 Documentation

- dd1a653 linter: Fix doc comment for ignoreStateless config option.
(#18808) (connorshea)
- 5909085 linter/plugins: Add doc comments (#18753) (overlookmotel)
- ffe53a3 linter: Update lint function docs (#18766) (camc314)
- b82faec linter: Glob for any css module for no-unassigned-import
(#18713) (Ben Stickley)
- cd86347 linter: Mark some react rules as unsupported, misc docs
improvements (#18617) (connorshea)
- 23401d8 linter: Update fixes and suggestions status for tsgolint rules
(#18619) (camchenry)
# Oxfmt
### 🚀 Features

- ee30de9 oxfmt: Add config migration from biome (#18638) (Luca Fischer)

### 🐛 Bug Fixes

- e754b18 oxfmt/migrate-prettier: Set `experimentalSortPackagejson:
false` by default (#18831) (leaysgur)
- a83c266 formatter: Keep decorated function pattern hugged when params
break (#18830) (Dunqing)
- 0c8efe1 formatter: Quote numeric property keys with `quoteProps:
consistent` (#18803) (Dunqing)
- 9c14c3e formatter: Ignore comment does not work for sequence
expressions in arrow function body (#18799) (Dunqing)
- 54984ae formatter: Handle leading comments in arrow function sequence
expressions (#18798) (Dunqing)
- 61bb2b5 formatter: Correctly expand JSX returned from arrow callbacks
in JSX expression containers (#18797) (Dunqing)
- 34ee194 formatter: Tailwindcss sorting doesn't work for object
property keys (#18773) (Dunqing)
- 48f1e35 oxfmt: Prevent ThreadsafeFunction crash on Node.js exit
(#18723) (Boshen)
- e96adca formatter: Follow Prettier's approach for for-in initializer
parentheses (#18695) (Dunqing)
- 1215a6f formatter: Preserve quote for class property key in TypeScript
(#18692) (Dunqing)
- 059acae formatter: Incorrect comments placement for union type in
`TSTypeIntersection` (#18690) (Dunqing)
- c3d05c1 formatter,oxfmt: Handle CRLF with embedded formatting (#18686)
(leaysgur)
- 7cb3085 formatter: Preserve comments on rest elements (#18649)
(Dunqing)
- 21984dd formatter: Preserve type cast comments on rest parameters
(#18648) (Dunqing)
- 2f70254 formatter: Don't add extra semicolon on suppressed class
properties (#18631) (Dunqing)
- ac1ff4e oxfmt: Use `empty_line` IR for empty xxx-in-js line (#18623)
(leaysgur)
- 8f76900 oxfmt: Dedent xxx-in-js templates before calling prettier
(#18622) (leaysgur)
- 6b726ef oxfmt: Trim whitespace only xxx-in-js templates (#18621)
(leaysgur)

Co-authored-by: camc314 <[email protected]>
@Mister-Hope
Copy link

Is there any plan for documentation update? There are so many features that do not appear in docs.

@camc314
Copy link
Contributor Author

camc314 commented Feb 9, 2026

We found a bug where this doesn't work correctly with jsPlugins, so I delayed updating the docs till the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-cli Area - CLI A-linter Area - Linter A-linter-plugins Area - Linter JS plugins C-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments