Check modules and methods regarding their name and location

[ST-DDT]

Clear and concise description of the problem

Some methods are misplaced or misnamed. The same is true for some module.

E.g. the string and number methods, or the address and name modules

Suggested solution

Check every module and method regarding their current name/location.

Alternative

No response

Additional context

No response

[ST-DDT]

See also

• Plans for restructuring our modules in v7 #805

[ST-DDT]

Blocked by

• Move String methods into own module #1341
• Move Number methods to own module #1342
• Rename Name module to Person #1343
• Rename Address module to Location #1344
• Rewrite image module / providers #1350

[xDivisionByZerox]

This should no longer be blocked. Correct, @ST-DDT?

[ST-DDT]

@xDivisionByZerox Yeah, you are right. Do you wish to tackle this?

[xDivisionByZerox]

Checklist from my side:

Module	State
Animal	✅
Color	✅
Commerce	✅
Company	bs should probably be deprecated refactor(company)!: rename bs to buzz #1860 bsAdjective should probably be merged into catchPhraseAdjective and deprecate refactor(company)!: rename bs to buzz #1860 bsBuzz should probably be called buzzWord (is that correctly written?) refactor(company)!: rename bs to buzz #1860 bsNoun should probably be merged into catchPhraseNoun and deprecated refactor(company)!: rename bs to buzz #1860
Database	✅
Datatype	#1590
Date	I don't really know why we have between AND betweens potentially month should be called monthName
Finance	account should probably be called accountNumber refactor(finance): rename account to accountNumber #2054 ❌ iban should perhaps be called IBAN mask should be renamed to maskedNumber or be removed refactor(finance): rename mask to maskedNumber #2055
Git	✅ shortSha should probably be merged with commitSha and configurable via an argument
Hacker	ingverb should probably be called ingVerb (or generally a better name)
Helpers	✅
Image	✅
Internet	There is email AND exampleEmail (what is an example email?)
Location	city and cityName should probably be merged nearbyGPSCoordinate perhaps could be redefined to coordinates state and stateAbbr should probably be merged refactor(location): merge state and stateAbbr #2060 streetAddress Having street, streetAddress, streetName AND secondaryAddress is very confusing to me street and streetName should probably be merged refactor(location)!: rename definition street to street_pattern #2051
Lorem	slug seems out of place for me here There is paragraphs and text - aint that the same thing?
Music	✅
Number	Maybe a bit weird that int and hex use abbreviation while binary and octal don't, but ✅
Person	job* could fit in the CompanyModule as well
Phone	✅
Random	Having a word function while we have an entire WordModule seems off (same for words) locale should probably be located in the LocationModule The RandomModule could be dropped entirely
Science	✅
String	fromCharacters should probably be located in the HelpersModule ✅ special should probably be called symbol Generate random symbol (eg: ! _ #) #1711
System	✅
Vehicle	vin should probably be called identificationNumber for readability purposes vrm should probably be called registrationMark for readability purposes
Word	✅

[import-brain]

Checklist from my side:

Module State
Animal ✅
Color ✅
Commerce ✅
Company

• bs should probably be deprecated
• bsAdjective should probably be merged into catchPhraseAdjective and deprecate
• bsBuzz should probably be called buzzWord (is that correctly written?)
• bsNoun should probably be merged into catchPhraseNoun and deprecated

Database ✅
Datatype #1590
Date

• I don't really know why we have between AND betweens
• potentially month should be called monthName

Finance

• account should probably be called accountNumber
• iban should perhaps be called IBAN
• mask should be renamed to maskedNumber or be removed

Git

• shortSha should probably be merged with commitSha and configurable via an argument

Hacker

• ingverb should probably be called ingVerb (or generally a better name)

Helpers ✅
Image ✅
Internet

• There is email AND exampleEmail (what is an example email?)

Location

• city and cityName should probably be merged
• nearbyGPSCoordinate perhaps could be redefined to coordinates
• state and stateAbbr should probably be merged
• streetAddress
• Having street, streetAddress, streetName AND secondaryAddress is very confusing to me
• street and streetName should probably be merged

Lorem

• slug seems out of place for me here
• There is paragraphs and text - aint that the same thing?

Music ✅
Number Maybe a bit weird that int and hex use abbreviation while binary and octal don't, but ✅
Person

• job* could fit in the CompanyModule as well

Phone ✅
Random

• Having a word function while we have an entire WordModule seems off (same for words)
• locale should probably be located in the LocationModule
• The RandomModule could be dropped entirely

Science ✅
String

• fromCharacters should probably be located in the HelpersModule
• special should probably be called symbol Generate random symbol (eg: ! _ #) #1711

System ✅
Vehicle

• vin should probably be called identificationNumber for readability purposes
• vrm should probably be called registrationMark for readability purposes

Word ✅

About lorem.slug, perhaps we could move it to a new method internet.slug? I feel like it would make more sense in internet. I assume we would have to deprecate lorem.slug first though

[xDivisionByZerox]

✅ Team Decision: Company

bs should probably be deprecated

Yes!

bsAdjective should probably be merged into catchPhraseAdjective and deprecate
bsBuzz should probably be called buzzWord (is that correctly written?)
bsNoun should probably be merged into catchPhraseNoun and deprecated

Replace bs* with buzz* and improve JSDocs (buzz = manager language, catchPhrase = user language).

[xDivisionByZerox]

Team Decision: Date

I don't really know why we have between AND betweens

To be decided later.

potentially month should be called monthName

Sounds good. More information will be discussed in an individual issue.

[xDivisionByZerox]

✅ Team Decision: Finance

account should probably be called accountNumber

Sounds good.

mask should be renamed to maskedNumber or be removed

Renaming sounds good.

iban should perhaps be called IBAN

Nope, this is naming convention. Will not be changed.

[xDivisionByZerox]

✅ Team Decision Git

shortSha should probably be merged with commitSha and configurable via an argument

Sound good. Can be a length param.

[xDivisionByZerox]

Team Decision: Hacker

ingverb should probably be called ingVerb (or generally a better name)

We want to give this a more descriptive name but will discuss the details later. We can also consider removing but require more information for other languages.

[xDivisionByZerox]

Team Decision: Internet

There is email AND exampleEmail (what is an example email?)

rfc2606 - .example domain
We can merge both via an option flag in email and url.

[xDivisionByZerox]

Team Decision: Location

state and stateAbbr should probably be merged

Sounds good.

city and cityName should probably be merged
street and streetName should probably be merged
nearbyGPSCoordinate perhaps could be redefined to coordinates

Discuss all naming later.

Having street, streetAddress, streetName AND secondaryAddress is very confusing to me

Discuss later.

---

✅ We also want to merge zipCode and zipCodeByState. zipCode should then throw an error if the provided state argument is unknown.

[Shinigami92]

It seems we have tackled all needed changes. If we want to change something additionally, we should open issues/PRs specifically.