docs(linter): add note about node version + custom TS plugin by camc314 · Pull Request #19381 · oxc-project/oxc

camc314 · 2026-02-14T10:41:36Z

No description provided.

camc314 · 2026-02-14T10:41:48Z

docs(linter): add note about node version + custom TS plugin #19381 👈 (View in Graphite)
main

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 changes, fast-track this PR to the front of the merge queue

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.

Copilot

Pull request overview

This PR updates the Rustdoc for Oxlintrc configuration to better document JavaScript plugin usage when the plugin source is written in TypeScript.

Changes:

Adds a jsPlugins configuration example using a local .ts plugin file.
Adds a note about the required Node.js version when using TypeScript-based JS plugins.

codspeed-hq · 2026-02-14T10:47:39Z

Merging this PR will not alter performance

✅ 47 untouched benchmarks
⏩ 3 skipped benchmarks¹

_{Comparing c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin (a5ef0de) with main (4baebef)²}

3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
No successful run was found on main (7a333c1) during the generation of this report, so 4baebef was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

Sysix · 2026-02-14T12:24:22Z

@camc314 maybe add examples how do it for lower node versions. I added a doc for oxlint-migrate too :)
https://github.com/oxc-project/oxlint-migrate?tab=readme-ov-file#typescript-eslint-configuration-files

overlookmotel

A comment below about content of the docs.

