Skip to content

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Sep 27, 2025

Fix types for fix function. Allow it to return undefined, so a pattern where bail out unable to fix is legal:

const rule = {
  create(context) {
    return {
      Identifier(node) {
        context.report({
          message: 'No identifiers!',
          node,
          fix(fixer) {
            if (node.name === 'foo') return; // Can't fix 'foo' for some reason
            return fixer.remove(node);
          },
        });
      },
    };
  },
};

For some reason, this also makes it possible to remove some type assertions.

@github-actions github-actions bot added A-linter Area - Linter A-cli Area - CLI C-bug Category - Bug labels Sep 27, 2025
Copy link
Member Author


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.

@overlookmotel overlookmotel marked this pull request as ready for review September 27, 2025 10:57
Copilot AI review requested due to automatic review settings September 27, 2025 10:57
@overlookmotel overlookmotel self-assigned this Sep 27, 2025
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Sep 27, 2025
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 PR fixes TypeScript type definitions for the fix function in the linter plugins system to allow returning undefined, enabling a common bail-out pattern where rules can choose not to provide a fix for certain cases.

  • Updated the FixFn type to include undefined as a valid return type for individual fixes and the overall function
  • Removed type assertion and simplified array conversion logic to handle the expanded type union

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Member Author

overlookmotel commented Sep 27, 2025

Merge activity

Fix types for `fix` function. Allow it to return `undefined`, so a pattern where bail out unable to fix is legal:

```js
const rule = {
  create(context) {
    return {
      Identifier(node) {
        context.report({
          message: 'No identifiers!',
          node,
          fix(fixer) {
            if (node.name === 'foo') return; // Can't fix 'foo' for some reason
            return fixer.remove(node);
          },
        });
      },
    };
  },
};
```
@graphite-app graphite-app bot force-pushed the 09-27-fix_linter_plugins_allow_fix_function_to_return_undefined_ branch from 31369bd to e9a14d1 Compare September 27, 2025 10:59
@graphite-app graphite-app bot merged commit e9a14d1 into main Sep 27, 2025
18 checks passed
@graphite-app graphite-app bot deleted the 09-27-fix_linter_plugins_allow_fix_function_to_return_undefined_ branch September 27, 2025 11:03
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Sep 27, 2025
camc314 added a commit that referenced this pull request Sep 29, 2025
## [1.19.0] - 2025-09-29

### 🚀 Features

