Skip to content
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.

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

Source code todo list #541

Closed
xDivisionByZerox opened this issue Feb 22, 2022 · 7 comments
Closed

Source code todo list #541

xDivisionByZerox opened this issue Feb 22, 2022 · 7 comments
Labels
c: feature Request for new feature

Comments

@xDivisionByZerox
Copy link
Member

xDivisionByZerox commented Feb 22, 2022

This issue serves as a container for all todos listed in the source code from 03c3d11.

This covers only TODO and FIXME and no it.todo statements for now.

Column method is a static link to the original comment in 03c3d11. The other columns will be updated with time so it might be that the description you see in the table will not match with the description in the source file, because it was updated.

description link issue/pr fixed
Fix types address.zipCodeByState #759
The string parameter doesn't work as expected. address.city #682, #948
change all these methods that accept a boolean to instead accept an options hash. address #649
this.faker.definitions.address.secondary_address address.secondaryAddress #676
Limit the parameter to the two values. address.countryCode #587 #588
useAbbr not in use address.state #677
Allow coordinate parameter to be [string, string]. address.nearbyGPSCoordinate #780
Remove unused code. address.nearbyGPSCoordinate #668
implement either a gaussian/uniform distribution of points in circular region. address.nearbyGPSCoordinate #876
unimplemented member functions commerce #690
find undefined here commerce.mergeCategories #690
It may be a bug that lastDate is passed to parse if it's a Date not a string date.between #200
This is impossible to access finance.creaditCardNumber #375
We may want to make it configurable to use just \n instead of \r\n git.commitEntry #679
Mark as deprecated helpers.randomize #466
I assume this should be converted to string helpers.replaceCreditCardSymbols #755
implement for letters e.g. [0-9a-zA-Z] etc. helpers.regexpStyleStringParse -
This default will never be taken!? helpers.shuffle #684
Check what to do here helpers.uniqueArray #613
Try to improve the type or maybe use if helpers.mustache #753
We may need to convert this to a string helpers.contextualCard -
add a ranged date method helpers.createTransaction #782
This needs to be converted to string iban.toDigitString #781
iban was not used Faker ?
Find a way to load this even more dynamically. In a way so that we don't accidentally miss a definition. Faker.loadDefinitions #822
Add ipv4 alias internet.ip #649
range is not in use lorem.sentence #649
The separator looks odd. lorem.paragraphs #783
times is not in use lorem.text #649
This is buggy, cause if min is not passed but only max, then min will be undefined and this result in NaN for the whole function mersenne.rand #577
Rewrite this file to a class MersenneTwister19937 #280
Not sure if this fallthrough is wanted name.findName -
simplify name to number() phone.phoneNumber #693
this is strange passing in an array index. discuss removing this method as it tightly couples with localisation. phone.phoneNumberFormat -
simplify name to format() phone.phoneNumberFormat -
have ability to return specific type of word? As in: noun, adjective, verb, etc random.word -
Tests covered (count, options), but they were never typed like that random.alpha -
A default empty array gets assigned above, we should check the length against 0 or not here random.alpha -
This is not non-deterministic time.recent -
add default case time.recent #533
address.zipCodeByState() expects only { [state: string]: { min: number; max: number } } AddressDefinitions #759
Investigate why this test sometimes fails address -
these are TODOs allFunctional -
I converted the price string to number to satisfy TS commerce -
I converted the price string to number to satisfy TS *(this is no accidental duplication)* commerce -
We will fix the deterministic in #343 datatype #343
This function doesn't respect seeding date -
add support for more currency and decimal options finance.amount -
implement checks for each format with regexp finance.creditCardNumber -
When providing params to email, it produces some not that predictable data internet.email -
Make tests more strict internet.userAgent -
Understand what's going on internet.color -
I would say a non memorable password should satisfy validator.isStrongPassword, but it does not currently internet.password #768
This should definitely be a strong password, but it doesn't :( internet.password #768
There is a bug: #479 mersenne.rand #479
There is a bug: #373 name.firstName #373
jobTitle and title are the same name.title #766
Add multiple seed based expectations. seedRuns #765
Add test to validate if the path has ext on the end. system.filePath #765
Results are not seeded yet time -

Legend:

  • ❌ not yet fixed/fix not merged yet
  • ✔ fixed
  • ⛔ won't fix
@xDivisionByZerox xDivisionByZerox added the s: pending triage Pending Triage label Feb 22, 2022
@ST-DDT ST-DDT removed the s: pending triage Pending Triage label Feb 22, 2022
@ST-DDT ST-DDT added the c: feature Request for new feature label Feb 22, 2022
@ejcheng ejcheng moved this to Todo in Faker Roadmap Feb 22, 2022
@prisis
Copy link
Member

prisis commented Feb 22, 2022

Thank you very much, for collecting all the todos :)

@xDivisionByZerox
Copy link
Member Author

Should i add a column for fixed to keep track of fixed todos, so this issue can get closed of all other issues are closed?

@ST-DDT
Copy link
Member

ST-DDT commented Feb 22, 2022

That would be helpful. Thank you.

@ST-DDT
Copy link
Member

ST-DDT commented Apr 5, 2022

The list is getting shorter. We are now at ~50% 🥳

  • 29 ✔
  • 27 ❌
  • 4 ⛔

@ST-DDT
Copy link
Member

ST-DDT commented Jun 8, 2022

Most of the TODOs have been fixed and the rest of the links point to very old commits.
So I'm going to close this one. But we should probably create a new issue with the remaining TODOs.
@xDivisionByZerox did you create the list by hand or do you have a script for it?

@ST-DDT ST-DDT closed this as completed Jun 8, 2022
Repository owner moved this from Todo to Done in Faker Roadmap Jun 8, 2022
@xDivisionByZerox
Copy link
Member Author

I did it by hand. Probably should have written a script now that you say it ^^

@ST-DDT
Copy link
Member

ST-DDT commented Jun 9, 2022

I created a followup issue: #1044
There I included a script to generate it.

@ST-DDT ST-DDT removed this from Faker Roadmap Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: feature Request for new feature
Projects
None yet
Development

No branches or pull requests

4 participants