Add format stats option

[CaedenPH]

Implements #2128

The ability for users to add a format_stats option removing the annoying k formating. This defaults to true

[vercel[bot]]

@CaedenPH is attempting to deploy a commit to the github readme stats Team on Vercel.

A member of the Team first needs to authorize it.

[rickstaa]

@CaedenPH Thanks for the pull request. Although we are not merging this PR for now, I'm happy to add the hacktoberfest-accepted label if you make the requested changes above.

[CaedenPH]

@rickstaa I have added tests and renamed format_stats to shorten_values

[codecov[bot]]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (b928f51) 97.30% compared to head (bd4a99d) 97.31%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2155   +/-   ##
=======================================
  Coverage   97.30%   97.31%           
=======================================
  Files          24       24           
  Lines        4236     4242    +6     
  Branches      384      385    +1     
=======================================
+ Hits         4122     4128    +6     
  Misses        112      112           
  Partials        2        2           

Impacted Files	Coverage Δ
api/index.js	96.03% <100.00%> (+0.07%)	:arrow_up:
src/cards/stats-card.js	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[rickstaa]

@CaedenPH Thanks for your contribution. I accepted your changes and attached the hacktoberfest-accepted label, so it should appear in 7 days as accepted in your Hacktoberfest dashboard. I can, however, not guarantee that we will ever merge this PR (see https://github.com/anuraghazra/github-readme-stats/issues/2128#issuecomment-1271427583).

[CaedenPH]

@CaedenPH Thanks for your contribution. I accepted your changes and attached the hacktoberfest-accepted label, so it should appear in 7 days as accepted in your Hacktoberfest dashboard. I can, however, not guarantee that we will ever merge this PR (see https://github.com/anuraghazra/github-readme-stats/issues/2128#issuecomment-1271427583).

Thanks: To be honest, I completely forgot about hacktoberfest and I'm not trying to get the 4 pull requests. I just made this pull request because its a feature I personally really would love to see implemented and this is an awesome project.

Keep up the great work!

[rickstaa]

@CaedenPH Thanks for your contribution. I accepted your changes and attached the hacktoberfest-accepted label, so it should appear in 7 days as accepted in your Hacktoberfest dashboard. I can, however, not guarantee that we will ever merge this PR (see #2128 (comment)).

Thanks: To be honest, I completely forgot about hacktoberfest and I'm not trying to get the 4 pull requests. I just made this pull request because its a feature I personally really would love to see implemented and this is an awesome project.

Keep up the great work!

I see. Thanks again for the contribution! You can already use your PR on your own fork. IF there is enough interest from the community, we will merge it into the master! 👍🏻

[CaedenPH]

@anuraghazra I believe I have made the changes you want

1. Should we return an error if they pass a value that is not short or long? Personally I would assume not
2. How should I improve the readme documentation? I feel like I haven't worded it ideally

[guylepage3]

+1 for removing the annoying k suffix

[rickstaa]

@anuraghazra I believe I have made the changes you want

1. Should we return an error if they pass a value that is not short or long? Personally I would assume not
2. How should I improve the readme documentation? I feel like I haven't worded it ideally

1.

I think having it fallback to shortin that case if good enough.

2.

I think the documentation is clear.

[rickstaa]

+1 for removing the annoying k suffix

I asked @Zo-Bro-23 to review it so that this PR can be merged.

[guylepage3]

@Zo-Bro-23 — Bro. Can you review this when you get a moment? Thank you.

[Zo-Bro-23]

I will merge this, but it would be great if this was added for the repo card too.