feat: migrate to typescript

[Shinigami92]

This is the base branch of the TS migration

Please do not squash-merge this branch

How to test this PR

Use npm build and then run npx mocha test/<module>.unit.js to test the specific module
datatype is already working as an example!

We will create distinct PRs for each module and base them on this PR so a review can be simply made
After that we merge all together and then look that all (untouched) tests are running

List of PRs

• address (feat: migrate address #133)
• animal (feat: migrate animal #105)
• commerce (feat: migrate commerce #106)
• company (feat: migrate company #132)
• database (feat: migrate database #89)
• datatype (this PR, as first-class example)
• date (feat: migrate date #83)
• fake (feat: migrate fake #79)
• finance (feat: migrate finance #131)
• git (feat: migrate git #78)
• hacker (feat: migrate hacker #81)
• helpers (feat: migrate helpers #85)
• iban (feat: migrate finance #131)
• image (feat: migrate image #92)
• internet (feat: migrate internet #94)
• locales
• lorem (feat: migrate lorem #86)
• mersenne (this PR, also part of random in feat: migrate random #91)
• music (feat: migrate music #107)
• name (feat: migrate name #103)
• phone_number (feat: migrate phone #127)
• random (this PR + needs a PR for extending it (feat: migrate random #91))
• system (feat: migrate system #90)
• time (feat: migrate time #74)
• unique (feat: migrate unique #128)
• vehicle (feat: migrate vehicle #130)
• word (feat: migrate word #102)

Legend:

• red = not tackled yet
• green = in base branch or ready to be reviewed
• blue = in draft PR

GraphViz Source

digraph ModuleGraph {
  # Colors:
  # red = not tackled yet
  # green = in base branch or ready to be reviewed
  # blue = in draft PR

  address[color=red]
  animal[color=blue]
  commerce[color=blue]
  company[color=red]
  database[color=green]
  datatype[color=green]
  date[color=green]
  fake[color=blue]
  finance[color=red]
  git[color=blue]
  hacker[color=blue]
  helpers[color=blue]
  iban[color=red]
  image[color=blue]
  internet[color=blue]
  locales[color=red]
  lorem[color=blue]
  mersenne[color=green]
  music[color=blue]
  name[color=blue]
  phone_number[color=red]
  random[color=blue]
  system[color=blue]
  time[color=green]
  unique[color=red]
  vehicle[color=red]
  word[color=blue]
  "_definitions"[color=black]
    
  datatype -> mersenne
  datatype -> datatype
  datatype -> random
  time
  git -> hacker
  git -> datatype
  git -> date
  git -> fake
  git -> random
  fake -> "*"
  hacker -> random
  hacker -> "_definitions"
  hacker -> helpers
  date -> datatype
  date -> "_definitions"
  date -> random
  helpers -> random
  helpers -> datatype
  helpers -> helpers
  helpers -> name
  helpers -> internet
  helpers -> address
  helpers -> phone
  helpers -> company
  helpers -> lorem
  helpers -> date
  helpers -> finance
  helpers -> "_definitions"
  lorem -> "_definitions"
  lorem -> random
  lorem -> lorem
  lorem -> datatype
  lorem -> fake
  database -> random
  database -> "_definitions"
  system -> random
  system -> system
  system -> "_definitions"
  system -> fake
  system -> datatype
  random -> mersenne
  random -> datatype
  random -> random
  random -> fake
  random -> image
  random -> locales
  image -> random
  image -> internet
  image -> datatype
  image -> image
  internet -> random
  internet -> "_definitions"
  internet -> helpers
  internet -> internet
  internet -> name
  internet -> datatype
  internet -> word
  name -> "_definitions"
  name -> datatype
  name -> random
  name -> locales
  name -> locale
  name -> name
  animal -> random
  animal -> "_definitions"
  commerce -> "_definitions"
  commerce -> random
  commerce -> datatype
  commerce -> commerce
  music -> "_definitions"
  music -> random
}

[ericjeker]

Hi @Shinigami92,

Did you already add a tsconfig.json? I can't see it anywhere.

[Shinigami92]

Hi @Shinigami92,

Did you already add a tsconfig.json? I can't see it anywhere.

It's a draft PR for a reason 😅

[ericjeker]

Ahah, OK no worries. 🙈
I have set up this one below for TypeDoc if you wanna use it. Or should I put that in a separate PR so we can quickly merge it?

{
  "compilerOptions": {
    "module": "commonjs",
    "declaration": true,
    "removeComments": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "skipLibCheck": true,
    "strict": true,
    "target": "es2016",
    "sourceMap": true,
    "outDir": "./dist",
    "baseUrl": "./",
    "incremental": true
  },
}

[Shinigami92]

A PR based on this PR would be helpful here
Then we can better review it and test stuff out

[netlify]

✔️ Deploy Preview for vigilant-wescoff-04e480 ready!

🔨 Explore the source changes: 23e4498

🔍 Inspect the deploy log: https://app.netlify.com/sites/vigilant-wescoff-04e480/deploys/61e1de10954bd3000731c030

😎 Browse the preview: https://deploy-preview-72--vigilant-wescoff-04e480.netlify.app

[damienwebdev]

lgtm

[damienwebdev]

lgtm

[damienwebdev]

Rebased into main as 2cc42f2