docs: show source link

[ST-DDT]

Fixes #1695

• Add "Go to Source" link in api-docs (per method) #1695

This PR ads a Goto Source link to each method.

The source link targets the first line of the last api signature (not the impl signature).
E.g. https://github.com/faker-js/faker/blob/d16a4d2d/src/modules/date/index.ts#L105

I haven't found a good way to display it yet.
If we don't find something better, we can just start with this and change the appearance later.

Things to decide:

• The exact text/appearance of that link?
• Whether the link targets the correct code location?
• Whether the link should target the branch or commit?
• Should the module have a source link (+since) as well?

Things to keep in mind:

• We have to exclude the sourceLink from the diff as both the commitId/branchName and the line number are likely to create lots of false positives.

[codecov]

Codecov Report

Merging #1780 (3aaebea) into next (32b9034) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #1780      +/-   ##
==========================================
- Coverage   99.63%   99.63%   -0.01%     
==========================================
  Files        2346     2346              
  Lines      235115   235115              
  Branches     1135     1132       -3     
==========================================
- Hits       234263   234258       -5     
- Misses        830      835       +5     
  Partials       22       22              

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

[matthewmayer]

I think its a bit too prominent. Most people reading the docs won't use it. I'd make it light gray so its less prominent than the method name and description.

[xDivisionByZerox]

I think its a bit too prominent. Most people reading the docs won't use it. I'd make it light gray so its less prominent than the method name and description.

We could also add a small github icon with a tooltip 🤔

[ST-DDT]

Preview

[ST-DDT]

Why does it keep removing the request for review from @matthewmayer ?

[Shinigami92]

@ST-DDT if you consider @matthewmayer's review already as member review, then I accept if you already merge right now 🙂

@matthewmayer team membership does not mean you need to attempt at meetings but provides you the ability for green approvals (and other stuff)
If you want, just say you want that your approvals count to our green-approval (internal) guide line

If a PR has 2 green approvals, it needs to wait for 24 hours to get merged, or does get a third green approval and can then directly merged
Still at least one core maintainer (@ST-DDT or @Shinigami92 ^^) needs to also be one of the approvals (what is mostly always the case anyway)

[matthewmayer]

Sure, you can add me on the team if that makes it easier to request reviews etc. Since my Typescript is fairly limited I'll only approve PRs which are more locale-focused or documentation-focused like this one.