Skip to content

refactor(linter/plugins): allow accessing context.id in createOnce #15447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2025
Merged

refactor(linter/plugins): allow accessing context.id in createOnce #15447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion apps/oxlint/src-js/plugins/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ export class Context {

// Getter for full rule name, in form `<plugin>/<rule>`
get id() {
return getInternal(this, 'access `context.id`').id;
// Note: We can allow accessing `id` in `createOnce`, as it's not file-specific. So skip `getInternal` call.
return this.#internal.id;
}

// Getter for absolute path of file being linted.
Expand Down
4 changes: 2 additions & 2 deletions apps/oxlint/test/fixtures/createOnce/output.snap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
: ^
`----

x create-once-plugin(always-run): createOnce: id: Cannot access `context.id` in `createOnce`
x create-once-plugin(always-run): createOnce: id: create-once-plugin/always-run
,-[files/1.js:1:1]
1 | let x;
: ^
Expand Down Expand Up @@ -177,7 +177,7 @@
: ^
`----

x create-once-plugin(always-run): createOnce: id: Cannot access `context.id` in `createOnce`
x create-once-plugin(always-run): createOnce: id: create-once-plugin/always-run
,-[files/2.js:1:1]
1 | let y;
: ^
Expand Down
5 changes: 3 additions & 2 deletions apps/oxlint/test/fixtures/createOnce/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ const alwaysRunRule: Rule = {
// oxlint-disable-next-line typescript-eslint/no-this-alias
const topLevelThis = this;

const { id } = context;

// Check that these APIs throw here
const idError = tryCatch(() => context.id);
const filenameError = tryCatch(() => context.filename);
const physicalFilenameError = tryCatch(() => context.physicalFilename);
const optionsError = tryCatch(() => context.options);
Expand All @@ -35,7 +36,7 @@ const alwaysRunRule: Rule = {
before() {
context.report({ message: `createOnce: call count: ${createOnceCallCount}`, node: SPAN });
context.report({ message: `createOnce: this === rule: ${topLevelThis === alwaysRunRule}`, node: SPAN });
context.report({ message: `createOnce: id: ${idError?.message}`, node: SPAN });
context.report({ message: `createOnce: id: ${id}`, node: SPAN });
context.report({ message: `createOnce: filename: ${filenameError?.message}`, node: SPAN });
context.report({ message: `createOnce: physicalFilename: ${physicalFilenameError?.message}`, node: SPAN });
context.report({ message: `createOnce: options: ${optionsError?.message}`, node: SPAN });
Expand Down
Loading