Skip to content

chore: fix FakerModule test type #3866

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

Open
ST-DDT wants to merge 2 commits into
base: next
Choose a base branch
from
+1 −1
Open

chore: fix FakerModule test type #3866

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04f11a2
chore: fix FakerModule type
ST-DDT May 29, 2026
623293a
Merge branch 'next' into fix/test/FakerModule-type
ST-DDT May 30, 2026
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: 1 addition & 1 deletion test/support/seeded-runs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ type MethodOf<TObjectType, TSignature extends Callable = Callable> = {
type FakerModule = {
[Key in keyof Faker]: Faker[Key] extends Callable | string | number | number[]
? never
: Key extends 'definitions' | 'locales'
: Key extends 'definitions' | 'rawDefinitions' | 'fakerCore'
Copy link
Copy Markdown
Member

@Shinigami92 Shinigami92 May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (if-minor): have you considered something like this?

/**
 * Identity type whose constraint forces every member to be a real key of `Faker`.
 * This makes a stale entry in the {@link FakerModule} exclusion list fail to compile.
 */
type FakerKeys<T extends keyof Faker> = T;

/**
 * A type allowing only the names of faker modules.
 */
type FakerModule = {
  [Key in keyof Faker]: Faker[Key] extends Callable | string | number | number[]
    ? never
    : Key extends FakerKeys<'definitions' | 'rawDefinitions' | 'fakerCore'>
      ? never
      : Key;
}[keyof Faker];

Copy link
Copy Markdown
Member Author

@ST-DDT ST-DDT May 30, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would be the benefit of that?
Do detect invalidly banned/non-existing keys?
Since it does not detect invalidly allowed keys, I'm kind of neutral about this.

@others any preference?

Copy link
Copy Markdown
Member

@Shinigami92 Shinigami92 May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

detect invalidly banned/non-existing keys

exactly

? never
: Key;
}[keyof Faker];
Expand Down
Loading