Skip to content

fix(linter/plugins): do not allow access to Context#id in createOnce #15489

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
graphite-app merged 1 commit into from
Nov 8, 2025
Merged

fix(linter/plugins): do not allow access to Context#id in createOnce #15489

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
2 changes: 0 additions & 2 deletions apps/oxlint/src-js/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,6 @@ function createContextAndVisitor(rule: CreateOnceRule): {
// But any such bugs should have been caught when testing the rule in Oxlint, so should be OK to take this shortcut.
// `FILE_CONTEXT` prototype provides `cwd` property and `extends` method, which are available in `createOnce`.
const context = ObjectCreate(FILE_CONTEXT, {
// TODO: Need to set `id` to full rule name - it's available in `createOnce`.
// Or make it inaccessible in `createOnce`.
id: { value: '', enumerable: true, configurable: true },
options: { value: null, enumerable: true, configurable: true },
report: { value: null, enumerable: true, configurable: true },
Expand Down
7 changes: 6 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 @@ -352,7 +352,12 @@ export function createContext(fullRuleName: string, ruleDetails: RuleDetails): R
// Inherit from `FILE_CONTEXT`, which provides getters for file-specific properties
__proto__: FILE_CONTEXT,
// Rule ID, in form `<plugin>/<rule>`
id: fullRuleName,
get id(): string {
// It's not possible to allow access to `id` in `createOnce` in ESLint compatibility mode, so we don't
// allow it here either. It's probably not very useful anyway - a rule should know what its own name is!
if (filePath === null) throw new Error('Cannot access `context.id` in `createOnce`');
return fullRuleName;
},
// Getter for rule options for this rule on this file
get options(): Readonly<unknown[]> {
if (filePath === null) throw new Error('Cannot access `context.options` in `createOnce`');
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: create-once-plugin/always-run
x create-once-plugin(always-run): createOnce: id error: Cannot access `context.id` in `createOnce`
,-[files/1.js:1:1]
1 | let x;
: ^
Expand Down Expand Up @@ -177,7 +177,7 @@
: ^
`----

x create-once-plugin(always-run): createOnce: id: create-once-plugin/always-run
x create-once-plugin(always-run): createOnce: id error: Cannot access `context.id` in `createOnce`
,-[files/2.js:1:1]
1 | let y;
: ^
Expand Down
5 changes: 2 additions & 3 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,9 +22,8 @@ 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 @@ -36,7 +35,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: ${id}`, node: SPAN });
context.report({ message: `createOnce: id error: ${idError?.message}`, node: SPAN });
context.report({ message: `createOnce: filename error: ${filenameError?.message}`, node: SPAN });
context.report({
message: `createOnce: physicalFilename error: ${physicalFilenameError?.message}`,
Expand Down
Loading