- eb6345f linter/unicorn: Implement no-array-callback-reference (#14230)
(camc314)
- c64fa61 linter: Add `import/no-named-export` rule (#14229) (yefan)
- d30159b linter: Fix for unsorted keys (#14225) (Hamir Mahal)
- acd1266 linter/plugins: `oxlint` export types (#14163) (overlookmotel)
- c0e461f linter: Add `unicorn/no-array-sort` rule (#14117) (Cason
Kervis)
- 00954de linter/plugins: Remove `--js-plugins` CLI option (#14134)
(overlookmotel)
- b4d716f linter/plugins: Move custom JS plugin config to `jsPlugins`
(#14133) (overlookmotel)
- 60f0b3f linter: Add fix for `preserve-caught-error` (#14104) (Cam
McHenry)
- 2d74c17 linter/no-multiple-resolved: Implement promise rule
no-multiple-resolved (#13420) (Li Wei)
- 5e05d1b semantic: Put jsdoc behind linter feature, remove runtime flag
(#14140) (Boshen)
- 71af1aa semantic: Add "linter" feature (#14139) (Boshen)
- 1a6d7ae linter: Add `vue/max-props` rule (#14039) (yefan)
- 9c3afea linter/plugins: Support fixes (#14094) (overlookmotel)
- 1472147 linter: Move `no-unused-expressions` to correctness (#14099)
(camchenry)
- 8b7c784 linter: Add react/jsx-pascal-case rule (#12165) (Mikhail Baev)
- c796966 linter/plugins: Add `meta` property to rules (#14089)
(overlookmotel)

### 🐛 Bug Fixes

- 39a171e linter: Get cli args on JS side, to avoid runtime
inconsistencies (#14223) (camc314)
- e045391 linter/plugins: Error on JS plugin with reserved name (#14226)
(overlookmotel)
- 6005015 linter: Correctly handle CRLF when inserting disable comments
in framework files (#14228) (shulaoda)
- 37f6b09 linter/plugins: Make `null` a valid value for `meta.fixable`
(#14204) (overlookmotel)
- 8879b5a linter/plugins: Add types export to `npm/oxlint` (#14219)
(overlookmotel)
- e37c435 language_server: Correct position for "ignore this rule for
this file" in vue/astro/svelte files (#14187) (Sysix)
- f8abab2 editor: Stricter path validation for `oxc.path.server`
(#14202) (Sysix)
- e9a14d1 linter/plugins: Allow `fix` function to return `undefined`
(#14182) (overlookmotel)
- ee9ecbe linter/plugins: Fix TS type for fixer methods (#14166)
(overlookmotel)
- 03d1684 linter/plugins: Output warning on first JS plugin load
(#14165) (overlookmotel)
- 9716f7c linter/plugins: Fix TS types (#14162) (overlookmotel)
- d36d227 language_server: Don't lint file on code action when it is
already ignored (#13976) (Sysix)
- 353bfe7 language_server: Check if tsconfig path is a file before
starting the `LintService` (#14126) (Sysix)
- fc7026d linter: Add missing `NODE_TYPES`, `cfg_id` method for
no-multiple-resolved (#14147) (camc314)
- 180c790 linter: Fix false positive in `no-restricted-globals` (#14135)
(yefan)
- 4a4fce8 linter: Fix cli argument parsing (#14112) (camc314)
- 9f3e2bc linter/plugins: Output errors thrown in JS plugins (#14096)
(overlookmotel)
- 357a2d3 linter: Add support for `tsgolint.exe` on Windows (#14101)
(camchenry)
- 2604b28 linter: Fix lint errors building `oxlint` (#14095)
(overlookmotel)
- d8e9cc5 linter/plugins: Validate type of `before` and `after` hooks
(#14086) (overlookmotel)

### 🚜 Refactor

- 4c3f1ac linter: Move `BUILT_IN_ERRORS` to utils file (#14221)
(camc314)
- 61ec0a7 linter/plugins: Simplify creation of `context` in `defineRule`
ESLint shim (#14206) (overlookmotel)
- 7a0eb57 language_server: Refactor ignore code action logic as a linter
fix (#14183) (Sysix)
- 3b1fe6f linter/plugins: Flatten directory structure of `dist` (#14199)
(overlookmotel)
- d52cba6 linter: Bump TSDown to latest (#14198) (overlookmotel)
- 983dd1b linter/plugins: Add `Fixer` type (#14180) (overlookmotel)
- 2f8b076 linter/plugins: Remove dead code (#14178) (overlookmotel)
- 497236e semantic: Move AstNode::cfg_id to struct of arrays in AstNodes
(#14137) (Boshen)
- 5ba765c semantic: Move AstNode::flags to struct of arrays in AstNodes
(#14136) (Boshen)
- ffc810d linter: `preserve-caught-errors`: rename config and add docs
(#14103) (camchenry)
- f91db73 linter: Add `CompositeFix::merge_fixes_fallible` method
(#14093) (overlookmotel)
- e55ffe0 curly: Enhance curly brace rule configuration and handling
(#13498) (Antoine Zanardi)
- 2fb69fd eslint/eqeqeq: Clean up implementation and improve
documentation (#13527) (Antoine Zanardi)
- e69cd86 linter/plugins: `loadPluginImpl` return an object (#14087)
(overlookmotel)

### 📚 Documentation

- b83b1bd language_server: Docs for `Backend` struct (#14172) (Sysix)
- 3106ba0 language_server: Docs for `WorkspaceWorker` (#14161) (Sysix)
- b19f5bc linter/plugins: Improve JSDoc comments for `definePlugin` and
`defineRule` (#14159) (overlookmotel)

### ⚡ Performance

- 2575065 linter/plugins: Store if rule is fixable as boolean (#14205)
(overlookmotel)
- b6d2546 linter: Reduce string cloning in tsgo fixes (#14092)
(overlookmotel)
- c94c5dc linter: Remove allocation in `CompositeFix::merge_fixes`
(#14090) (overlookmotel)

### 🧪 Testing

- be58d6d language_server: Fix test for ServerFormatter in windows
(#14210) (Sysix)
- a9b603e linter/plugins: Convert all plugins in tests to TS (#14200)
(overlookmotel)
- 6ff3a23 linter/plugins: Add tests for `.ts`, `.mts`, `.cts` plugin
files (#14164) (overlookmotel)
- 8988d64 linter/plugins: Add line breaks to plugins files (#14181)
(overlookmotel)
- d7041c1 language_server: Add linebreaks for formatter snapshot
(#14173) (Sysix)
- 52db331 linter/plugins: Type-check test fixtures (#14158)
(overlookmotel)
- aca083a linter/plugins: Include stderr output in snapshots (#14155)
(overlookmotel)
- a3c8f46 linter/plugins: Do not run `pnpm` in tests (#14157)
(overlookmotel)
- d985aeb editor: Remove cross-module tests, covered by language server
(#14156) (Sysix)
- 0029b7f linter/plugins: Normalize line breaks in snapshots (#14154)
(overlookmotel)
- 7f2c101 linter/plugins: Specify path to `node` in tests (#14152)
(overlookmotel)
- fc14abc linter/plugins: Format test fixtures (#14125) (overlookmotel)
- a6f965f linter/plugins: Simplify configs in test fixtures (#14124)
(overlookmotel)
- b1685f7 linter/plugins: Refactor tests (#14123) (overlookmotel)
- 788e495 linter/plugins: Improve ESLint compat tests (#14119)
(overlookmotel)
- 5750077 linter/plugins: Fix file paths in snapshots (#14115)
(overlookmotel)
- 5c862f9 linter/plugins: Standardize test fixture structure (#14114)
(overlookmotel)

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
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 C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants