feat(linter/plugins): add `SourceCode` API #14281

overlookmotel · 2025-10-01T14:22:07Z

Add support for ESLint's SourceCode API. At present the only method on SourceCode is getText. More methods will be added in further PRs to follow.

overlookmotel · 2025-10-01T14:22:22Z

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.

apps/oxlint/src-js/plugins/source_code.ts

Copilot

Pull Request Overview

Adds initial SourceCode API (currently only getText) to expose file source text to rules via context.sourceCode, updates the linting pipeline to populate it, and adds/updates tests and fixtures to validate behavior (including createOnce access restrictions). Key changes introduce the SourceCode class, extend Context, and adjust file processing to supply source text earlier.

Introduces SourceCode class with getText method and exposes it through context.sourceCode
Updates lint flow to decode source text before initializing rule contexts
Adds new fixtures and snapshot tests validating getText behavior and access constraints

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
apps/oxlint/src-js/plugins/source_code.ts	Adds `SourceCode` class and `getText` implementation.
apps/oxlint/src-js/plugins/context.ts	Extends `Context` with `sourceCode` property and setup initialization.
apps/oxlint/src-js/plugins/lint.ts	Moves source decoding earlier and passes source text into context setup.
apps/oxlint/src-js/index.ts	Re-exports `SourceCode` type.
apps/oxlint/test/e2e.test.ts	Adds e2e test for `context.sourceCode`.
apps/oxlint/test/fixtures/sourceCode/*	New plugin, config, source files, and snapshot validating `SourceCode` behavior.
apps/oxlint/test/fixtures/createOnce/plugin.ts	Adds test ensuring `context.sourceCode` access error in `createOnce`.
apps/oxlint/test/fixtures/createOnce/output.snap.md	Snapshot updated for new error cases (+2 errors).
Other fixture files	Test inputs for new snapshots.

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

apps/oxlint/src-js/plugins/source_code.ts

apps/oxlint/src-js/plugins/lint.ts

camc314 · 2025-10-01T16:35:53Z

Merge activity

Oct 1, 4:35 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Oct 1, 4:35 PM UTC: camc314 added this pull request to the Graphite merge queue.
Oct 1, 4:41 PM UTC: Merged by the Graphite merge queue.

Add support for ESLint's `SourceCode` API. At present the only method on `SourceCode` is `getText`. More methods will be added in further PRs to follow.

## [1.20.0] - 2025-10-06 ### 🚀 Features - d16df93 linter: Support disable directives for type aware rules (#14052) (camc314) - f5c6acc linter: Add `vue/no-export-in-script-setup` rule (#14307) (Sysix) - 353b153 linter: Implement eslint/no-param-reassign rule (#14341) (Matthew Davis) - a2914fe linter/plugins: Add `loc` field getter to all AST nodes (#14355) (overlookmotel) - 07193c2 linter/plugins: Implement `SourceCode#getAncestors` (#14346) (overlookmotel) - c8de6fe linter/plugins: Add `parent` field to AST nodes (#14345) (overlookmotel) - 5505a86 linter/plugins: Include `range` field in AST (#14321) (overlookmotel) - 3656908 rust: Oxc-index-vec v4.0 (#14254) (Boshen) - 1347de4 linter/plugins: Accept diagnostics with `loc` (#14304) (overlookmotel) - aefc8b3 linter/plugins: Implement `SourceCode#getIndexFromLoc` and `getLocFromIndex` (#14303) (overlookmotel) - 93807db linter/plugins: Implement `SourceCode#lines` property (#14290) (overlookmotel) - 2f8c985 linter/plugins: Implement `SourceCode#visitorKeys` property (#14289) (overlookmotel) - b69028f linter/plugins: Implement `SourceCode#ast` property (#14287) (overlookmotel) - d8d3d18 linter: Add `vue/prefer-import-from-vue` rule (#14284) (Sysix) - f0e760b linter: Add `vue/define-props-destructuring` rule (#14272) (Sysix) - bdf9010 linter/plugins: Add `SourceCode` API (#14281) (overlookmotel) - 7f450fc linter/unicorn: Implement require-module-specifiers (#13089) (keita hino) - a1e7154 linter/unicorn: Implement prefer-classlist-toggle (#14262) (camc314) - 8217dce linter/unicorn: Implement no-unnecessary-array-splice-count (#14255) (camc314) - 3d5db4a linter/unicorn: Implement no-useless-error-capture-stack-trace (#14222) (camc314) - b3b482a linter/unicorn: Implement prefer-top-level-await (#14247) (camc314) - 7931be8 linter/unicorn: Implement prefer-class-fields (#14245) (camc314) - a39434a linter/unicorn: Implement prefer-at (#14232) (camc314) ### 🐛 Bug Fixes - e605222 linter/no-useless-undefined: Correctly respect `checkArguments` option (#14369) (camc314) - f1bc608 linter: Fix flaky import/no_cycle test (#14328) (Boshen) - 9a902c0 linter/plugins: Make `range` field non-optional on AST types (#14354) (overlookmotel) - 0a42d7f tsgolint: Report errors if we fail to parse tsgolint diagnostic messages (#14301) (camc314) - 42f8d7e linter/react-hooks: Fix diagnostic message for literal in dependency array (#14266) (camc314) - ece91c5 linter/react-hooks: Fix diagnostic message for duplicate dependency in array (#14265) (camc314) - 864fa0e linter/no-unused-expression: False positive with satisfies expressions (#14259) (camc314) - adff069 language_server: Don't apply "ignore this rule" fixes for fixAll code action + command (#14243) (Sysix) - 46cceb8 linter/rules-of-hooks: Correctly place primary span to fix disable directive (#14237) (camc314) ### 🚜 Refactor - 1489376 napi/parser, linter/plugins: Minify walker code (#14376) (overlookmotel) - c8eeeb5 linter/plugins: Remove build-time dependency on `napi/parser` (#14374) (overlookmotel) - fb1a067 linter/plugins: Bundle walker and AST types map (#14373) (overlookmotel) - 93d8164 linter/plugins: Export AST types direct from `oxlint` package (#14353) (overlookmotel) - 230d996 linter/plugins: `SourceCode#getText` use `range` (#14352) (overlookmotel) - 6e52bbd linter/plugins: Move location-related code into separate file (#14350) (overlookmotel) - 13f1003 linter/plugins: Share `ast` between files (#14349) (overlookmotel) - 00dde41 tsgolint: Make parsing `TsGoLintMessage` parsing errors an enum (#14300) (camc314) - fc314f5 tsgolint: Make `MessageType` parsing more idomatic (#14299) (camc314) - a24c36e language-server/tsgolint: Use an iterator for tsgolint message parsing (#14298) (camc314) - 8be432a tsgolint: Use an iterator for tsgolint message parsing (#14297) (camc314) - 57daa54 tsgolint: Remove always `Some` option wrapper (#14296) (camc314) - 79eadf8 linter: Introduce `LintRunner` (#14051) (camc314) - 65873ba linter/plugins: Add stubs for all `SourceCode` methods (#14285) (overlookmotel) - 989ce2f linter/plugins: Convert `Node` type to interface (#14280) (overlookmotel) - 891fc47 language_server: Share code for command `oxc.fixAll` and code action `source.fixAll.oxc` (#14244) (Sysix) - 7fe930c language_server: Remove unused fixture files (#14246) (Sysix) - 2b2c345 language-server: Move `generate_inverted_diagnostics` to `error_with_position` (#14118) (camc314) ### ⚡ Performance - fa3712d language_server: Create less `ExternalPluginStore`s (#14378) (overlookmotel) - e75d42d napi/parser, linter/plugins: Remove runtime `preserveParens` option from raw transfer deserializers (#14338) (overlookmotel) - 2e57351 linter/plugins: Initialize `lineStartOffsets` as `[0]` (#14302) (overlookmotel) - c27a393 linter/plugins: Deserialize AST on demand (#14288) (overlookmotel) - 95a8cc4 linter/plugins: Use singleton for `SourceCode` (#14286) (overlookmotel) ### 🧪 Testing - 0061ce7 linter: Add more tests for disable directives in partial loadable files (#14371) (camc314) - 1387aaa linter/plugins: Test `createOnce` returning no visitor functions (#14279) (overlookmotel) - 55ebb8b linter: Add test for `disable_for_this_section` fix (#14240) (Sysix) - a7e8662 linter: Port unicorn test cases to no-named-default (#14239) (camc314) Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

github-actions bot added A-linter Area - Linter A-cli Area - CLI labels Oct 1, 2025

overlookmotel mentioned this pull request Oct 1, 2025

test(linter/plugins): test createOnce returning no visitor functions #14279

Merged

github-actions bot added the C-enhancement Category - New feature or request label Oct 1, 2025

overlookmotel mentioned this pull request Oct 1, 2025

refactor(linter/plugins): convert Node type to interface #14280

Merged

overlookmotel marked this pull request as ready for review October 1, 2025 14:33

overlookmotel requested a review from camc314 as a code owner October 1, 2025 14:33

graphite-app bot reviewed Oct 1, 2025

View reviewed changes

apps/oxlint/src-js/plugins/source_code.ts Outdated Show resolved Hide resolved

overlookmotel assigned camc314 Oct 1, 2025

overlookmotel marked this pull request as draft October 1, 2025 14:38

graphite-app bot force-pushed the 10-01-refactor_linter_plugins_convert_node_type_to_interface branch 2 times, most recently from 93a8b8e to 5415924 Compare October 1, 2025 14:45

overlookmotel force-pushed the 10-01-feat_linter_plugins_add_sourcecode_api branch 2 times, most recently from e7b07dd to 19fda1c Compare October 1, 2025 14:59

graphite-app bot changed the base branch from 10-01-refactor_linter_plugins_convert_node_type_to_interface to graphite-base/14281 October 1, 2025 15:32

graphite-app bot force-pushed the 10-01-feat_linter_plugins_add_sourcecode_api branch from 19fda1c to e672760 Compare October 1, 2025 15:37

graphite-app bot force-pushed the graphite-base/14281 branch from 5415924 to 989ce2f Compare October 1, 2025 15:37

graphite-app bot changed the base branch from graphite-base/14281 to main October 1, 2025 15:37

graphite-app bot force-pushed the 10-01-feat_linter_plugins_add_sourcecode_api branch from e672760 to 2d1e42f Compare October 1, 2025 15:38

overlookmotel force-pushed the 10-01-feat_linter_plugins_add_sourcecode_api branch from 2d1e42f to a3267ac Compare October 1, 2025 16:17

overlookmotel marked this pull request as ready for review October 1, 2025 16:17

Copilot AI review requested due to automatic review settings October 1, 2025 16:17

Copilot AI reviewed Oct 1, 2025

View reviewed changes

apps/oxlint/src-js/plugins/source_code.ts Show resolved Hide resolved

apps/oxlint/src-js/plugins/source_code.ts Outdated Show resolved Hide resolved

apps/oxlint/src-js/plugins/lint.ts Show resolved Hide resolved

overlookmotel force-pushed the 10-01-feat_linter_plugins_add_sourcecode_api branch from a3267ac to 2d85bb0 Compare October 1, 2025 16:28

camc314 approved these changes Oct 1, 2025

View reviewed changes

camc314 added the 0-merge Merge with Graphite Merge Queue label Oct 1, 2025

feat(linter/plugins): add SourceCode API (#14281)

bdf9010

Add support for ESLint's `SourceCode` API. At present the only method on `SourceCode` is `getText`. More methods will be added in further PRs to follow.

graphite-app bot force-pushed the 10-01-feat_linter_plugins_add_sourcecode_api branch from 2d85bb0 to bdf9010 Compare October 1, 2025 16:36

graphite-app bot merged commit bdf9010 into main Oct 1, 2025
17 checks passed

graphite-app bot deleted the 10-01-feat_linter_plugins_add_sourcecode_api branch October 1, 2025 16:41

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Oct 1, 2025

Boshen mentioned this pull request Oct 6, 2025

release(oxlint): v1.20.0 #14381

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(linter/plugins): add `SourceCode` API #14281

feat(linter/plugins): add `SourceCode` API #14281

Uh oh!

overlookmotel commented Oct 1, 2025 •

edited

Loading

Uh oh!

overlookmotel commented Oct 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

camc314 commented Oct 1, 2025 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat(linter/plugins): add SourceCode API #14281

feat(linter/plugins): add SourceCode API #14281

Uh oh!

Conversation

overlookmotel commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Oct 1, 2025 • 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!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

camc314 commented Oct 1, 2025 • 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!

3 participants

feat(linter/plugins): add `SourceCode` API #14281

feat(linter/plugins): add `SourceCode` API #14281

overlookmotel commented Oct 1, 2025 •

edited

Loading

overlookmotel commented Oct 1, 2025 •

edited

Loading

camc314 commented Oct 1, 2025 •

edited by graphite-app bot

Loading