Skip to content

chore: unify todos #2063

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
Apr 16, 2023
Merged

chore: unify todos #2063

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: 1 addition & 1 deletion scripts/generateLocales.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ function generateLocaleFile(locale: string): void {
}
}

// TODO christopher 2023-03-07: Remove 'en' fallback in a separate PR
// TODO @Shinigami92 2023-03-07: Remove 'en' fallback in a separate PR
if (locales[locales.length - 1] !== 'en' && locale !== 'base') {
locales.push('en');
}
Expand Down
2 changes: 1 addition & 1 deletion src/modules/helpers/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,7 +1251,7 @@ export class HelpersModule {
*/
unique<
Method extends (
// TODO christopher 2023-02-14: This `any` type can be fixed by anyone if they want to.
// TODO @Shinigami92 2023-02-14: This `any` type can be fixed by anyone if they want to.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
...parameters: any[]
) => RecordKey
Expand Down
2 changes: 1 addition & 1 deletion src/modules/helpers/unique.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`
*/
export function exec<
Method extends (
// TODO christopher 2023-02-14: This `any` type can be fixed by anyone if they want to.
// TODO @Shinigami92 2023-02-14: This `any` type can be fixed by anyone if they want to.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
...parameters: any[]
) => RecordKey
Expand Down
2 changes: 1 addition & 1 deletion src/modules/image/providers/lorempicsum.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export class LoremPicsum {
since: '8.0',
until: '9.0',
});
// TODO ST-DDT 2022-03-11: This method does the same as image url, maybe generate a seed, if it is missig?
// TODO @ST-DDT 2022-03-11: This method does the same as image url, maybe generate a seed, if it is missing?
return this.imageUrl(width, height, grayscale, blur, seed);
}

Expand Down
2 changes: 1 addition & 1 deletion src/utils/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export type LiteralUnion<T extends U, U = string> =
* These would fail when invoked since they are invoked without the `new` keyword.
*/
export type Callable = (
// TODO christopher 2023-02-14: This `any` type can be fixed by anyone if they want to.
// TODO @Shinigami92 2023-02-14: This `any` type can be fixed by anyone if they want to.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
...args: any[]
) => unknown;
Expand Down
10 changes: 5 additions & 5 deletions test/all_functional.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ type SkipConfig<Module> = Partial<
>;

const BROKEN_LOCALE_METHODS = {
// TODO ST-DDT 2022-03-28: these are TODOs (usually broken locale files)
// TODO @ST-DDT 2022-03-28: these are TODOs (usually broken locale files)
company: {
suffixes: ['az'],
companySuffix: ['az'],
Expand Down Expand Up @@ -118,7 +118,7 @@ describe('functional tests', () => {
describe(module, () => {
modules[module].forEach((meth) => {
const testAssertion = () => {
// TODO ST-DDT 2022-03-28: Use random seed once there are no more failures
// TODO @ST-DDT 2022-03-28: Use random seed once there are no more failures
faker.seed(1);
const result = faker[module][meth]();

Expand All @@ -133,7 +133,7 @@ describe('functional tests', () => {
if (isWorkingLocaleForMethod(module, meth, locale)) {
it(`${meth}()`, testAssertion);
} else {
// TODO ST-DDT 2022-03-28: Remove once there are no more failures
// TODO @ST-DDT 2022-03-28: Remove once there are no more failures
// We expect a failure here to ensure we remove the exclusions when fixed
it.fails(`${meth}()`, testAssertion);
}
Expand All @@ -156,7 +156,7 @@ describe('faker.helpers.fake functional tests', () => {
describe(module, () => {
modules[module].forEach((meth) => {
const testAssertion = () => {
// TODO ST-DDT 2022-03-28: Use random seed once there are no more failures
// TODO @ST-DDT 2022-03-28: Use random seed once there are no more failures
faker.seed(1);
const result = faker.helpers.fake(`{{${module}.${meth}}}`);

Expand All @@ -169,7 +169,7 @@ describe('faker.helpers.fake functional tests', () => {
if (isWorkingLocaleForMethod(module, meth, locale)) {
it(`${meth}()`, testAssertion);
} else {
// TODO ST-DDT 2022-03-28: Remove once there are no more failures
// TODO @ST-DDT 2022-03-28: Remove once there are no more failures
// We expect a failure here to ensure we remove the exclusions when fixed
it.fails(`${meth}()`, testAssertion);
}
Expand Down