docs: searchable api

[Shinigami92]

This is a draft to make the API searchable like https://vuejs.org/api/

[codecov]

Codecov Report

Merging #1253 (0bdd6ea) into main (f684a14) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1253      +/-   ##
==========================================
- Coverage   99.63%   99.62%   -0.01%     
==========================================
  Files        2160     2160              
  Lines      240431   240431              
  Branches     1008     1006       -2     
==========================================
- Hits       239542   239532      -10     
- Misses        868      878      +10     
  Partials       21       21              

Impacted Files	Coverage Δ
src/modules/internet/user-agent.ts	81.74% <0.00%> (-2.65%)	⬇️

[Shinigami92]

Current State

[ST-DDT]

Amazing! Do we want to search for only the names or do we also want to search for some (hidden) aliases/tags?

[Shinigami92]

Amazing!

thx :3

Do we want to search for only the names or do we also want to search for some (hidden) aliases/tags?

Not sure, I would start with simple solution
But I think I need to normalize some stuff (like _Date => Date)

[ST-DDT]

I think we already have the normalization somewhere for the api docs themselves.

faker/scripts/apidoc/moduleMethods.ts

Line 37 in e5951c0

const moduleName = module.name.replace('_', '');

Maybe we should extract it to a separate method (normalizeModuleName).

For method names we have that to a certain extend already:

faker/scripts/apidoc/signature.ts

Line 30 in e5951c0

export function prettifyMethodName(method: string): string {

(We might have to separate between id-names and title-names though)

[Shinigami92]

Okay, I think I need to generate at build-time a data json for the search page, because I would like to prevent the need of recreating the search data object everytime someone visit the search page on their client

[ST-DDT]

Blocked by #1272 and then it needs to be rebased to use the new methods so we have consistent api docs and search index.

[Shinigami92]

Current State

Anything else to get that merged? Or could we maybe enhance it in later PRs if needed and serve now the doc-user UX?