Broader question: Do we want to officially support plugins written in TS when our types are so shonky at present? (#18154)

crates/oxc_linter/src/config/oxlintrc.rs

camc314 · 2026-03-26T14:04:24Z

Broader question: Do we want to officially support plugins written in TS when our types are so shonky at present? (#18154 question: Do we want to officially support plugins written in TS when our types are so shonky at present? (#18154)

this has been fixed, so this should be OK to merge

camc314 · 2026-03-26T14:05:33Z

Merge activity

Mar 26, 2:05 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Mar 26, 2:07 PM UTC: camc314 added this pull request to the Graphite merge queue.
Mar 26, 2:17 PM UTC: Merged by the Graphite merge queue.

# Oxlint ### 💥 BREAKING CHANGES - c0ebbce linter: [**BREAKING**] Report error on unknown builtin rule (#20464) (camc314) ### 🚀 Features - 04f85e5 linter/no-unused-vars: Add safe-fix option for import fixes (#20839) (Marcell Toth) - 32a3706 linter/eslint-vitest-plugin: Implements `require-test-timeout` rule (#20806) (Said Atrahouch) - ae03653 linter: Implement suggestion for `eslint/no-useless-computed-key` rule (#20805) (Mikhail Baev) - 6624513 linter/prefer-string-starts-ends-with: Move rule from nursery to style (#20797) (camc314) - 58941f8 linter/prefer-readonly: Move rule from nursery to style (#20796) (camc314) - 8837ffd linter/prefer-regexp-exec: Move rule from nursery to style (#20795) (camc314) - 7e88871 linter/prefer-find: Move rule out of nursery (#20794) (camc314) - ca6e5bc linter/vitest: Implement prefer-called-exactly-once-with (#17562) (Said Atrahouch) - e80c0bf linter/eslint-plugin-vitest: Implement `require-mock-type-parameters` (#20785) (Said Atrahouch) - cec8b8f linter/vitest: Implement require-awaited-expect-poll rule (#20702) (Said Atrahouch) - d8e9d01 linter/eslint-plugin-vitest: Set `prefer-to-have-been-called-times` compatible with jest (#20703) (Said Atrahouch) - caf8231 linter: Enhance import plugin diagnostics with help messages (#20766) (离谱) - f44adfa linter: Improve the oxlint config generated by `--init`. (#20632) (connorshea) - 43f4827 linter: Add help text to jest and promise diagnostics (#20640) (kszongic) - 16516de linter: Enhance types for `DummyRule` (#20751) (camc314) - 27374e8 linter: Add hint about node version when ts config fail to import (#20570) (camc314) - 8e34150 linter/eslint-plugin-vitest: Sync rule with JS implementation (#20679) (Said Atrahouch) ### 🐛 Bug Fixes - df057d5 linter/no-noninteractive-tabindex: Add missing composite widget … (#20860) (bab) - bb34073 linter: Mark vitest/valid-title as a compatible jest rules (#20463) (Nicolas Le Cam) - bd2c76b linter: Handle shadowed locals in no-restricted-globals (#20811) (Ulrich Stark) - 62e39be linter: Sort nested object keys in fix of `eslint/sort-keys` in one pass (#20838) (Ulrich Stark) - 3ef37da oxlint/lsp: Error on unknown command (#20841) (Sysix) - ab1070d oxlint/cli: Skip parsing base config again for nested config search (#20809) (Sysix) - 2be3728 oxlint/lsp: Skip parsing base config again for nested config search (#20808) (Sysix) - 6171217 oxlint: Respect `NO_COLOR` env for `format=stylish` (#20804) (Sysix) - d89ae8f linter/plugins: Patch `WeakMap` to emulate `WeakMap`s keyed by `sourceCode` (#20799) (overlookmotel) - c610666 linter/no-shadow: Respect env settings when builtinGlobals is enabled (#20429) (vvnikita74) - 6bb502f linter/no-invalid-void-type: Allow void generic args in heritage clauses (#20780) (camc314) - 365bb7d linter: Skip typed nested literals in explicit-module-boundary-types (#20776) (camc314) - 0aa1ff0 linter/plugins: Ensure `after` hook is always called in ESLint compat mode (#20721) (overlookmotel) - 31145a9 linter/plugins: Fire `after` hook after CFG events in ESLint compat (#20720) (overlookmotel) - c09a5ab diagnostics: Skip minified fallback for single-line reporters (#20716) (camc314) - e4dc9a1 linter: Isolate `--init` config writes from parallel tests (#20717) (camc314) - 7e394ec linter: Clarify empty replacement fixer help text (#20698) (camc314) - d15a99c linter/jsx-curly-brace-presence: Flag empty string literals (#20690) (camc314) ### 📚 Documentation - c722495 linter: Update JS Plugins + LS references (#20843) (camc314) - e1f9748 linter/jsdoc/require-property: Fix typo (#20792) (Benjaming61001) - be3dcc1 linter: Add note about node version + custom TS plugin (#19381) (camc314) # Oxfmt ### 🚀 Features - 6ef440a oxfmt: Support bool for object style options (#20853) (leaysgur) - 23050fa oxfmt: Support markdown-in-js substitution (#20683) (leaysgur) - 4087295 oxfmt: Support angular-in-js substitution (#20676) (leaysgur)

github-actions bot added A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation labels Feb 14, 2026

camc314 assigned overlookmotel Feb 14, 2026

camc314 marked this pull request as ready for review February 14, 2026 10:42

Copilot AI review requested due to automatic review settings February 14, 2026 10:42

Copilot started reviewing on behalf of camc314 February 14, 2026 10:42 View session

Copilot AI reviewed Feb 14, 2026

View reviewed changes

camc314 force-pushed the c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin branch from f9e3100 to a398c5f Compare February 14, 2026 10:49

camc314 force-pushed the c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin branch from a398c5f to a5ef0de Compare February 14, 2026 15:07

overlookmotel reviewed Feb 16, 2026

View reviewed changes

crates/oxc_linter/src/config/oxlintrc.rs Outdated Show resolved Hide resolved

camc314 assigned camc314 and unassigned overlookmotel and camc314 Mar 26, 2026

camc314 force-pushed the c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin branch from a5ef0de to fbde44b Compare March 26, 2026 14:03

camc314 added 0-merge Merge with Graphite Merge Queue labels Mar 26, 2026

graphite-app bot pushed a commit that referenced this pull request Mar 26, 2026

docs(linter): add note about node version + custom TS plugin (#19381)

d03893f

graphite-app bot force-pushed the c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin branch from fbde44b to d03893f Compare March 26, 2026 14:08

docs(linter): add note about node version + custom TS plugin (#19381)

be3dcc1

graphite-app bot force-pushed the c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin branch from d03893f to be3dcc1 Compare March 26, 2026 14:13

graphite-app bot merged commit be3dcc1 into main Mar 26, 2026
26 checks passed

graphite-app bot deleted the c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin branch March 26, 2026 14:17

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Mar 26, 2026

Boshen mentioned this pull request Mar 30, 2026

release(apps): oxlint v1.58.0 && oxfmt v0.43.0 #20867

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(linter): add note about node version + custom TS plugin#19381

docs(linter): add note about node version + custom TS plugin#19381
graphite-app[bot] merged 1 commit intomainfrom
c/02-14-docs_linter_add_note_about_node_version_custom_ts_plugin

camc314 commented Feb 14, 2026

Uh oh!

camc314 commented Feb 14, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

codspeed-hq bot commented Feb 14, 2026 •

edited

Loading

Uh oh!

Sysix commented Feb 14, 2026

Uh oh!

overlookmotel left a comment •

edited

Loading

Uh oh!

Uh oh!

camc314 commented Mar 26, 2026

Uh oh!

camc314 commented Mar 26, 2026 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

camc314 commented Feb 14, 2026

Uh oh!

camc314 commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

codspeed-hq bot commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

Sysix commented Feb 14, 2026

Uh oh!

overlookmotel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camc314 commented Mar 26, 2026

Uh oh!

camc314 commented Mar 26, 2026 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

camc314 commented Feb 14, 2026 •

edited

Loading

codspeed-hq bot commented Feb 14, 2026 •

edited

Loading

overlookmotel left a comment •

edited

Loading

camc314 commented Mar 26, 2026 •

edited by graphite-app bot

Loading