Skip to content

fix: make data property stricter #327

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
fasttime merged 11 commits into from
Dec 4, 2025
Merged

fix: make data property stricter #327

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8ec5f8b
fix: make `data` property stricter
lumirlumir Nov 17, 2025
e2f9f4d
wip
lumirlumir Nov 20, 2025
7939f11
Merge branch 'main' into fix-make-the-data-property-stricter
lumirlumir Nov 20, 2025
06d6ba0
wip
lumirlumir Nov 24, 2025
7f1a4d4
Merge branch 'main' into fix-make-the-data-property-stricter
lumirlumir Nov 27, 2025
e316180
wip
lumirlumir Nov 27, 2025
440b8c2
wip
lumirlumir Nov 27, 2025
9437eea
wip
lumirlumir Nov 27, 2025
77cd955
Merge branch 'main' into fix-make-the-data-property-stricter
lumirlumir Dec 3, 2025
cf19c40
wip: add JSDoc comment
lumirlumir Dec 3, 2025
967c367
Merge branch 'fix-make-the-data-property-stricter' of https://github.…
lumirlumir Dec 3, 2025
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
8 changes: 6 additions & 2 deletions packages/core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,9 @@ export interface ViolationReportBase {
/**
* The data to insert into the message.
*/
data?: Record<string, unknown> | undefined;
data?:
| Record<string, string | number | boolean | bigint | null | undefined> // NOTE: If you update this, please also update the `SuggestedEditBase['data']` type.
| undefined;

/**
* The fix to be applied for the violation.
Expand Down Expand Up @@ -485,7 +487,9 @@ export interface SuggestedEditBase {
/**
* The data to insert into the message.
*/
data?: Record<string, unknown> | undefined;
data?:
| Record<string, string | number | boolean | bigint | null | undefined> // NOTE: If you update this, please also update the `ViolationReportBase['data']` type.
| undefined;

/**
* The fix to be applied for the suggestion.
Expand Down
44 changes: 44 additions & 0 deletions packages/core/tests/types/types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,28 @@ const testRule: RuleDefinition<{
foo: "foo",
bar: 1,
baz: true,
qux: false,
a: 1n,
b: null,
c: undefined,
d: void 0,
// @ts-expect-error -- Symbols are not allowed in `data`.
e: Symbol("b"),
// @ts-expect-error -- Objects are not allowed in `data`.
f: {
hi: "hi",
},
// @ts-expect-error -- Arrays are not allowed in `data`.
g: [1, 2, 3],
// @ts-expect-error -- Sets are not allowed in `data`.
h: new Set([1, 2, 3]),
// @ts-expect-error -- Maps are not allowed in `data`.
i: new Map([
["a", 1],
["b", 2],
]),
// @ts-expect-error -- Functions are not allowed in `data`.
j: () => {},
},
// @ts-expect-error -- 'fix' is required in suggestion objects
fix: null,
Expand All @@ -339,6 +361,28 @@ const testRule: RuleDefinition<{
foo: "foo",
bar: 1,
baz: true,
qux: false,
a: 1n,
b: null,
c: undefined,
d: void 0,
// @ts-expect-error -- Symbols are not allowed in `data`.
e: Symbol("b"),
// @ts-expect-error -- Objects are not allowed in `data`.
f: {
hi: "hi",
},
// @ts-expect-error -- Arrays are not allowed in `data`.
g: [1, 2, 3],
// @ts-expect-error -- Sets are not allowed in `data`.
h: new Set([1, 2, 3]),
// @ts-expect-error -- Maps are not allowed in `data`.
i: new Map([
["a", 1],
["b", 2],
]),
// @ts-expect-error -- Functions are not allowed in `data`.
j: () => {},
},
fix: null,
suggest: null,
Expand Down