feat(linter/plugins): add @oxlint/plugins NPM package#18824
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via 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. |
3bd2abd to
3d8c84d
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a new @oxlint/plugins NPM package as an alternative solution to #18796 and part of #18610. The package provides plugin utilities (definePlugin, defineRule, and eslintCompatPlugin functions) along with TypeScript types for creating Oxlint JS plugins. This package has no dependency on oxlint, which solves the problem of plugins having an unnecessary runtime dependency when used with ESLint.
Changes:
- Created
@oxlint/pluginspackage withdefinePlugin,defineRule, andeslintCompatPluginfunctions plus type definitions - Added separate TSDown build configuration to generate files for this package from
src-js/plugins.ts - Updated build script to move generated files from
dist-pkg-pluginstonpm/oxlint-pluginsdirectory
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| npm/oxlint-plugins/package.json | Package configuration for new @oxlint/plugins package with version 1.42.0 |
| npm/oxlint-plugins/index.js | Minified CommonJS bundle with definePlugin, defineRule, and eslintCompatPlugin functions |
| npm/oxlint-plugins/index.d.ts | TypeScript definitions (~4000 lines) for plugin API, including ESTree types and all utility types |
| npm/oxlint-plugins/README.md | Documentation for the package with usage examples |
| npm/oxlint-plugins/CHANGELOG.md | Initial changelog entry |
| apps/oxlint/tsdown.config.ts | Added build configuration for @oxlint/plugins package |
| apps/oxlint/scripts/build.ts | Added step to copy built files to npm/oxlint-plugins directory |
| apps/oxlint/src-js/index.ts | Updated deprecation notices to reference @oxlint/plugins |
| oxlintrc.json | Added npm/oxlint-plugins/** to ignored paths |
| oxfmtrc.jsonc | Added generated files to ignored paths |
| apps/oxlint/.gitignore | Added /dist-pkg-plugins/ to ignored directories |
| pnpm-lock.yaml | Added workspace entry for new package |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
3d8c84d to
57d8045
Compare
57d8045 to
9938dc4
Compare
76d5efd to
96372ff
Compare
9938dc4 to
576ad0e
Compare
Merge activity
|
Alternative to #18796. Part of #18610. ## Overview Add `@oxlint/plugins` package. `@oxlint/plugins` package has no dependency on `oxlint`, which solves the problem raised in #18796 (comment), and is also what we wanted in the end anyway. We don't actually want plugins packages to have to depend on `oxlint`. ## Differences from other Oxc packages This package is different from all our other packages, in that it's intended to work not only with Oxlint's ecosystem, but also with ESLint's ecosystem. `@oxlint/plugins` will be a *runtime* dependency of plugin packages that the community create, and they may want their plugin to be compatible with both Oxlint and ESLint - this package provides the `eslintCompatPlugin` function for exactly this purpose. Our aim is to allow plugin authors to migrate from ESLint's `create` API to Oxlint's `createOnce` API with minimum friction, and without breaking changes for their users: 1. Their plugin should remain compatible with ESLint. 2. They do not need to alter the versions of NodeJS they support (no change to `engines` field in `package.json`). 3. They can continue to publish their plugin as a CommonJS package, if that's the format they currently use. ## Package composition Due to these requirements, the make-up of `@oxlint/plugins` is different from our other packages: ### Dual Format This package is in "dual package" format, with both ESM and CommonJS entry points. ### Older NodeJS versions support This package supports NodeJS versions back to v12.22.0. https://github.com/oxc-project/oxc/blob/9938dc476f8533b7011af03cdbac328b0d00d344/npm/oxlint-plugins/package.json#L40-L42 This matches `engines` field in all ESLint 8.x.x releases: * 8.0.0: https://www.npmjs.com/package/eslint/v/8.0.0?activeTab=code * 8.57.1: https://www.npmjs.com/package/eslint/v/8.57.1?activeTab=code Therefore, `@oxlint/plugins` can be used by any plugin which supports ESLint 8 or later. Note: Download counts for ESLint 8 are still roughly equal to ESLint 9, even though v9 was released 2 years ago. #### Notes * Changing `target` in TSDown to `"node12"` does not result in any changes to built files. See 3rd commit in this PR. * `exports` field in `package.json` is supported (without experimental flag) from NodeJS v12.17.0 + v14.0.0. * `.cjs` file extension supported from NodeJS v12.0.0. ## Building the package This PR adds 2 extra builds to TSDown config, which generate the files for the package. `build.ts` script moves the files into `npm/oxlint-plugins` directory. Later on, we'll move the logic for moving the files into the CI release workflow, so we don't need to check the generated build files into Git. ## `@oxlint/plugins-dev` In #18610 we decided to also add an `@oxlint/plugins-dev` to contain `RuleTester`, so we can move that out of `oxlint` package. This PR *does not* add that package. I've skipped that for now as (a) it's trickier and (b) it's much less important.
96372ff to
b7416d0
Compare
576ad0e to
9fd3bd6
Compare
Follow-on after #18824. Refactor only. Simplify building `@oxlint/plugins` package. Generate both the ESM and CommonJS builds in the same directory.
Continuation of #18824, #18828, #18903. Remove the `oxlint/plugins` export and the `plugins.ts` entry point. These are now only used in tests, where the files can be loaded from `dist-pkg-plugins` instead. We don't want to encourage people to use `oxlint/plugins` in their plugins - they should be using `@oxlint/plugins` package instead to avoid their plugin having a dependency on `oxlint`. Due to less shared dependencies between files, this results in 5 less files in `dist` directory in release build. This also allows re-enabling the debug assertions in this code in tests.
# Oxlint ### 🚀 Features - aef2af5 linter/unicorn: Add fixer for `unicorn/relative-url-style` rule (#19186) (Mikhail Baev) - 80eba6f linter/max-params: Support `countThis` option (#19175) (camc314) - e19bc45 linter/no-new-func: Improve rule diagnostic with note and actionable help message (#19132) (Sean Gallen) - e3dc5f6 linter/plugins: `RuleTester` test suggestions (#19104) (overlookmotel) - 6054249 linter/plugins: Add `recursive` option to `RuleTester` (#19093) (overlookmotel) - 27c241b linter/plugins: `RuleTester` test fixes (#19091) (overlookmotel) - 7318275 linter/new-cap: Tighten diagnostic spans and add help text (#19131) (camchenry) - ac2b16b linter: Improve `no-misleading-character-class` diagnostic spans (#19109) (Sysix) - 7be8613 linter: Move `no-misleading-chracter-class` to `correctness` (#19006) (Sysix) - 87a920d ci: Add riscv64 and s390x napi targets for oxlint and oxfmt (#19039) (Boshen) - ee2925b oxlint/lsp: Enable JS plugins (#18834) (overlookmotel) - 533013d linter/unicorn: Implement suggestion for `unicorn/prefer-dom-node-dataset` (#19051) (Mikhail Baev) - 384abae linter/oxc/no-async-endpoint-handlers: Improve diagnostic message (#19001) (camc314) - d35ece3 linter/array-callback-return: Improve diagnostic hints for some cases (#18993) (camc314) - dd0f754 linter/array-callback-return: Improve diagnostic message for `forEach` case (#18992) (camc314) - e2d28fe linter/plugins: Implement suggestions (#18963) (overlookmotel) - a398152 linter: Promote the `eslint/no-iterator` rule to correctness, which makes it a default rule (#18915) (connorshea) - bb1eb97 linter: Improve diagnostic message for circular configs (#18947) (camc314) - 3184f36 linter: Ban relative js plugin specifiers in js extends config (#18944) (camc314) - 749972f linter: Validate dynamic config extends shape (#18943) (camc314) - b270739 linter: Support extends in oxlint.config.ts (#18942) (camc314) - 6024ddf linter: Implement suggestion for `unicorn/prefer-reflect-apply` (#18932) (Mikhail Baev) - b06b3a9 linter: Implement `typescript/consistent-type-assertions` (#18869) (Bazyli Brzóska) - 9fd3bd6 linter/plugins: Add `@oxlint/plugins` NPM package (#18824) (overlookmotel) - 5ee7b2f linter/vitest: Implements `prefer-expect-type-of` rule (#17957) (Said Atrahouch) - a7b360a linter/unicorn: Implement `unicorn/relative-url-style` rule (#18857) (Mikhail Baev) - 9788a96 oxlint,oxfmt: Add more native builds (#18853) (Boshen) - b23395a linter: Enforce exporting an object with `defineConfig` (#18858) (camc314) ### 🐛 Bug Fixes - 7800fc5 linter/prefer-event-target: Ignore EventEmitter imported from packages (#19188) (camc314) - 03b2955 linter/typescript/ban-types: Mark rule as deprecated (#19179) (camc314) - a5b8766 oxlint/lsp: Disable rule for this line should not be preferred (#19083) (Sysix) - e08157e linter/jsx-filename-extension: Include filename in as-needed diagnostic (#19172) (camc314) - 1773acb oxlint: Re-generate envs (#19169) (camc314) - 51c3fc8 linter/no-array-for-each: Skip `Effect.forEach` calls (#19127) (camc314) - 825f148 linter/plugins: `RuleTester` consider adjacent fixes as overlapping in ESLint compat mode (#19094) (overlookmotel) - ecd2456 linter/plugins: Handle fix with -1 offsets in file with BOM (#19092) (overlookmotel) - 5969d26 linter/no-array-sort: Avoid false positives for effect Chunk.sort (#19125) (camc314) - de10f04 linter: `no-misleading-character-class`: do not skip reporting on first invalid sequence of the checking group (#19111) (Sysix) - 8c0ce78 linter: Scope no-misleading-character-class sequences to single character class (#19108) (copilot-swe-agent) - 879e3a0 linter: `no-misleading-character-class`: split sequences on all `CharacterSet` (#19107) (Sysix) - 2ad33cc oxlint/lsp: Search parent directories for root oxlint config (#19062) (copilot-swe-agent) - f969d5e linter/prefer-dom-node-dataset: Address some edge cases in the fixer (#19065) (camc314) - ed759d1 linter/plugins: Fix error messages for invalid suggestions (#19059) (overlookmotel) - 34851a7 linter/plugins: Error not panic if invalid fix range (#19058) (overlookmotel) - 4823b58 linter/plugins: Fix fixes in files with BOM (#19056) (overlookmotel) - 2ef405e linter/no-map-spread: Improve actionability of error message (#19007) (Artyom Alekseevich) - 56c086b parser: Add modifier ordering validation (TS1029) (#19024) (Boshen) - 6067a49 linter/jsdoc: False positive in `check-tag-names` for `@` in email addresses and npm scopes (#19021) (Boshen) - 6d46ed9 linter/capitalized-comments: Ignore prettier and oxfmt directives (#19008) (Artyom Alekseevich) - a46c878 linter/react/no-array-index-key: Look for keys in expressions (#18997) (camc314) - 7d61704 linter/prefer-at: Skip autofix for `arguments` (#18991) (camc314) - 3ebae53 linter/preserve-caught-error: Skip traversing into nested try/catch stmts (#18990) (camc314) - e94d37e linter/react/no-unknown-property: Add missing `popover` related props (#18953) (Christoph Nakazawa) - 04b0d99 linter: Normalize relative paths with `./` prefix in overrides. (#18954) (connorshea) - 57917ee parser: Parse decorators on rest parameters (#18938) (Boshen) - 07742ea linter/prefer-as-const: Implement fixer for type annotation (#18899) (camc314) - d64bfdd linter/plugins: Ensure `after` hook always runs last in rule converted for ESLint (#18904) (overlookmotel) - ec39944 linter/jsx-a11y/no-distracting-elements: Support elements option (#18892) (camc314) - f609cb6 linter/prefer-expect-type-of: Handle computed elements in fixer correctly (#18890) (camc314) - ecf11e5 linter/dynamic-config: Set `ExternalPlugin.config_dir` to fix js plugins loading (#18854) (camc314) - 01b7838 linter/plugins: Do not destroy workspaces (#18833) (overlookmotel) - dc51d6b linter: Normalize paths slashes for snapshots on windows (#18825) (camc314) - dbfdc40 linter/bad-replace-all-args: Skip extracting flags from conditional expressions (#18844) (camc314) ### ⚡ Performance - ed8c054 oxc_str: Add precomputed hash to Ident for fast HashMap lookups (#19143) (Boshen) - 18f58bd oxlint/lsp: Transform unused disable directive directly to DiagnosticReport (#19112) (Sysix) - 4ce3772 linter: Remove pointless string cloning when combining suggestions (#19075) (overlookmotel) - c417bf5 linter: Avoid allocating `Vec` when compiling `PossibleFixes` (#19074) (overlookmotel) - adb2baa linter/plugins: Avoid allocation when rule provides single suggestion (#19071) (overlookmotel) - 2537924 semantic: Optimize scope resolution with fast paths and inlining (#19029) (Boshen) ### 📚 Documentation - 6e8ef38 linter/plugins: Correct and expand JSDoc comment for `RuleTester` config (#19156) (overlookmotel) - e7ec06a linter: Improve docs for `import/max-dependencies` rule. (#19119) (connorshea) - 367f730 linter/consistent-test-filename: Escape file names fixes #19114 (#19123) (camc314) - 8753a54 linter: Rewrite the docs for the `jsx-a11y/no-redundant-roles` rule. (#19117) (connorshea) - dd44b1a linter: Fix invalid directive in example code for `import/no-nodejs-modules`. (#19115) (connorshea) - 726e273 linter/plugins: Improve JSDoc comment for `DiagnosticReport` (#19103) (overlookmotel) - 9561e7f linter/plugins: Alter JS plugins example (#18900) (overlookmotel) - 501e3b6 linter: Regenerate `config.generated.ts` (#18897) (overlookmotel) - b425a0c linter: Document jsPlugins examples (#18671) (Cameron) - df2b7fa linter: Expand settings example with reference to custom plugins (#18670) (camc314) # Oxfmt ### 💥 BREAKING CHANGES - 856a01f formatter/sort_imports: [**BREAKING**] Replace prefix match with glob pattern in `customGroups.elementNamePattern` (#19066) (leaysgur) ### 🚀 Features - 91e67f3 oxfmt/lsp: Do not refer `.gitignore` (#19206) (leaysgur) - 23c0753 oxfmt: Better Tailwind CSS intergration (#19000) (Dunqing) - 87a920d ci: Add riscv64 and s390x napi targets for oxlint and oxfmt (#19039) (Boshen) - 8536dce oxfmt: Support glob for CLI paths (#18976) (leaysgur) - 6ee2d59 oxfmt: Use `oxc_formatter` in js-in-xxx part (#18373) (leaysgur) - 9788a96 oxlint,oxfmt: Add more native builds (#18853) (Boshen) ### 🐛 Bug Fixes - 119348b oxfmt: Resolve relative -> absolute path for other usages (#19207) (leaysgur) - 5f4cf30 oxfmt: Fix relative -> absolute path resolution with refactoring (#19202) (leaysgur) - dc335d1 oxfmt: Temporarily disable the override for js-in-xxx (not ready yet) (#19043) (leaysgur) - 5ea5bda oxfmt: Handle `isSingleJsxExpressionStatementInMarkdown()` check for js-in-md (#19042) (leaysgur) - 5243307 formatter: Preserve numeric separators in number literals (#19015) (Dunqing) - 9b205b3 formatter: Fallback to formatting when package.json sorting fails (#19097) (Boshen) - b79c065 formatter: Preserve comment between callee and optional chaining operator (#19020) (Dunqing) - 01d1be1 formatter: Remove unnecessary parentheses for single-member union types (#19018) (Dunqing) - f5c7e75 formatter: Preserve parentheses around await with private field access (#19014) (Dunqing) - 5a75785 formatter: Preserve parentheses around nested sequence expressions (#19013) (Dunqing) - f39c96c oxfmt: Do not override `babel-ts` for now (#19030) (leaysgur) - 0ef11bb formatter: Add space before type annotation with leading comment (#19012) (Dunqing) - cc232e1 formatter: Keep spread with callback on same line (#18999) (Dunqing) - ef5bfab oxfmt: Workaround Node.js ThreadsafeFunction cleanup race condition (#18980) (Boshen) - d53f5c4 formatter: Require string first arg in test calls (#18935) (Dunqing) - 57917ee parser: Parse decorators on rest parameters (#18938) (Boshen) - 2db8c05 formatter: Avoid breaking generic call assignments (#18933) (Dunqing) - 1e023e1 formatter: Preserve trailing comma in mts/cts arrow generics (#18928) (Dunqing) - 7c4e558 formatter/detect_code_removal: Do not count `TemplateLiteral` content (#18848) (leaysgur) ### ⚡ Performance - 467724f oxfmt: Collect glob paths in parallel (#19209) (leaysgur) - 61e0efa oxfmt: Use RwLock instead of Mutex for TSFN handles (#18888) (Boshen) Co-authored-by: camc314 <[email protected]>
…kage (#19234) #18824 added a `@oxlint/plugins` NPM package, and #18903 altered the release workflow. It seems neither worked correctly - the package hasn't been getting published during the release process. It's still on version 1.43.0 on NPM: https://www.npmjs.com/package/@oxlint/plugins This PR alters the pre-release and release workflows to (hopefully) bump version of this package and release it alongside `oxlint` package. There have been no changes to content of `@oxlint/plugins` package since the last published version, and it has no dependencies, so it doesn't really matter that we've skipped these releases. But this PR should get it publishing correctly from next release onwards.
# Oxlint ### 🚀 Features - aef2af5 linter/unicorn: Add fixer for `unicorn/relative-url-style` rule (oxc-project#19186) (Mikhail Baev) - 80eba6f linter/max-params: Support `countThis` option (oxc-project#19175) (camc314) - e19bc45 linter/no-new-func: Improve rule diagnostic with note and actionable help message (oxc-project#19132) (Sean Gallen) - e3dc5f6 linter/plugins: `RuleTester` test suggestions (oxc-project#19104) (overlookmotel) - 6054249 linter/plugins: Add `recursive` option to `RuleTester` (oxc-project#19093) (overlookmotel) - 27c241b linter/plugins: `RuleTester` test fixes (oxc-project#19091) (overlookmotel) - 7318275 linter/new-cap: Tighten diagnostic spans and add help text (oxc-project#19131) (camchenry) - ac2b16b linter: Improve `no-misleading-character-class` diagnostic spans (oxc-project#19109) (Sysix) - 7be8613 linter: Move `no-misleading-chracter-class` to `correctness` (oxc-project#19006) (Sysix) - 87a920d ci: Add riscv64 and s390x napi targets for oxlint and oxfmt (oxc-project#19039) (Boshen) - ee2925b oxlint/lsp: Enable JS plugins (oxc-project#18834) (overlookmotel) - 533013d linter/unicorn: Implement suggestion for `unicorn/prefer-dom-node-dataset` (oxc-project#19051) (Mikhail Baev) - 384abae linter/oxc/no-async-endpoint-handlers: Improve diagnostic message (oxc-project#19001) (camc314) - d35ece3 linter/array-callback-return: Improve diagnostic hints for some cases (oxc-project#18993) (camc314) - dd0f754 linter/array-callback-return: Improve diagnostic message for `forEach` case (oxc-project#18992) (camc314) - e2d28fe linter/plugins: Implement suggestions (oxc-project#18963) (overlookmotel) - a398152 linter: Promote the `eslint/no-iterator` rule to correctness, which makes it a default rule (oxc-project#18915) (connorshea) - bb1eb97 linter: Improve diagnostic message for circular configs (oxc-project#18947) (camc314) - 3184f36 linter: Ban relative js plugin specifiers in js extends config (oxc-project#18944) (camc314) - 749972f linter: Validate dynamic config extends shape (oxc-project#18943) (camc314) - b270739 linter: Support extends in oxlint.config.ts (oxc-project#18942) (camc314) - 6024ddf linter: Implement suggestion for `unicorn/prefer-reflect-apply` (oxc-project#18932) (Mikhail Baev) - b06b3a9 linter: Implement `typescript/consistent-type-assertions` (oxc-project#18869) (Bazyli Brzóska) - 9fd3bd6 linter/plugins: Add `@oxlint/plugins` NPM package (oxc-project#18824) (overlookmotel) - 5ee7b2f linter/vitest: Implements `prefer-expect-type-of` rule (oxc-project#17957) (Said Atrahouch) - a7b360a linter/unicorn: Implement `unicorn/relative-url-style` rule (oxc-project#18857) (Mikhail Baev) - 9788a96 oxlint,oxfmt: Add more native builds (oxc-project#18853) (Boshen) - b23395a linter: Enforce exporting an object with `defineConfig` (oxc-project#18858) (camc314) ### 🐛 Bug Fixes - 7800fc5 linter/prefer-event-target: Ignore EventEmitter imported from packages (oxc-project#19188) (camc314) - 03b2955 linter/typescript/ban-types: Mark rule as deprecated (oxc-project#19179) (camc314) - a5b8766 oxlint/lsp: Disable rule for this line should not be preferred (oxc-project#19083) (Sysix) - e08157e linter/jsx-filename-extension: Include filename in as-needed diagnostic (oxc-project#19172) (camc314) - 1773acb oxlint: Re-generate envs (oxc-project#19169) (camc314) - 51c3fc8 linter/no-array-for-each: Skip `Effect.forEach` calls (oxc-project#19127) (camc314) - 825f148 linter/plugins: `RuleTester` consider adjacent fixes as overlapping in ESLint compat mode (oxc-project#19094) (overlookmotel) - ecd2456 linter/plugins: Handle fix with -1 offsets in file with BOM (oxc-project#19092) (overlookmotel) - 5969d26 linter/no-array-sort: Avoid false positives for effect Chunk.sort (oxc-project#19125) (camc314) - de10f04 linter: `no-misleading-character-class`: do not skip reporting on first invalid sequence of the checking group (oxc-project#19111) (Sysix) - 8c0ce78 linter: Scope no-misleading-character-class sequences to single character class (oxc-project#19108) (copilot-swe-agent) - 879e3a0 linter: `no-misleading-character-class`: split sequences on all `CharacterSet` (oxc-project#19107) (Sysix) - 2ad33cc oxlint/lsp: Search parent directories for root oxlint config (oxc-project#19062) (copilot-swe-agent) - f969d5e linter/prefer-dom-node-dataset: Address some edge cases in the fixer (oxc-project#19065) (camc314) - ed759d1 linter/plugins: Fix error messages for invalid suggestions (oxc-project#19059) (overlookmotel) - 34851a7 linter/plugins: Error not panic if invalid fix range (oxc-project#19058) (overlookmotel) - 4823b58 linter/plugins: Fix fixes in files with BOM (oxc-project#19056) (overlookmotel) - 2ef405e linter/no-map-spread: Improve actionability of error message (oxc-project#19007) (Artyom Alekseevich) - 56c086b parser: Add modifier ordering validation (TS1029) (oxc-project#19024) (Boshen) - 6067a49 linter/jsdoc: False positive in `check-tag-names` for `@` in email addresses and npm scopes (oxc-project#19021) (Boshen) - 6d46ed9 linter/capitalized-comments: Ignore prettier and oxfmt directives (oxc-project#19008) (Artyom Alekseevich) - a46c878 linter/react/no-array-index-key: Look for keys in expressions (oxc-project#18997) (camc314) - 7d61704 linter/prefer-at: Skip autofix for `arguments` (oxc-project#18991) (camc314) - 3ebae53 linter/preserve-caught-error: Skip traversing into nested try/catch stmts (oxc-project#18990) (camc314) - e94d37e linter/react/no-unknown-property: Add missing `popover` related props (oxc-project#18953) (Christoph Nakazawa) - 04b0d99 linter: Normalize relative paths with `./` prefix in overrides. (oxc-project#18954) (connorshea) - 57917ee parser: Parse decorators on rest parameters (oxc-project#18938) (Boshen) - 07742ea linter/prefer-as-const: Implement fixer for type annotation (oxc-project#18899) (camc314) - d64bfdd linter/plugins: Ensure `after` hook always runs last in rule converted for ESLint (oxc-project#18904) (overlookmotel) - ec39944 linter/jsx-a11y/no-distracting-elements: Support elements option (oxc-project#18892) (camc314) - f609cb6 linter/prefer-expect-type-of: Handle computed elements in fixer correctly (oxc-project#18890) (camc314) - ecf11e5 linter/dynamic-config: Set `ExternalPlugin.config_dir` to fix js plugins loading (oxc-project#18854) (camc314) - 01b7838 linter/plugins: Do not destroy workspaces (oxc-project#18833) (overlookmotel) - dc51d6b linter: Normalize paths slashes for snapshots on windows (oxc-project#18825) (camc314) - dbfdc40 linter/bad-replace-all-args: Skip extracting flags from conditional expressions (oxc-project#18844) (camc314) ### ⚡ Performance - ed8c054 oxc_str: Add precomputed hash to Ident for fast HashMap lookups (oxc-project#19143) (Boshen) - 18f58bd oxlint/lsp: Transform unused disable directive directly to DiagnosticReport (oxc-project#19112) (Sysix) - 4ce3772 linter: Remove pointless string cloning when combining suggestions (oxc-project#19075) (overlookmotel) - c417bf5 linter: Avoid allocating `Vec` when compiling `PossibleFixes` (oxc-project#19074) (overlookmotel) - adb2baa linter/plugins: Avoid allocation when rule provides single suggestion (oxc-project#19071) (overlookmotel) - 2537924 semantic: Optimize scope resolution with fast paths and inlining (oxc-project#19029) (Boshen) ### 📚 Documentation - 6e8ef38 linter/plugins: Correct and expand JSDoc comment for `RuleTester` config (oxc-project#19156) (overlookmotel) - e7ec06a linter: Improve docs for `import/max-dependencies` rule. (oxc-project#19119) (connorshea) - 367f730 linter/consistent-test-filename: Escape file names fixes oxc-project#19114 (oxc-project#19123) (camc314) - 8753a54 linter: Rewrite the docs for the `jsx-a11y/no-redundant-roles` rule. (oxc-project#19117) (connorshea) - dd44b1a linter: Fix invalid directive in example code for `import/no-nodejs-modules`. (oxc-project#19115) (connorshea) - 726e273 linter/plugins: Improve JSDoc comment for `DiagnosticReport` (oxc-project#19103) (overlookmotel) - 9561e7f linter/plugins: Alter JS plugins example (oxc-project#18900) (overlookmotel) - 501e3b6 linter: Regenerate `config.generated.ts` (oxc-project#18897) (overlookmotel) - b425a0c linter: Document jsPlugins examples (oxc-project#18671) (Cameron) - df2b7fa linter: Expand settings example with reference to custom plugins (oxc-project#18670) (camc314) # Oxfmt ### 💥 BREAKING CHANGES - 856a01f formatter/sort_imports: [**BREAKING**] Replace prefix match with glob pattern in `customGroups.elementNamePattern` (oxc-project#19066) (leaysgur) ### 🚀 Features - 91e67f3 oxfmt/lsp: Do not refer `.gitignore` (oxc-project#19206) (leaysgur) - 23c0753 oxfmt: Better Tailwind CSS intergration (oxc-project#19000) (Dunqing) - 87a920d ci: Add riscv64 and s390x napi targets for oxlint and oxfmt (oxc-project#19039) (Boshen) - 8536dce oxfmt: Support glob for CLI paths (oxc-project#18976) (leaysgur) - 6ee2d59 oxfmt: Use `oxc_formatter` in js-in-xxx part (oxc-project#18373) (leaysgur) - 9788a96 oxlint,oxfmt: Add more native builds (oxc-project#18853) (Boshen) ### 🐛 Bug Fixes - 119348b oxfmt: Resolve relative -> absolute path for other usages (oxc-project#19207) (leaysgur) - 5f4cf30 oxfmt: Fix relative -> absolute path resolution with refactoring (oxc-project#19202) (leaysgur) - dc335d1 oxfmt: Temporarily disable the override for js-in-xxx (not ready yet) (oxc-project#19043) (leaysgur) - 5ea5bda oxfmt: Handle `isSingleJsxExpressionStatementInMarkdown()` check for js-in-md (oxc-project#19042) (leaysgur) - 5243307 formatter: Preserve numeric separators in number literals (oxc-project#19015) (Dunqing) - 9b205b3 formatter: Fallback to formatting when package.json sorting fails (oxc-project#19097) (Boshen) - b79c065 formatter: Preserve comment between callee and optional chaining operator (oxc-project#19020) (Dunqing) - 01d1be1 formatter: Remove unnecessary parentheses for single-member union types (oxc-project#19018) (Dunqing) - f5c7e75 formatter: Preserve parentheses around await with private field access (oxc-project#19014) (Dunqing) - 5a75785 formatter: Preserve parentheses around nested sequence expressions (oxc-project#19013) (Dunqing) - f39c96c oxfmt: Do not override `babel-ts` for now (oxc-project#19030) (leaysgur) - 0ef11bb formatter: Add space before type annotation with leading comment (oxc-project#19012) (Dunqing) - cc232e1 formatter: Keep spread with callback on same line (oxc-project#18999) (Dunqing) - ef5bfab oxfmt: Workaround Node.js ThreadsafeFunction cleanup race condition (oxc-project#18980) (Boshen) - d53f5c4 formatter: Require string first arg in test calls (oxc-project#18935) (Dunqing) - 57917ee parser: Parse decorators on rest parameters (oxc-project#18938) (Boshen) - 2db8c05 formatter: Avoid breaking generic call assignments (oxc-project#18933) (Dunqing) - 1e023e1 formatter: Preserve trailing comma in mts/cts arrow generics (oxc-project#18928) (Dunqing) - 7c4e558 formatter/detect_code_removal: Do not count `TemplateLiteral` content (oxc-project#18848) (leaysgur) ### ⚡ Performance - 467724f oxfmt: Collect glob paths in parallel (oxc-project#19209) (leaysgur) - 61e0efa oxfmt: Use RwLock instead of Mutex for TSFN handles (oxc-project#18888) (Boshen) Co-authored-by: camc314 <[email protected]>
# Oxlint ### 🚀 Features - aef2af5 linter/unicorn: Add fixer for `unicorn/relative-url-style` rule (oxc-project#19186) (Mikhail Baev) - 80eba6f linter/max-params: Support `countThis` option (oxc-project#19175) (camc314) - e19bc45 linter/no-new-func: Improve rule diagnostic with note and actionable help message (oxc-project#19132) (Sean Gallen) - e3dc5f6 linter/plugins: `RuleTester` test suggestions (oxc-project#19104) (overlookmotel) - 6054249 linter/plugins: Add `recursive` option to `RuleTester` (oxc-project#19093) (overlookmotel) - 27c241b linter/plugins: `RuleTester` test fixes (oxc-project#19091) (overlookmotel) - 7318275 linter/new-cap: Tighten diagnostic spans and add help text (oxc-project#19131) (camchenry) - ac2b16b linter: Improve `no-misleading-character-class` diagnostic spans (oxc-project#19109) (Sysix) - 7be8613 linter: Move `no-misleading-chracter-class` to `correctness` (oxc-project#19006) (Sysix) - 87a920d ci: Add riscv64 and s390x napi targets for oxlint and oxfmt (oxc-project#19039) (Boshen) - ee2925b oxlint/lsp: Enable JS plugins (oxc-project#18834) (overlookmotel) - 533013d linter/unicorn: Implement suggestion for `unicorn/prefer-dom-node-dataset` (oxc-project#19051) (Mikhail Baev) - 384abae linter/oxc/no-async-endpoint-handlers: Improve diagnostic message (oxc-project#19001) (camc314) - d35ece3 linter/array-callback-return: Improve diagnostic hints for some cases (oxc-project#18993) (camc314) - dd0f754 linter/array-callback-return: Improve diagnostic message for `forEach` case (oxc-project#18992) (camc314) - e2d28fe linter/plugins: Implement suggestions (oxc-project#18963) (overlookmotel) - a398152 linter: Promote the `eslint/no-iterator` rule to correctness, which makes it a default rule (oxc-project#18915) (connorshea) - bb1eb97 linter: Improve diagnostic message for circular configs (oxc-project#18947) (camc314) - 3184f36 linter: Ban relative js plugin specifiers in js extends config (oxc-project#18944) (camc314) - 749972f linter: Validate dynamic config extends shape (oxc-project#18943) (camc314) - b270739 linter: Support extends in oxlint.config.ts (oxc-project#18942) (camc314) - 6024ddf linter: Implement suggestion for `unicorn/prefer-reflect-apply` (oxc-project#18932) (Mikhail Baev) - b06b3a9 linter: Implement `typescript/consistent-type-assertions` (oxc-project#18869) (Bazyli Brzóska) - 9fd3bd6 linter/plugins: Add `@oxlint/plugins` NPM package (oxc-project#18824) (overlookmotel) - 5ee7b2f linter/vitest: Implements `prefer-expect-type-of` rule (oxc-project#17957) (Said Atrahouch) - a7b360a linter/unicorn: Implement `unicorn/relative-url-style` rule (oxc-project#18857) (Mikhail Baev) - 9788a96 oxlint,oxfmt: Add more native builds (oxc-project#18853) (Boshen) - b23395a linter: Enforce exporting an object with `defineConfig` (oxc-project#18858) (camc314) ### 🐛 Bug Fixes - 7800fc5 linter/prefer-event-target: Ignore EventEmitter imported from packages (oxc-project#19188) (camc314) - 03b2955 linter/typescript/ban-types: Mark rule as deprecated (oxc-project#19179) (camc314) - a5b8766 oxlint/lsp: Disable rule for this line should not be preferred (oxc-project#19083) (Sysix) - e08157e linter/jsx-filename-extension: Include filename in as-needed diagnostic (oxc-project#19172) (camc314) - 1773acb oxlint: Re-generate envs (oxc-project#19169) (camc314) - 51c3fc8 linter/no-array-for-each: Skip `Effect.forEach` calls (oxc-project#19127) (camc314) - 825f148 linter/plugins: `RuleTester` consider adjacent fixes as overlapping in ESLint compat mode (oxc-project#19094) (overlookmotel) - ecd2456 linter/plugins: Handle fix with -1 offsets in file with BOM (oxc-project#19092) (overlookmotel) - 5969d26 linter/no-array-sort: Avoid false positives for effect Chunk.sort (oxc-project#19125) (camc314) - de10f04 linter: `no-misleading-character-class`: do not skip reporting on first invalid sequence of the checking group (oxc-project#19111) (Sysix) - 8c0ce78 linter: Scope no-misleading-character-class sequences to single character class (oxc-project#19108) (copilot-swe-agent) - 879e3a0 linter: `no-misleading-character-class`: split sequences on all `CharacterSet` (oxc-project#19107) (Sysix) - 2ad33cc oxlint/lsp: Search parent directories for root oxlint config (oxc-project#19062) (copilot-swe-agent) - f969d5e linter/prefer-dom-node-dataset: Address some edge cases in the fixer (oxc-project#19065) (camc314) - ed759d1 linter/plugins: Fix error messages for invalid suggestions (oxc-project#19059) (overlookmotel) - 34851a7 linter/plugins: Error not panic if invalid fix range (oxc-project#19058) (overlookmotel) - 4823b58 linter/plugins: Fix fixes in files with BOM (oxc-project#19056) (overlookmotel) - 2ef405e linter/no-map-spread: Improve actionability of error message (oxc-project#19007) (Artyom Alekseevich) - 56c086b parser: Add modifier ordering validation (TS1029) (oxc-project#19024) (Boshen) - 6067a49 linter/jsdoc: False positive in `check-tag-names` for `@` in email addresses and npm scopes (oxc-project#19021) (Boshen) - 6d46ed9 linter/capitalized-comments: Ignore prettier and oxfmt directives (oxc-project#19008) (Artyom Alekseevich) - a46c878 linter/react/no-array-index-key: Look for keys in expressions (oxc-project#18997) (camc314) - 7d61704 linter/prefer-at: Skip autofix for `arguments` (oxc-project#18991) (camc314) - 3ebae53 linter/preserve-caught-error: Skip traversing into nested try/catch stmts (oxc-project#18990) (camc314) - e94d37e linter/react/no-unknown-property: Add missing `popover` related props (oxc-project#18953) (Christoph Nakazawa) - 04b0d99 linter: Normalize relative paths with `./` prefix in overrides. (oxc-project#18954) (connorshea) - 57917ee parser: Parse decorators on rest parameters (oxc-project#18938) (Boshen) - 07742ea linter/prefer-as-const: Implement fixer for type annotation (oxc-project#18899) (camc314) - d64bfdd linter/plugins: Ensure `after` hook always runs last in rule converted for ESLint (oxc-project#18904) (overlookmotel) - ec39944 linter/jsx-a11y/no-distracting-elements: Support elements option (oxc-project#18892) (camc314) - f609cb6 linter/prefer-expect-type-of: Handle computed elements in fixer correctly (oxc-project#18890) (camc314) - ecf11e5 linter/dynamic-config: Set `ExternalPlugin.config_dir` to fix js plugins loading (oxc-project#18854) (camc314) - 01b7838 linter/plugins: Do not destroy workspaces (oxc-project#18833) (overlookmotel) - dc51d6b linter: Normalize paths slashes for snapshots on windows (oxc-project#18825) (camc314) - dbfdc40 linter/bad-replace-all-args: Skip extracting flags from conditional expressions (oxc-project#18844) (camc314) ### ⚡ Performance - ed8c054 oxc_str: Add precomputed hash to Ident for fast HashMap lookups (oxc-project#19143) (Boshen) - 18f58bd oxlint/lsp: Transform unused disable directive directly to DiagnosticReport (oxc-project#19112) (Sysix) - 4ce3772 linter: Remove pointless string cloning when combining suggestions (oxc-project#19075) (overlookmotel) - c417bf5 linter: Avoid allocating `Vec` when compiling `PossibleFixes` (oxc-project#19074) (overlookmotel) - adb2baa linter/plugins: Avoid allocation when rule provides single suggestion (oxc-project#19071) (overlookmotel) - 2537924 semantic: Optimize scope resolution with fast paths and inlining (oxc-project#19029) (Boshen) ### 📚 Documentation - 6e8ef38 linter/plugins: Correct and expand JSDoc comment for `RuleTester` config (oxc-project#19156) (overlookmotel) - e7ec06a linter: Improve docs for `import/max-dependencies` rule. (oxc-project#19119) (connorshea) - 367f730 linter/consistent-test-filename: Escape file names fixes oxc-project#19114 (oxc-project#19123) (camc314) - 8753a54 linter: Rewrite the docs for the `jsx-a11y/no-redundant-roles` rule. (oxc-project#19117) (connorshea) - dd44b1a linter: Fix invalid directive in example code for `import/no-nodejs-modules`. (oxc-project#19115) (connorshea) - 726e273 linter/plugins: Improve JSDoc comment for `DiagnosticReport` (oxc-project#19103) (overlookmotel) - 9561e7f linter/plugins: Alter JS plugins example (oxc-project#18900) (overlookmotel) - 501e3b6 linter: Regenerate `config.generated.ts` (oxc-project#18897) (overlookmotel) - b425a0c linter: Document jsPlugins examples (oxc-project#18671) (Cameron) - df2b7fa linter: Expand settings example with reference to custom plugins (oxc-project#18670) (camc314) # Oxfmt ### 💥 BREAKING CHANGES - 856a01f formatter/sort_imports: [**BREAKING**] Replace prefix match with glob pattern in `customGroups.elementNamePattern` (oxc-project#19066) (leaysgur) ### 🚀 Features - 91e67f3 oxfmt/lsp: Do not refer `.gitignore` (oxc-project#19206) (leaysgur) - 23c0753 oxfmt: Better Tailwind CSS intergration (oxc-project#19000) (Dunqing) - 87a920d ci: Add riscv64 and s390x napi targets for oxlint and oxfmt (oxc-project#19039) (Boshen) - 8536dce oxfmt: Support glob for CLI paths (oxc-project#18976) (leaysgur) - 6ee2d59 oxfmt: Use `oxc_formatter` in js-in-xxx part (oxc-project#18373) (leaysgur) - 9788a96 oxlint,oxfmt: Add more native builds (oxc-project#18853) (Boshen) ### 🐛 Bug Fixes - 119348b oxfmt: Resolve relative -> absolute path for other usages (oxc-project#19207) (leaysgur) - 5f4cf30 oxfmt: Fix relative -> absolute path resolution with refactoring (oxc-project#19202) (leaysgur) - dc335d1 oxfmt: Temporarily disable the override for js-in-xxx (not ready yet) (oxc-project#19043) (leaysgur) - 5ea5bda oxfmt: Handle `isSingleJsxExpressionStatementInMarkdown()` check for js-in-md (oxc-project#19042) (leaysgur) - 5243307 formatter: Preserve numeric separators in number literals (oxc-project#19015) (Dunqing) - 9b205b3 formatter: Fallback to formatting when package.json sorting fails (oxc-project#19097) (Boshen) - b79c065 formatter: Preserve comment between callee and optional chaining operator (oxc-project#19020) (Dunqing) - 01d1be1 formatter: Remove unnecessary parentheses for single-member union types (oxc-project#19018) (Dunqing) - f5c7e75 formatter: Preserve parentheses around await with private field access (oxc-project#19014) (Dunqing) - 5a75785 formatter: Preserve parentheses around nested sequence expressions (oxc-project#19013) (Dunqing) - f39c96c oxfmt: Do not override `babel-ts` for now (oxc-project#19030) (leaysgur) - 0ef11bb formatter: Add space before type annotation with leading comment (oxc-project#19012) (Dunqing) - cc232e1 formatter: Keep spread with callback on same line (oxc-project#18999) (Dunqing) - ef5bfab oxfmt: Workaround Node.js ThreadsafeFunction cleanup race condition (oxc-project#18980) (Boshen) - d53f5c4 formatter: Require string first arg in test calls (oxc-project#18935) (Dunqing) - 57917ee parser: Parse decorators on rest parameters (oxc-project#18938) (Boshen) - 2db8c05 formatter: Avoid breaking generic call assignments (oxc-project#18933) (Dunqing) - 1e023e1 formatter: Preserve trailing comma in mts/cts arrow generics (oxc-project#18928) (Dunqing) - 7c4e558 formatter/detect_code_removal: Do not count `TemplateLiteral` content (oxc-project#18848) (leaysgur) ### ⚡ Performance - 467724f oxfmt: Collect glob paths in parallel (oxc-project#19209) (leaysgur) - 61e0efa oxfmt: Use RwLock instead of Mutex for TSFN handles (oxc-project#18888) (Boshen) Co-authored-by: camc314 <[email protected]>
…kage (oxc-project#19234) oxc-project#18824 added a `@oxlint/plugins` NPM package, and oxc-project#18903 altered the release workflow. It seems neither worked correctly - the package hasn't been getting published during the release process. It's still on version 1.43.0 on NPM: https://www.npmjs.com/package/@oxlint/plugins This PR alters the pre-release and release workflows to (hopefully) bump version of this package and release it alongside `oxlint` package. There have been no changes to content of `@oxlint/plugins` package since the last published version, and it has no dependencies, so it doesn't really matter that we've skipped these releases. But this PR should get it publishing correctly from next release onwards.

Alternative to #18796. Part of #18610.
Overview
Add
@oxlint/pluginspackage.@oxlint/pluginspackage has no dependency onoxlint, which solves the problem raised in #18796 (comment), and is also what we wanted in the end anyway. We don't actually want plugins packages to have to depend onoxlint.Differences from other Oxc packages
This package is different from all our other packages, in that it's intended to work not only with Oxlint's ecosystem, but also with ESLint's ecosystem.
@oxlint/pluginswill be a runtime dependency of plugin packages that the community create, and they may want their plugin to be compatible with both Oxlint and ESLint - this package provides theeslintCompatPluginfunction for exactly this purpose.Our aim is to allow plugin authors to migrate from ESLint's
createAPI to Oxlint'screateOnceAPI with minimum friction, and without breaking changes for their users:enginesfield inpackage.json).Package composition
Due to these requirements, the make-up of
@oxlint/pluginsis different from our other packages:Dual Format
This package is in "dual package" format, with both ESM and CommonJS entry points.
Older NodeJS versions support
This package supports NodeJS versions back to v12.22.0.
oxc/npm/oxlint-plugins/package.json
Lines 40 to 42 in 9938dc4
This matches
enginesfield in all ESLint 8.x.x releases:Therefore,
@oxlint/pluginscan be used by any plugin which supports ESLint 8 or later.Note: Download counts for ESLint 8 are still roughly equal to ESLint 9, even though v9 was released 2 years ago.
Notes
targetin TSDown to"node12"does not result in any changes to built files. See 3rd commit in this PR.exportsfield inpackage.jsonis supported (without experimental flag) from NodeJS v12.17.0 + v14.0.0..cjsfile extension supported from NodeJS v12.0.0.Building the package
This PR adds 2 extra builds to TSDown config, which generate the files for the package.
build.tsscript moves the files intonpm/oxlint-pluginsdirectory.Later on, we'll move the logic for moving the files into the CI release workflow, so we don't need to check the generated build files into Git.
@oxlint/plugins-devIn #18610 we decided to also add an
@oxlint/plugins-devto containRuleTester, so we can move that out ofoxlintpackage. This PR does not add that package. I've skipped that for now as (a) it's trickier and (b) it's much less important.