Compare commits

...
Author SHA1 Message Date
rickstaa 3afe547077 feat: add 'progress' rank icon
This commit gives users the ability to show the `progress` compared to
the highest possible rank in the stats card.
2023-06-22 10:45:25 +02:00
Alexandr Garbuzov f282ce4d64 Docs: improve quick align tip section (#2865)
* Docs: move extra pins align tip into correct section

* dev

* dev

* dev

* dev

* dev

* dev
2023-06-22 10:29:10 +02:00
Alexandr Garbuzov de431b934d Use stable axios version 1.x.x (#2873) 2023-06-22 10:27:54 +02:00
Rick StaaandAlexandr 2642fc546c add percentile rank icon (#2859)
* feat: add 'percentile' rank icon

This commit adds the `percentile` option for the `rank_icon` query
variable. This option displays the rank percentile the user belongs to.

* style: improve percentile rank icon styling

* dev

* dev

* dev

---------

Co-authored-by: Alexandr <qwerty541zxc@gmail.com>
2023-06-20 08:47:02 +02:00
Alexandr Garbuzov de093e8118 Docs: improve GitHub media feature example HTML formatting (#2862) 2023-06-20 08:42:11 +02:00
Alexandr Garbuzov ae6e2cc31b CI: improve pull requests labeler (#2863) 2023-06-20 08:41:40 +02:00
Alexandr Garbuzov 697c3e52b4 Docs: change example wakatime profile (#2861) 2023-06-20 07:58:02 +02:00
Rick Staa a362af0ebc feat: add 'progress' rank icon (#2858)
This pull request allows users to replace the rank level with the rank progress
by setting the `rank_icon` query to `progress`.
2023-06-19 12:58:02 +02:00
Alexandr Garbuzovandrickstaa 62080c019c Remove several redundant number -> string -> number conversions (#2856)
* Top langs card: remove redundant number -> string -> number conversion

* refactor(waka): remove redundant praseInt

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-19 13:45:49 +03:00
Alexandr Garbuzovandrickstaa 9a1cbaf062 Set prettier as workspace default formatter (#2854)
* Set prettier as workspace default formatter

* fix: fix conflicts

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-19 09:45:23 +02:00
Alexandr Garbuzov d727d178f0 Docs: fix link for extra pins card options (#2855) 2023-06-19 08:33:02 +02:00
Alexandr Garbuzov 92518e375f Stats card: show started and answered discussions stats (#2849)
* Stats card: show started and answered discussions stats

* trans

* dev
2023-06-19 05:51:58 +02:00
Rick Staa a5260cb38a feat: improve locale translation not found error (#2853) 2023-06-19 06:06:24 +03:00
Alexandr Garbuzov 03b0ba096c Wakatime card: add missing translations (resolves #2839) (#2850) 2023-06-18 18:31:58 +02:00
Alexandr Garbuzov eebaa44f2a CI: Add missing bracket inside theme preview workflow warning (#2847) 2023-06-18 00:04:35 +02:00
Alexandr Garbuzov 2e65a2ee10 Docs: fix broken demos link (#2848) 2023-06-18 00:03:56 +02:00
Alexandr Garbuzovandrickstaa b70b089b8e Stats card: migrate from show_total_reviews to show option (resolves #2836) (#2844)
* Stats card: migrate from show_total_reviews to show option (resolves #2836)

* dev

* docs: improve documentation

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-17 23:10:13 +03:00
Alexandr Garbuzov 6cbb08e218 Stats card: remove duplicate hide option default value from render function (#2845) 2023-06-17 11:14:24 +02:00
Alexandr Garbuzov c5d4bcbc1a Docs: make important notice link clickable (#2841) 2023-06-17 06:19:20 +02:00
Alexandr Garbuzov 331fa1183a Docs: Increase maximum languages count to 20 (#2843) 2023-06-17 06:18:02 +02:00
Alexandr Garbuzov a43fb81b23 Add missing bracket inside CONTRIBUTING.md notice (#2842) 2023-06-17 06:14:13 +02:00
Alexandr Garbuzov 1997328951 Top langs card: Increase maximum languages count to 20 (#2832) 2023-06-16 09:27:37 +02:00
Alexandr Garbuzov 99aca1b6d5 Fixed docstring for trimTopLanguages function (#2833)
* Fixed docstring for trimTopLanguages function

* dev
2023-06-16 09:25:46 +02:00
Alexandr Garbuzov 4db78d7796 Docs: improve GitHub media feature HTML example formatting (#2830) 2023-06-16 08:46:44 +02:00
Alexandr Garbuzov 05efc2811b Docs: make discussion link clickable (#2831) 2023-06-16 08:45:25 +02:00
Alexandr Garbuzov 3831d18991 Stats card: Change total reviews label and add missing translations (#2835) 2023-06-16 08:44:19 +02:00
Alexandr Garbuzov 7a89ceedc9 Stats card: Reorder total reviews count position (#2834) 2023-06-16 08:43:07 +02:00
Rick Staa 22a12e1ade ci: increase top-issues-action list size (#2826) 2023-06-15 23:28:19 +03:00
Rick Staa 632549ddee Revert "Use default json import (#2820)" (#2829)
This reverts commit 1474a3abbe.
2023-06-15 23:25:07 +03:00
Rick Staa 89e37aa885 refactor: add PR review translations (#2825) 2023-06-15 22:24:47 +02:00
1bb65ddc29 Added pr reviews to stats (#1404)
* Added pr reviews to stats

* Add 'show' query parameter

* Fix show test

* refactoring

* cleanup

* refactor: restructure stats-card code

---------

Co-authored-by: Markus <markus.tyrkko@gmail.com>
Co-authored-by: Alexandr <qwerty541zxc@gmail.com>
Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-15 09:35:09 +02:00
Alexandr Garbuzov c86cc72df2 Specify node version for NVM (node version manager) users (#2824) 2023-06-15 09:27:48 +02:00
Alexandr Garbuzov 1474a3abbe Use default json import (#2820) 2023-06-15 09:27:28 +02:00
Alexandr Garbuzov d5a4dbdc7e Specify node version inside package.json (#2823) 2023-06-15 09:25:58 +02:00
Alexandr Garbuzov c4035a5765 Use node 18.x in continuous integration (#2819) 2023-06-14 09:08:40 +02:00
Rick Staa 9831d254d7 test: update 2e2 rank values (#2816)
This commit ensures the new rank values introduced by #2762 are added
to the 2e2 test.
2023-06-13 16:58:30 +03:00
François Rozet 66e5492654 Add finer ranking levels (#2762)
* Add finer ranking levels

* Update rank description
2023-06-12 14:38:07 +02:00
Alexandr Garbuzov 768721f325 Improve pull requests labeler (#2812) 2023-06-12 09:08:49 +02:00
Alexandr Garbuzov 99d560f573 Add vscode settings for yzhang.markdown-all-in-one extension (#2813) 2023-06-12 09:08:24 +02:00
Alexandr Garbuzov 5218e34084 Remove duplicate from .gitignore (#2814) 2023-06-12 08:29:46 +02:00
Alexandr Garbuzov a967581603 Docs (translations): Regenerated tables of contents using yzhang.markdown-all-in-one extension (#2811) 2023-06-12 08:28:16 +02:00
Alexandr Garbuzovandrickstaa faf0c25b90 Update automated themes preview workflow contributions guideline (#2808)
* Update automated themes preview workflow contributions guideline

* docs: link to top-issues dashboard

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-11 15:21:58 +02:00
Rick StaaandGitHub Readme Stats Bot 92a9d85c4a docs(theme): Auto update theme readme (#2810)
Co-authored-by: GitHub Readme Stats Bot <no-reply@githubreadmestats.com>
2023-06-11 15:34:34 +03:00
Alexandr Garbuzovandrickstaa 2704e25d5d Add yzhang.markdown-all-in-one to recommended workspace extensions (#2809)
* Add yzhang.markdown-all-in-one to recommended workspace extensions

* refactor: update .gitignore

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-11 15:30:04 +03:00
Anirban Das 041ef07ea4 Added neon theme (#2579)
Added neon themes with bright colors that goes well with dark backgrounds.
2023-06-11 12:34:54 +02:00
Alexandr Garbuzov dc60ea9b30 Docs: set correct separation symbol between translations links (#2806) 2023-06-11 12:11:17 +02:00
Alexandr Garbuzov 9520baac1f Docs: rename wakatime stats card section (#2807) 2023-06-11 12:10:04 +02:00
Rick Staa 9105c74af4 docs: add PAT permission to docs (#2805)
This commit changes the README so that users are aware that they also
need to set the `user` permission when creating the PAT when they want
their private commits to show up.
2023-06-11 03:39:33 +03:00
Rick StaaandAlexandr a6645325e7 docs: add FAQ to readme (#2804)
* docs: add FAQ to readme

* Change separation symbol to correct one

* dev

---------

Co-authored-by: Alexandr <qwerty541zxc@gmail.com>
2023-06-11 03:38:18 +03:00
Rick Staa fec686a432 ci: fix top-issues action (#2803) 2023-06-11 03:20:08 +03:00
Alexandr Garbuzovandrickstaa 5696c96372 Docs: fixed table of contents aligment (#2795)
* Fixed table of contents aligment inside README

* dev

* docs: decrease toc depth

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-11 03:18:56 +03:00
Alexandr Garbuzov a775176766 Remove restrictedContributionsCount from GraphQL query and tests (#2799) 2023-06-10 10:40:41 +02:00
Alexandr Garbuzov c506eccb8e Explain our themes PRs merging policy inside CONTRIBUTING.md (#2801) 2023-06-10 08:53:07 +02:00
Alexandr Garbuzov 4eda5cd4fa Beautify themes contribution note inside CONTRIBUTING.md (#2800) 2023-06-10 03:52:00 +02:00
Rick Staa ec5b110cda docs: add package debug steps to contribution guidelines (#2798) 2023-06-10 04:26:47 +03:00
しぐれandrickstaa 44c268e05a Update readme.md about maxDuration (#2792)
* Update readme.md about maxDuration

I think we can remove this warning section since that value in  `.json` has been changed to 10 by default nowadays?

* Update readme.md

remove related section in self deployment section as well

* docs: add inverse maxDuration warning

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-09 10:06:45 +03:00
Alexandr Garbuzov 7a302f6f67 Docs: add warning about top languages card behavior. (#2789)
* Docs: add warning about top languages card behavior.

* dev

* dev
2023-06-09 07:43:32 +02:00
Alexandr Garbuzov 3416ae114f Fix clampValue function docstring (#2796) 2023-06-09 07:41:58 +02:00
Alexandr Garbuzov b5f5befe32 Remove redundant ask for theme screenshot from CONTRIBUTING.md (#2797) 2023-06-09 07:41:28 +02:00
Rick Staa 3e66189c44 feat: add CACHE_SECONDS environment variable (#2266)
* feat: add CACHE_SECONDS environment variable

This commit adds the CACHE_SECONDS environment variable. This variable
can be used to circumvent our cache clamping values for self hosted
Vercel instances.

* refactor: apply formatter
2023-06-09 04:44:42 +03:00
Alexandr Garbuzov 38c8a7a1e4 Resolved dependabot vulnerability alert about json5 package (#2788) 2023-06-08 08:10:31 +02:00
Alexandr Garbuzov 7053a03081 Docs: fixed small typo inside readme in keep fork up to date section (#2787) 2023-06-08 08:09:21 +02:00
Rick Staa b9200c6cf6 feat: remove 'include_private' (#2736)
* feat: remove 'include_private'

As explained in #2517 the 'include_private' flag is confusing and
doesn't work as expected. This commit therefore removes this flag.

* fix: fix tests

* docs: remove redundant private deploy note
2023-06-07 11:21:28 +03:00
Rick Staa 0fe51cd539 docs: fix some typos (#2783) 2023-06-07 10:59:59 +03:00
Alexandr Garbuzov 606775c33c Fix no languages data node function docstring (#2782)
* Fix docstring for noLanguagesDataNode function

* dev
2023-06-07 09:21:19 +02:00
Alexandr Garbuzov dfe0766cbb Fix docstring for noCodingActivityNode function (#2781) 2023-06-07 09:20:59 +02:00
Alexandr Garbuzov 4044a0b666 Use compact layout default langs count when hide_progress param was set (#2780) 2023-06-07 09:20:03 +02:00
Rick StaaandAlexandr Garbuzov f2841e09e1 fix: fix stats contributed to translations (#2708)
* fix: fix stats contributed to translations

* Improved russian and ukrainian translation of statcard.contribs (#2715)

---------

Co-authored-by: Alexandr Garbuzov <53787217+qwerty541@users.noreply.github.com>
2023-06-07 10:19:40 +03:00
Rick Staa 31ffe56168 docs: improve readme links (#2696) 2023-06-07 10:17:20 +03:00
Alexandr Garbuzov bdef1cccdd Add note about private contributions into readme (#2776)
* Add note about private contributions into readme

* dev
2023-06-06 17:26:15 +02:00
Anurag Hazra a8ecd3dc96 chore: added new dono link (#2779)
* chore: added new dono link

* chore: update
2023-06-06 20:35:11 +05:30
Alexandr Garbuzovandrickstaa 894f2e2c5a Different default languages count for different languages card layouts (#2774)
* Different default languages count for different layouts

* docs: update default  documentation

Updates the README so that the new `langs_count` default behavoir is
explained to users.

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-06-06 16:42:46 +02:00
Rick Staa cec5ee3462 ci: add top themes and labels to 'top issues dashboard' action (#2711) 2023-06-06 14:24:17 +05:30
Alexandr Garbuzov fa4d7ee7a1 Cover with test changes in #2770 pull request (#2775) 2023-06-06 08:56:23 +02:00
Alexandr Garbuzov 14fe4cf1db Remove redundant async notation from several top languages card tests (#2767) 2023-06-05 12:14:33 +02:00
Alexandr Garbuzov 1e0183d202 Conver with test changes in #2755 pull request (#2766) 2023-06-05 12:11:55 +02:00
Alexandr Garbuzov 98b047751e Fixed layout toLowerCase bug (#2770) 2023-06-05 12:10:22 +02:00
Rick Staa 1a2a82c3be test: add new ranking to e2e test (#2750) 2023-06-02 14:44:12 +05:30
Rick StaaandHakula Chen c301289f7d fix: Make WakaTime card compatible with new API (#2707)
* fix: Make WakaTime card compatible with new API

This commit makes sure that the WakaTime card works with the new
WakaTime API. See https://github.com/anuraghazra/github-readme-stats/issues/2698
for more information.

* fix: fix chinese simplified translations

* fix: improve WakaTime range order

* test: fix WakaTime tests

* refactor: remove WakaTime range loop

* refactor: remove redundant WakaTime call

* test: fix e2e tests

Co-authored-by: Hakula Chen <i@hakula.xyz>

---------

Co-authored-by: Hakula Chen <i@hakula.xyz>
2023-06-02 14:37:59 +05:30
github-actions[bot]andrickstaa e0b3d833b0 refactor: update languages JSON (#2760)
Co-authored-by: rickstaa <rickstaa@users.noreply.github.com>
2023-05-31 13:24:11 +02:00
Alexandr Garbuzov 275c1fc1c7 Show notice about no languages data instead of empty card (#2755)
* Show message about no languages data instead of empty card

* dev

* dev

* dev

* dev

* dev

* dev
2023-05-29 08:45:19 +02:00
Alexandr Garbuzov 73b0a91b7b Improve ukrainian translation of langcard.title (#2756) 2023-05-29 08:43:37 +02:00
François RozetandRick Staa c96e84a9ae Ranking System v2 (#1186)
* Revise rank calculation

* Replace contributions by commits

* Lower average stats and S+ threshold

* Fix calculateRank.test.js

Missing key in dictionary constructor

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* refactor: run prettier

* feat: change star weight to 0.75

* Separate PRs and issues

* Tweak weights

* Add count_private back

* fix: enable 'count_private' again

* test: fix tests

* refactor: improve code formatting

* Higher targets

---------

Co-authored-by: Rick Staa <rick.staa@outlook.com>
2023-05-26 15:39:35 +02:00
Alexandr Garbuzov ff2e02ba68 Docs: fix top languages card available layouts number (#2738) 2023-05-22 22:40:21 +02:00
Alexandr Garbuzov c8d5eda27c Docs (translations): add top languages card donut vertical layout (#2739) 2023-05-22 22:39:43 +02:00
Alexandr Garbuzov f9427b2a54 Top languages card donut vertical layout (#2701)
* Top languages card donut layout

* dev

* dev

* dev

* dev
2023-05-19 10:45:29 +02:00
Alexandr Garbuzov 7ec1a76c65 Docs (translations): add missing top languages card layouts. (#2728) 2023-05-17 08:37:25 +02:00
Alexandr Garbuzov 6d45f89c9e Top languages card render test: move repeated code into helper function (#2718) 2023-05-13 13:21:06 +02:00
Alexandr Garbuzov d59a80599f Docs: add missing top languages card layouts. (#2717) 2023-05-13 13:20:18 +02:00
Alexandr Garbuzov ff9839b73c Top languages card pie layout (#2709)
* Top languages card donut layout

* Top languages card pie layout

* renames

* dev

* docs

* dev

* dev

* animations

* dev

* handle one language
2023-05-11 08:49:57 +02:00
Alexandr Garbuzov 1f4a2c4d82 Add missing argument to create compact lang node function to resolve vscode type error (#2714) 2023-05-11 08:36:21 +02:00
Alexandr Garbuzov 4b19453c1a Fixed docstring for create donut language node function (#2713) 2023-05-10 22:59:00 +02:00
Nabil Alaminandrickstaa c5e7f7b490 add pie chart layout to language card (#2099)
* add pie chart layout to language card

* resolve failing top-lang card tests

* scale down pie chart

* update readme.md

* Update readme.md

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* style: format code

* update donut layout to be created without dependencies

* minor update

* style: format readme

* resolve failing tests

* refactor: clean up code and add extra tests

This commit cleans up the pie chart generation code and adds additional
tests.

* feat: improve pie chart positioning

* rename layout pie to donut

* add animation to donut layout

* refactor: rename pie and doughnut to donut

* feat: decrease donus animation delay

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-05-09 20:54:34 +02:00
Alexandr Garbuzov daa1977ba3 Fixed docstring for wakatime card recalculate percentages function (#2710) 2023-05-09 09:04:02 +02:00
Alexandr Garbuzov 8ff5a3ba45 Fixed docstring for create language text node function (#2704) 2023-05-08 09:33:08 +02:00
Alexandr Garbuzov 550b88ce87 Update wakatime user inside docs translations (#2705) 2023-05-08 09:32:50 +02:00
Alexandr Garbuzov ce116e2d2f Fixed typos inside bug report issue template (#2706) 2023-05-08 09:31:47 +02:00
Alexandr Garbuzov 15436e2aa1 Fixed axios imports inside docstrings to resolve vscode type errors (#2699) 2023-05-07 22:03:26 +02:00
Alexandr Garbuzov 6f449a1f0b Fixed docstring for get styles function to resolve vscode type errors (#2700) 2023-05-07 22:03:00 +02:00
Rick Staa 688f4e4975 docs: update wakatime user (#2697)
The old example user doesn't have a WakaTime account anymore.
2023-05-06 15:29:11 +05:30
Rongrong 0caa4c5fd8 test: fix mistaken pageInfo.endCursor keys (#2657)
The previous mock logic was too simplistic and has been fixed in the
commit. If the mock logic had been properly implemented, then the
mistaken pageInfo.endCursor keys should have made the test case "should
fetch two pages of stars if 'FETCH_MULTI_PAGE_STARS' env variable is set
to `true`" stuck.
2023-05-06 08:07:03 +00:00
Alexandr Garbuzov 0c2fe4e07b Cover with test changes in #2662 pull request (#2673) 2023-05-06 07:43:37 +00:00
Fabiano CoutoandRick Staa a340900e8a fix(wakatime-fetcher): add default range to prevent user not found error (#2670)
* feat(theme): add github_dark_dimmed theme

* feat(theme): change github_dark_dimmed icon color

* contrast ratio adjustment

contrast ratio adjustment on github_dark_dimmed theme

* feat(theme): readme preview

* feat(theme): github themes next to each other

* github themes next to each other

* feat(RankIcon): add rank icon option

* feat(RankIcon): extract rankIcon to icons file

* feat(RankIcon): update readme

* feat(RankIcon): test coverage

* Update readme.md

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* add wakatime default range

* update wakatime demos in readme with most active user

* update wakatime demo in readme

* remove &range=all_time from wakatime demos in readme

---------

Co-authored-by: Rick Staa <rick.staa@outlook.com>
2023-05-05 23:12:28 +02:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 2619c12638 build(deps): bump yaml from 2.1.3 to 2.2.2 (#2644)
Bumps [yaml](https://github.com/eemeli/yaml) from 2.1.3 to 2.2.2.
- [Release notes](https://github.com/eemeli/yaml/releases)
- [Commits](https://github.com/eemeli/yaml/compare/v2.1.3...v2.2.2)

---
updated-dependencies:
- dependency-name: yaml
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-05 14:10:17 +00:00
Alexandr Garbuzov d306bec73e Add PRs cache cleaning workflow (#2661) 2023-05-05 14:09:23 +00:00
Alexandr Garbuzov c656f3df6b Update codecov action version to resolve github action deprecation warning (#2677) 2023-05-05 14:07:37 +00:00
Alexandr Garbuzov c6dab8b0f2 Fixed docstring for stats card create text node function to resolve type errors (#2689) 2023-05-05 14:07:15 +00:00
Alexandr Garbuzov 311204f4f9 Fixed docstring for several wakatime card gen functions to resolve multiple type errors (#2690) 2023-05-05 14:06:52 +00:00
Alexandr Garbuzov 0dc3531666 Fixed wakatime create text node func docstring to resolve vscode type errors (#2678) 2023-05-04 09:13:47 +02:00
Alexandr Garbuzov a4d6fe104f Fixed card constructor docstring to resolve vscode type errors (#2674) 2023-05-03 07:04:33 +02:00
Alexandr Garbuzov cb99414d3d Show no activity error in compact layout of wakatime card (#2662) 2023-05-01 08:21:29 +02:00
Alexandr Garbuzov 2f4279e738 Fixed vscode type error in get card colors function (#2660) 2023-04-30 08:20:26 +02:00
Rick Staa 3bd6519d39 docs: fix README language card usage order (#2659) 2023-04-29 08:25:37 +05:30
Alexandr Garbuzov 31d1ab43d0 Fixed todo inside stats card data fetcher (#2649) 2023-04-28 17:48:34 +02:00
Alexandr Garbuzov a82a617a37 Fixed several typos inside preview theme script (#2650) 2023-04-28 09:51:54 +02:00
Alexandr Garbuzov 6eebfe36e8 Fixed docs typo inside src/common/utils.js (#2651) 2023-04-28 09:51:24 +02:00
Alexandr Garbuzov 30a45d3c13 Fixed typo in word color inside README (#2652) 2023-04-28 09:50:57 +02:00
Rick Staa fd64333211 docs: update give logo (#2605) 2023-04-28 07:30:33 +05:30
Rick Staa f5f0a79bc1 feat: improve CONTRIBUTING.md (#2609) 2023-04-28 07:30:13 +05:30
kitswasandrickstaa 5577bbf07f New top language algorithm implementation (#1732)
* Reduced vercel maxDuration

* Implemented new algorithm for Top Langs

* Revert "Reduced vercel maxDuration"

This reverts commit b0bc626efe12c738cf5005e7f11c7d2a07b6387a.

* Added documentation

* Fixed broken implementation

* Update fetchTopLanguages.test.js

Changed tests

* Now uses the general formula

The parameters p and q can be set by the user.

* Updated tests and added new test

* Added new test

New test for order by repo count.

* Updated documentation

Added explanation and examples for new options.

* Updated documentation

This was overwritten in the merge commit.

* docs: improve docs and fix tests

* Renamed parameters

Renamed `p` and `q` to `size_weight` and `count_weight`, respectively.

* Updated the documentation

Changes introduced in f2516d60a4

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-04-25 08:19:05 +02:00
Alexandr Garbuzov da46a5093c Synchonize cache seconds min value inside docs translations with main readme (#2616) 2023-04-25 08:17:50 +02:00
Alexandr Garbuzov 21a9ba4fae fix path to powered by vercel image (#1792) 2023-04-25 08:17:10 +02:00
Alexandr Garbuzov 8aacec098b dev (#1782) 2023-04-25 08:16:37 +02:00
Alexandr Garbuzov da5f82ff02 removed redundant comparison (#957) 2023-04-25 08:15:16 +02:00
Alexandr Garbuzov be0d96615d Fix typos inside wakatime test name (#2617) 2023-04-24 20:24:41 +02:00
LOKESH SINGH aec73d293e Updated the custom error there was a Typo. (#2618)
"Something went while trying to retrieve the stats data using the GraphQL API." -> "Something went wrong while trying to retrieve the stats data using the GraphQL API."
2023-04-24 20:24:05 +02:00
Fabiano CoutoandRick Staa 879937c11d feat(RankIcon): add rank_icon option (#2628)
* feat(theme): add github_dark_dimmed theme

* feat(theme): change github_dark_dimmed icon color

* contrast ratio adjustment

contrast ratio adjustment on github_dark_dimmed theme

* feat(theme): readme preview

* feat(theme): github themes next to each other

* github themes next to each other

* feat(RankIcon): add rank icon option

* feat(RankIcon): extract rankIcon to icons file

* feat(RankIcon): update readme

* feat(RankIcon): test coverage

* Update readme.md

Co-authored-by: Rick Staa <rick.staa@outlook.com>

---------

Co-authored-by: Rick Staa <rick.staa@outlook.com>
2023-04-24 13:56:14 +00:00
Fabiano Couto 4d1d83d5e5 add github_dark_dimmed theme (#2594)
* feat(theme): add github_dark_dimmed theme

* feat(theme): change github_dark_dimmed icon color

* contrast ratio adjustment

contrast ratio adjustment on github_dark_dimmed theme

* feat(theme): readme preview

* feat(theme): github themes next to each other

* github themes next to each other
2023-04-01 13:22:00 +02:00
Caeden Perelli-HarrisandRick Staa d8244a7fe5 Add format stats option (#2155)
* feat: added `format_stats` option (#2128)

* refactor: change `format_stats` to `short_values` (#2128)

* test: create shorten values test (#2128)

* Update readme.md

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* refactor: rename ``short_values`` to ``number_format``

* Update readme.md

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* Update src/cards/stats-card.js

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* refactor: format codebase

---------

Co-authored-by: Rick Staa <rick.staa@outlook.com>
2023-04-01 10:17:56 +05:30
github-actions[bot]andrickstaa b928f51442 refactor: update languages JSON (#2596)
Co-authored-by: rickstaa <rickstaa@users.noreply.github.com>
2023-03-31 06:40:22 +05:30
Eduardo Zaniboni 32998295b7 update my theme (#2576) 2023-03-14 14:42:29 +05:30
Rick Staa 2bd9d457ac ci: fix theme docs generate bug (#2573) 2023-03-09 15:15:50 +05:30
Etanarvazac RevorixandZohan Subhash c5063b92b6 Added "Shadow" set (Red, Green, Blue, transparent BG) (#2529)
* Added "Shadow" set (Red, Green, Blue, transparent BG)

3 additional themes sticking primarily to flat colors, which the exception of icons and border being slightly darker. All 3 themes also have transparent backgrounds that will show differently per-user via GiHub's own light and dark themes. Transparency should also still provide easy readability for both.

* Test

Just want to see if we can make the themes have a transparent background.

* Shadows moved under Transparent

---------

Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com>
2023-03-08 06:36:04 +05:30
Rick Staa b93aee34d0 ci: improve theme preview action (#2572) 2023-03-06 09:33:06 +05:30
Rick Staa ed18914fa4 ci: fixes theme preview action (#2566) 2023-03-05 15:52:08 +05:30
Rick Staa 1e61f9f3fe fix theme preview (#2564)
* ci: fix theme preview action

* fix: fix some bugs in the 'theme-preveiw' action
2023-03-03 20:27:11 +05:30
Rick Staa 976771080f ci: fix theme preview action (#2563) 2023-03-03 13:37:02 +05:30
Zohan SubhashandRick Staa 7bc8f19a7f Preview action fix (#2561)
* Fix error

* refactor: remove unused code

---------

Co-authored-by: Rick Staa <rick.staa@outlook.com>
2023-03-02 18:21:39 +01:00
Rick Staa 9ec2c8367a refactor: fix code comments and change 'up' rate limit (#2560) 2023-03-02 07:44:43 +05:30
Zohan Subhashandrickstaa a1c3c6accc ci: preview theme workflow fix (#2559)
* Fix octokit error

* ci: make octokit instance global

* Fix preview theme (move declarations to global)

* refactor: make constants uppercase

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-03-01 16:51:25 +01:00
Zohan Subhashandrickstaa 8849b5f5fc Preview theme workflow fix (#2557)
* Fix octokit error

* ci: make octokit instance global

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-03-01 15:03:49 +05:30
github-actions[bot]andrickstaa d60d53cdb4 refactor: update languages JSON (#2554)
Co-authored-by: rickstaa <rickstaa@users.noreply.github.com>
2023-03-01 06:47:56 +05:30
Rick Staa 252c2b419d refactor: format code (#2550) 2023-02-26 08:14:42 +05:30
Rick Staa d5fbfb4345 ci: fix a bug in the theme preview action (#2549) 2023-02-25 19:44:47 +05:30
Rick Staa 82224fa68a ci: update e2e tests (#2548) 2023-02-25 19:42:11 +05:30
Zohan Subhash 1d528da1dc Add option to deploy using other services (#2525)
* Create express.js

* Update readme.md

* Update readme.md
2023-02-25 19:34:00 +05:30
Rehman 2ab8b85ae3 fix: for issue #2534 (#2536) 2023-02-25 14:31:49 +01:00
Rick Staa a3c6f874af test: update snapshots (#2519) 2023-02-25 13:32:08 +01:00
Raphael Gonçalves 8898d013b6 Update readme.md (#2414)
fix: missing "&" in show_icons=true in Showing icons section
2023-02-25 17:32:42 +05:30
Rick Staa 91345ed55f ci: fix unsafe directory bug (#2518)
This commit fixes a bug that was introduced due to a upstream change in
the git package. See https://stackoverflow.com/questions/71849415/i-cannot-add-the-parent-directory-to-safe-directory-in-git/71904131#71904131
for more information.
2023-02-25 17:21:54 +05:30
Zohan Subhash 55a303b4a6 Add auto-labelling for documentation updates (#2526) 2023-02-25 17:20:14 +05:30
Cateline Mnemosyne f3f7a4837d fix: fix JSON themes bug. (#2544)
This fixes a JSON bug that was introduced in https://github.com/anuraghazra/github-readme-stats/pull/2507.
2023-02-25 14:25:12 +05:30
Oleksandr PerlovandZohan Subhash a6ff0fa521 Add one_dark_pro (#2507)
This colors were taken from One Dark Pro theme in VSCode extention. Please add it and I will use it in my profile

Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com>
2023-02-25 12:20:00 +05:30
Mohamed Hassan 5f20e6c97a add holi_theme (#2539)
* add holi_theme

* add holi_theme
2023-02-25 12:19:30 +05:30
AmirandZohan Subhash ba7c2f8b55 Support hide_progress for top-langs feature (#2514)
* Add support for hide_progress in top languages feature

* Fix mistake

* Add documents for all languages

* Remove unnecessary value check

* Update top-languages-card.js

* Revert document for all languages except English

* Update documentation

* Update documentation

---------

Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com>
2023-02-16 06:53:11 +05:30
강민지and강민지 888663a477 Add rose theme (#2480)
Co-authored-by: 강민지 <68285922+Kminzzi@users.noreply.github.com>
2023-02-14 06:20:12 +05:30
Rick Staa 112000667c ci: add update languages action (#2484)
* ci: add update languages action

* ci: make sure PR is created when upstream languages are updated
2023-01-29 15:19:01 +01:00
Anurag Hazra 7aa502d453 chore: minor changes in pat info (#2481) 2023-01-28 20:32:40 +05:30
Rick StaaandAnurag Hazra 077d40561a feat: add PAT monitoring functions (#2178)
* feat: add PAT monitoring functions

This commit adds two monitoring functions that can be used to check
whether the PATs are functioning correctly:
 - status/up: Returns whether the PATs are rate limited.
 - status/pat-info: Returns information about the PATs.

* feat: add shields.io dynamic badge json response

This commit adds the ability to set the return format of the
`/api/status/up` cloud function. When this format is set to `shields` a
dynamic shields.io badge json is returned.

* feat: add 'json' type to up monitor

* feat: cleanup status functions

* ci: decrease pat-info rate limiting time

* feat: decrease monitoring functions rate limits

* refactor: pat code

* feat: add PAT monitoring functions

This commit adds two monitoring functions that can be used to check
whether the PATs are functioning correctly:
 - status/up: Returns whether the PATs are rate limited.
 - status/pat-info: Returns information about the PATs.

* feat: add shields.io dynamic badge json response

This commit adds the ability to set the return format of the
`/api/status/up` cloud function. When this format is set to `shields` a
dynamic shields.io badge json is returned.

* feat: add 'json' type to up monitor

* feat: cleanup status functions

* ci: decrease pat-info rate limiting time

* feat: decrease monitoring functions rate limits

* refactor: pat code

* test: fix pat-info tests

* Update api/status/pat-info.js

Co-authored-by: Anurag Hazra <hazru.anurag@gmail.com>

* test: fix broken tests

* chore: fix suspended account

* chore: simplify and refactor

* chore: fix test

* chore: add resetIn field

---------

Co-authored-by: Anurag <hazru.anurag@gmail.com>
2023-01-28 19:52:02 +05:30
Rick Staa 99d9d3cde0 ci: prevent certain actions from running on forks (#2466) 2023-01-25 09:20:36 +01:00
Rick Staa cd5cbcdb09 fix: fixes card overflow problem #2452 (#2460)
This commit makes sure that the card width is formatted correctly.
2023-01-24 20:10:11 +05:30
b2bf4fa487 fix: change prod deployment branch to vercel branch to fix maxDuration bug (#2424)
* Create deploy-prep.yml

* Create deploy-prep.py

* Update vercel.json

* Update deploy-prep.yml

* Update vercel.json

* Added coauthor

Co-authored-by: Dou Xiaobo <93511091+douxiaobo@users.noreply.github.com>

* Update deploy-prep.yml

* refactor: format code

* Added if condition to disable deployments on forks

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* Update deploy-prep.yml

Co-authored-by: Dou Xiaobo <93511091+douxiaobo@users.noreply.github.com>
Co-authored-by: Anurag Hazra <hazru.anurag@gmail.com>
Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-01-24 20:04:26 +05:30
Anurag 4b17300126 Merge branch 'master' of https://github.com/anuraghazra/github-readme-stats 2023-01-22 00:39:56 +05:30
Anurag Hazraandrickstaa a17fa1cf5d chore: resolve conflict (#2453)
* test: fix e2e tests

* test: update snapshots

* test: fix e2e test data

* test: update e2e test data

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-01-22 00:39:36 +05:30
Anurag 8667ea9908 Merge branch 'master' of https://github.com/anuraghazra/github-readme-stats 2023-01-22 00:36:12 +05:30
60fae292a3 feat: enable multi page star fetching for private vercel instances (#2159)
* feat: enable multi-page stars' fetching for private vercel instances

This commit enables multi-page stars' support from fetching on private Vercel
instances. This feature can be disabled on the public Vercel instance by adding
the `FETCH_SINGLE_PAGE_STARS=true` as an env variable in the public Vercel
instance. This variable will not be present when people deploy their own Vercel
instance, causing the code to fetch multiple star pages.

* fix: improve stats multi-page fetching behavoir

This commit makes sure that the GraphQL api is only called one time per
100 repositories. The old method added one unnecesairy GraphQL call.

* docs: update documentation

* style: improve code syntax

Co-authored-by: Matteo Pierro <pierromatteo@gmail.com>

* lol happy new year

* docs: remove rate limit documentation for now

Remove the `FETCH_SINGLE_PAGE_STARS` from documentation for now since it
might confuse people.

* fix: fix error in automatic merge

* feat: make sure  env variable is read

Co-authored-by: Matteo Pierro <pierromatteo@gmail.com>
Co-authored-by: Anurag <hazru.anurag@gmail.com>
2023-01-21 18:32:37 +01:00
rickstaa c1dc7b850c fix: fix e2e test data 2023-01-21 17:58:35 +01:00
rickstaa 4ff2c2a425 feat: fix e2e tests 2023-01-21 17:52:51 +01:00
rickstaa fbb49e3c80 test: update e2e test data 2023-01-21 12:15:58 +01:00
rickstaa eab1402417 test: fix e2e test data 2023-01-21 11:37:41 +01:00
rickstaa cfa84232e2 test: update snapshots 2023-01-21 11:32:25 +01:00
rickstaa d5d1f44e1c test: fix e2e tests 2023-01-21 11:31:42 +01:00
Zohan Subhash 8bc69e761f Update readme.md (#2442) 2023-01-19 09:30:46 +01:00
Rick Staa 06a2a78cfc Revert "Revert "Add loading Animation to Most used Language card (#2197)" (#2396)" (#2419)
This reverts commit 4b8198fa21.
2023-01-16 12:30:39 +01:00
Rick Staa ad9db67b4c refactor: update code formatting 2023-01-16 12:28:31 +01:00
Rick Staa ab9c563ec5 Revert "Revert "ci: fix theme readme generation action (#2271)" (#2394)" (#2418)
This reverts commit 70f0264905.
2023-01-16 12:21:13 +01:00
Anurag Hazra 0ff426d258 fix: retryer fixed (#2400) 2023-01-13 13:16:33 +05:30
Rick Staa 4b8198fa21 Revert "Add loading Animation to Most used Language card (#2197)" (#2396)
This reverts commit 77dcdab42c.
2023-01-12 22:52:34 +01:00
Rick Staa 70f0264905 Revert "ci: fix theme readme generation action (#2271)" (#2394)
This reverts commit 5ae959b57c.
2023-01-12 22:48:28 +01:00
Rick Staa 0850a97630 Revert "build(deps): bump json5 from 2.2.1 to 2.2.3 (#2373)" (#2393)
This reverts commit 42fdff624f.
2023-01-12 22:44:27 +01:00
Rick Staa 5ae959b57c ci: fix theme readme generation action (#2271) 2023-01-10 12:25:06 +00:00
Huzaifa Khilawalaandrickstaa 77dcdab42c Add loading Animation to Most used Language card (#2197)
* add: text animation

* compact progress done

* cleaned code

* non compact animation done

* tests fixed + prettier

* revert: vercel.json

* remove: unnecessary import

* added parameter in docs

* style: improve syntax

Co-authored-by: rickstaa <rick.staa@outlook.com>
2023-01-10 12:21:35 +00:00
rickstaa 227711c628 test: update snapshots 2023-01-10 10:08:33 +00:00
dependabot[bot]anddependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 42fdff624f build(deps): bump json5 from 2.2.1 to 2.2.3 (#2373)
Bumps [json5](https://github.com/json5/json5) from 2.2.1 to 2.2.3.
- [Release notes](https://github.com/json5/json5/releases)
- [Changelog](https://github.com/json5/json5/blob/main/CHANGELOG.md)
- [Commits](https://github.com/json5/json5/compare/v2.2.1...v2.2.3)

---
updated-dependencies:
- dependency-name: json5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-01-09 15:42:45 +01:00
Rick Staa 9eb0c3cbb4 feat: fix 'include_all_commits' inner card margin (#2283) 2022-11-22 09:46:41 +01:00
Rick Staa ad3726ee49 fix: fix repoContrib confusion (#2269) (#2274)
This commit prevents confusion about the Contributed to stat. Currently,
only the last year's results are shown, but it looks like it is the
all-time contribution count (see #2269). This commit adds a ' (last year)'
suffix to prevent this confusion from happening.
2022-11-22 09:18:22 +01:00
Rick Staa 0efb982c2a Revert "feat: add INCLUDE_ORGS env variable (#2275)" (#2276)
This reverts commit ada9cf4e0e.
2022-11-21 11:15:32 +01:00
Rick Staa ada9cf4e0e feat: add INCLUDE_ORGS env variable (#2275)
This commit adds an INCLUDE_ORGS ENV variable that can be used to include results from
organizations into the GRS cards for self-deployed Vercel instances.

**Warning**
This is a hidden feature since we can not officially support this on the Public
Vercel instance due to GraphQL and Vercel rate/timeout limits. You can set this env
variable via Vercel's ENV variable menu (see
https://vercel.com/docs/concepts/projects/environment-variables).
2022-11-21 11:08:05 +01:00
Rick Staa 3cb205c65b feat: improve card loading speed (#2124)
* feat: improve card loading times

This commit adds the `stale-while-revalidate` option to speed up the
card loading times.

* mend
2022-11-21 10:21:46 +01:00
Rick Staa f07cd133d3 fix: fix retry max-out bug (#2121)
* fix: fix retry max-out bug

This commit makes sure that the retry function tests all PATs.

* style: format code

* test: fix retry tests

* style: format code
2022-11-21 10:15:43 +01:00
Rick Staa 42a4b6f60a refactor: remove unused dotenv calls (#2059)
As explained in the Vercel documentation vercel ignores dot files (see
https://github.com/vercel/vercel/discussions/3962#discussioncomment-4277). It
instead loads the env variables defined in the vercel instance. As a
result we can therefore remove dotenv.
2022-11-21 10:13:14 +01:00
Rick Staa 5df25a6472 fix: improve boolean parse behaviour (#2029) 2022-11-21 10:10:46 +01:00
Rick Staa 4b656ebabb refactor: migrate to using arrow functions (#2033) 2022-11-21 10:07:09 +01:00
rickstaa b2e34ac8db test: update snapshots 2022-11-20 08:39:44 +01:00
Bradley Jester 0e02523459 feat: added Date Night theme to index.js (#2264)
* Added Date Night theme to index.js

* My theme name should be in snake_case now
2022-11-19 22:44:42 +01:00
Pranav Joglekarandrickstaa 9aa39dfe81 feat: allow users to pass ring_color param (#2075)
* fix: prevent crash if undefined color is passed to func fallbackColor

* feat: allow users to pass ring_color param

Before this commit, the ring color was always equal to the title color.
This commit allows the user to pass a ring_color property to allow him
to style the ring color the way he pleases to. If no ring_color is
passed we default to the title color.

* docs: improves ring color documentation

* fix: improve code style

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-11-19 20:18:42 +01:00
Ítalo Sousa 0c829e9488 Updates the brazilian readme (#2245) 2022-11-18 15:49:38 +01:00
Fabian Joswigandrickstaa 26cde6bfe9 Missing term in calculation of TOTAL_VALUES. (#2116)
* fix: added missing term in calculation of TOTAL_VALUES.

* fix: fix rank test

* refactor: update code formatting

* refactor: update code formatting

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-11-18 15:19:04 +01:00
Rick Staa 1a4e5a6955 ci: update theme stale close message 2022-11-18 11:06:24 +01:00
Rick Staa 56aa307094 ci: update theme stale close message 2022-11-18 11:05:10 +01:00
Tymoteusz Marzec f9e95b166d Corrections of Polish expressions in translations.js (#2240) 2022-10-29 15:41:04 +02:00
Ray Chan c0d7493c3f Fix truncation of compact wakatime progress bar when langs_count is set (#2228)
* refactor: use default value for languages

* fix: truncated compact progress bar

* test: add test for truncated compact progress bar with langs_count set
2022-10-28 20:47:09 +02:00
Rick Staa f993f21379 Update readme.md 2022-10-28 10:03:11 +02:00
Falguni Sarkarandrickstaa 45f434f083 docs: document auto theme change #2074 (#2229)
* Document auto theme change in README #2074

* Document auto theme change in README

Document auto theme change in README #2074 (update-1)

* Document auto theme change updates

#2074

* docs: improve dynamic theme documentation

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-28 09:43:17 +02:00
Frieder Bluemle 199870aa9f refactor: fix GitHub capitalization (#2232) 2022-10-26 16:41:59 +02:00
Rick Staa 8e3147014c refactor: make issue templates required (#2226) 2022-10-24 14:18:37 +02:00
Rick Staa 98f9045f98 fix: improve error caching behavoir (#2211)
This commit ensures that the GraphQL Pat error is not cached in any
browser. See
https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1282630614.
2022-10-18 18:07:38 +02:00
Rick Staa dcc4ccd18c ci: increase invalid theme close time (#2210)
This commits increases the theme invalid close time to 20 days.
2022-10-18 17:15:25 +02:00
Rick Staa 1d10912646 ci: fix stale closer action review sort bug (#2201)
This commit makes sure the PR staleness is checked by the latest review that
is done.
2022-10-16 12:18:21 +02:00
Kurt bb56e3bb7b fix: text overlapped on zh-tw locale (#2192) 2022-10-15 08:19:33 +02:00
Rick Staa 54cc291978 Revert "fix: improve json import (#2190)" (#2191)
This reverts commit 65424fa90f.
2022-10-13 11:55:01 +02:00
Rick Staa 65424fa90f fix: improve json import (#2190) 2022-10-13 11:26:13 +02:00
rickstaa f7a2b2162b fix: fix I18n import error 2022-10-13 10:50:32 +02:00
Rick Staa dea583d426 build: create npm package (#2151)
* build: create npm package

This commit makes sure that the common modules of the GRS package can be
imported as an npm package.

* feat: export card render functions

* style: update formatting
2022-10-13 10:27:19 +02:00
Rick Staa 6fdf73f39c test: increase e2e test timeout 2022-10-11 18:10:44 +02:00
Rick Staa 8dd70924da refactor: improve issues template formatting 2022-10-11 18:07:36 +02:00
Rick Staa 32b8daa71d refactor: improve issues template (#2180) 2022-10-11 18:02:29 +02:00
Rick Staa 7eb85d3b31 refactor: add extra links to issues template 2022-10-11 18:00:05 +02:00
rickstaa 166972d7e4 docs: improve syntax 2022-10-10 13:49:48 +02:00
rickstaa c4bfacb9e0 docs: add fork update guide 2022-10-10 13:48:35 +02:00
rickstaa f0f92c2635 test: add cache on error test 2022-10-10 12:48:26 +02:00
Rick Staa 4df8094e52 fix: prevent errors from being cached (#2160) 2022-10-09 20:23:31 +02:00
rickstaa 0a394a625b ci: add issues template config and remove question template 2022-10-09 17:46:11 +02:00
rickstaa f77e34e383 ci: add question template 2022-10-09 17:31:24 +02:00
rickstaa fcd0588786 test: cleanup tests 2022-10-09 15:18:11 +02:00
rickstaa 60012707c7 test: increase stats card e2e timeout 2022-10-08 15:04:49 +02:00
Rick Staa bd9865d5a2 test: burst cache in e2e tests (#2154) 2022-10-07 20:01:01 +02:00
rickstaa 39535db38c style: update formatting 2022-10-07 19:46:05 +02:00
rickstaa 80e8233c53 style: improve templates formatting 2022-10-07 19:25:36 +02:00
Brian Choromanskiandrickstaa 06e3e052df ci: updated issue template (#2127)
* Updated issue templates

* style: improve template formatting

* style: update formatting

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-07 19:20:57 +02:00
rickstaa 36a8c392d0 fix: improve graphql error handling 2022-10-07 17:40:26 +02:00
Shivam Kotakandrickstaa 343058cc15 fix: adding doc strings to files in src folder where it was missing (#2129)
* fix: adding doc strings to files in src folder where it was missing

* refactor: add docstrings

* style: run formatter

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-07 16:22:02 +02:00
rickstaa d7451d8288 docs: improve caching documentation 2022-10-07 14:53:51 +02:00
rickstaa 5c514dbda0 docs: improve admonition boxes 2022-10-07 14:43:16 +02:00
rickstaa 15533596e6 docs: add admonition boxes 2022-10-07 14:40:19 +02:00
rickstaa df243efdd5 docs: update readme 2022-10-07 14:32:01 +02:00
rickstaa 15620a11db test: fix tests 2022-10-07 12:42:04 +02:00
Taehyun Hwangandrickstaa e8dfbde7bb Add format script to pre-commit hook (#2146)
* Add format script to pre-commit hook

* build: add husky prepare step

* build: add lint-staged

* build: add lint-staged

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-07 12:33:54 +02:00
rickstaa bcb8ae9281 style: improve small syntax error 2022-10-07 11:13:01 +02:00
rickstaa 04595dfe62 style: improve formatting 2022-10-07 11:10:48 +02:00
rickstaa cea4a39548 ci: improve theme preview action
This commit makes sure that theme PRs that contain invalid JSON are
labeled `invalid` and changes are requested.
2022-10-07 11:09:34 +02:00
rickstaa aae83cb22e fix: temporary disable multi page star fetch 2022-10-05 00:47:14 +02:00
Rick Staa 94d0978d2b docs: fix readme logo alignment (#2112) 2022-10-04 14:19:30 +02:00
Matteo Pierroandrickstaa af97e5765b fix: fetch all repos for for the stats card (#2100)
* fetch all stars

* stop fetching when there are repos with zero stars

* remove not needed parameters from the query

* add docstring

* removed not needed mock

* style: update formatting

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-04 13:10:50 +02:00
nekiwoandrickstaa acbc03dc0f Fix card length during error (#2105)
* Fix card length during error

Fixes #1774
The size of the box should be 550px to allow 25px padding from both sides
I found the width of the text using `getComputedTextLength()` method

* fix: improve error card size

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-04 10:00:48 +02:00
Akshat Goelandrickstaa 388ba06a8f Update the Vercel deployement guide (#2102)
* Update the Vercel deployement guide

Updated Readme.md - The guide on deploying your own Vercel instance

* docs: fix some small grammer errors

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-04 09:32:40 +02:00
Rick Staa e6a6384eff docs: improve readme syntax (#2106) 2022-10-04 09:19:37 +02:00
Aditya Shelkeandrickstaa 7accd1a8d7 feat: default values for wakatime and language (#2103)
* default values for wakatime and language

* docs: update formatting

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-04 08:58:18 +02:00
c03bb2f250 fix: adding docstrings to the files where it was missing (#2101)
* fix: adding docstrings to missing files

* style: format code

* style: improve formatting

Co-authored-by: Jagruti Tiwari <jagrutit@cdac.in>
Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-03 13:03:23 +02:00
Ayushi Vishwakarmaandrickstaa 9e1fc0b7da update default values in readme (#2094)
* update default values in readme

* docs: improve formatting

* docs: improve readme punctation

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-03 09:14:37 +02:00
Manan1612 aa084f31c4 Added Contributors Badge (#2096) 2022-10-03 08:42:32 +02:00
rickstaa c5bea57638 docs: fix india care logo 2022-10-02 18:07:43 +02:00
rickstaa c2c984a872 docs: format readme 2022-10-02 17:58:34 +02:00
ianbromwichuos 2faf9c54ff docs: fix link to go India logo svg (#2085) 2022-10-02 17:47:14 +02:00
91 changed files with 7816 additions and 3114 deletions
-43
View File
@@ -1,43 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: ""
assignees: ""
---
<!--PLEASE FIRST READ THE FAQ (#1770) AND COMMON ERROR CODES (#1772)!!!-->
**Describe the bug**
A clear and concise description of what the bug is.
**Expected behaviour**
A clear and concise description of what you expected to happen.
**Screenshots / Live demo link (paste the github-readme-stats link as markdown image)**
If applicable, add screenshots to help explain your problem.
**Additional context**
Add any other context about the problem here.
<!-- FAQ
Below are some questions that are found in the FAQ. The full FAQ can be found in #1770.
Q: My card displays an error
Ans: First, check the common error codes (i.e. https://github.com/anuraghazra/github-readme-stats/issues/1772) and existing issues before creating a new one.
Q: How to hide jupyter Notebook?
Ans: &hide=jupyter%20notebook
Q: I could not figure out how to deploy on my own vercel instance
Ans:
- docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance
- YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107
Q: Language Card is incorrect
Ans: Please read all the issues/comments before opening any issues regarding language card stats:
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181
Q: How to count private stats?
Ans: We can only count private commits & we cannot access any other private info of any users, so it's impossible. The only way is to deploy on your own instance & use your own PAT (Personal Access Token)
-->
+60
View File
@@ -0,0 +1,60 @@
name: Bug report
description: Create a report to help us improve.
labels:
- "bug"
body:
- type: markdown
attributes:
value: |
:warning: PLEASE FIRST READ THE FAQ [(#1770)](https://github.com/anuraghazra/github-readme-stats/discussions/1770) AND COMMON ERROR CODES [(#1772)](https://github.com/anuraghazra/github-readme-stats/issues/1772)!!!
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description:
A clear and concise description of what you expected to happen.
- type: textarea
attributes:
label: Screenshots / Live demo link
description: If applicable, add screenshots to help explain your problem.
placeholder: Paste the github-readme-stats link as markdown image
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
- type: markdown
attributes:
value: |
---
### FAQ (Snippet)
Below are some questions that are found in the FAQ. The full FAQ can be found in [#1770](https://github.com/anuraghazra/github-readme-stats/discussions/1770).
#### Q: My card displays an error
**Ans:** First, check the common error codes (i.e. https://github.com/anuraghazra/github-readme-stats/issues/1772) and existing issues before creating a new one.
#### Q: How to hide jupyter Notebook?
**Ans:** `&hide=jupyter%20notebook`.
#### Q: I could not figure out how to deploy on my own vercel instance
**Ans:** Please check:
- Docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance
- YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107
#### Q: Language Card is incorrect
**Ans:** Please read these issues/comments before opening any issues regarding language card stats:
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181
#### Q: How to count private stats?
**Ans:** We can only count private commits & we cannot access any other private info of any users, so it's impossible. The only way is to deploy on your own instance & use your own PAT (Personal Access Token).
+12
View File
@@ -0,0 +1,12 @@
blank_issues_enabled: true
contact_links:
- name: Question
url: https://github.com/anuraghazra/github-readme-stats/discussions
about: Please ask and answer questions here.
- name: Error
url: https://github.com/anuraghazra/github-readme-stats/issues/1772
about:
Before opening a bug report, please check the 'Common Error Codes' issue.
- name: FAQ
url: https://github.com/anuraghazra/github-readme-stats/discussions/1770
about: Please first check the FAQ before asking a question.
-41
View File
@@ -1,41 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: ""
assignees: ""
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
<!--
PLEASE READ THE FAQs!!!
Q: How to hide jupyter Notebook?
Ans: &hide=jupyter%20notebook
Q: I could not figure out how to deploy on my own vercel instance
Ans:
- docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance
- YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107
Q: Language Card is incorrect
Ans: Please read all the issues / comments before opening any issues regarding language card stats:
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181
Q: How to count private stats?
Ans: We can only count private commits & we cannot access any other private info of any users, so it's not possible. only way is to deploy on your own instance & use your own PAT (Personal Access Token)
-->
@@ -0,0 +1,28 @@
name: Feature request
description: Suggest an idea for this project.
labels:
- "enhancement"
body:
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description:
A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
- type: textarea
attributes:
label: Describe alternatives you've considered
description:
A clear and concise description of any alternative solutions or features
you've considered.
- type: textarea
attributes:
label: Additional context
description:
Add any other context or screenshots about the feature request here.
+30 -1
View File
@@ -1,3 +1,32 @@
themes: themes/index.js themes: themes/index.js
doc-translation: docs/* doc-translation: docs/*
card-i18n: src/translations.js card-i18n:
- src/translations.js
- src/common/I18n.js
documentation:
- readme.md
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
dependencies:
- package.json
- package-lock.json
lang-card:
- api/top-langs.js
- src/cards/top-languages-card.js
- src/fetchers/top-languages-fetcher.js
repo-card:
- api/pin.js
- src/cards/repo-card.js
- src/fetchers/repo-fetcher.js
stats-card:
- api/index.js
- src/cards/stats-card.js
- src/fetchers/stats-fetcher.js
wakatime-card:
- api/wakatime.js
- src/cards/wakatime-card.js
- src/fetchers/wakatime-fetcher.js
ranks: src/calculateRank.js
ci:
- .github/workflows/*
- scripts/*
+10
View File
@@ -0,0 +1,10 @@
import os
file = open('./vercel.json', 'r')
str = file.read()
file = open('./vercel.json', 'w')
str = str.replace('"maxDuration": 10', '"maxDuration": 30')
file.write(str)
file.close()
+20
View File
@@ -0,0 +1,20 @@
name: Deployment Prep
on:
workflow_dispatch:
push:
branches:
- master
jobs:
config:
if: github.repository == 'anuraghazra/github-readme-stats'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Deployment Prep
run: python ./.github/workflows/deploy-prep.py
- uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: vercel
create_branch: true
push_options: "--force"
+2 -1
View File
@@ -5,13 +5,14 @@ on:
jobs: jobs:
e2eTests: e2eTests:
if: if:
github.repository == 'anuraghazra/github-readme-stats' &&
github.event_name == 'deployment_status' && github.event_name == 'deployment_status' &&
github.event.deployment_status.state == 'success' github.event.deployment_status.state == 'success'
name: Perform 2e2 tests name: Perform 2e2 tests
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
node-version: [16.x] node-version: [18.x]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
@@ -8,6 +8,7 @@ on:
jobs: jobs:
closeEmptyIssuesAndTemplates: closeEmptyIssuesAndTemplates:
if: github.repository == 'anuraghazra/github-readme-stats'
name: Close empty issues name: Close empty issues
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
+5 -1
View File
@@ -12,7 +12,7 @@ jobs:
name: Generate theme doc name: Generate theme doc
strategy: strategy:
matrix: matrix:
node-version: [16.x] node-version: [18.x]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
@@ -23,6 +23,10 @@ jobs:
node-version: ${{ matrix.node-version }} node-version: ${{ matrix.node-version }}
cache: npm cache: npm
# Fix the unsafe repo error which was introduced by the CVE-2022-24765 git patches.
- name: Fix unsafe repo error
run: git config --global --add safe.directory ${{ github.workspace }}
- name: npm install, generate readme - name: npm install, generate readme
run: | run: |
npm ci npm ci
+1
View File
@@ -4,6 +4,7 @@ on:
jobs: jobs:
triage: triage:
if: github.repository == 'anuraghazra/github-readme-stats'
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/labeler@v4 - uses: actions/labeler@v4
+1 -1
View File
@@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
node-version: [16.x] node-version: [18.x]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
+33
View File
@@ -0,0 +1,33 @@
name: prs cache clean
on:
pull_request:
types:
- closed
jobs:
cleanup:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Cleanup
run: |
gh extension install actions/gh-actions-cache
REPO=${{ github.repository }}
BRANCH="refs/pull/${{ github.event.pull_request.number }}/merge"
echo "Fetching list of cache key"
cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
## Setting this to not fail the workflow while deleting cache keys.
set +e
echo "Deleting caches..."
for cacheKey in $cacheKeysForPR
do
gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
done
echo "Done"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+3 -2
View File
@@ -5,11 +5,12 @@ on:
jobs: jobs:
closeOldThemePrs: closeOldThemePrs:
if: github.repository == 'anuraghazra/github-readme-stats'
name: Close stale 'invalid' theme PRs name: Close stale 'invalid' theme PRs
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
node-version: [16.x] node-version: [18.x]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
@@ -26,5 +27,5 @@ jobs:
- run: npm run close-stale-theme-prs - run: npm run close-stale-theme-prs
env: env:
STALE_DAYS: 15 STALE_DAYS: 20
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+2 -2
View File
@@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
node-version: [16.x] node-version: [18.x]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
@@ -34,4 +34,4 @@ jobs:
npm run format:check npm run format:check
- name: Code Coverage - name: Code Coverage
uses: codecov/codecov-action@v1 uses: codecov/codecov-action@v3
+8 -1
View File
@@ -2,9 +2,11 @@ name: Update top issues dashboard
on: on:
schedule: schedule:
- cron: "0 0 */3 * *" - cron: "0 0 */3 * *"
workflow_dispatch:
jobs: jobs:
showAndLabelTopIssues: showAndLabelTopIssues:
if: github.repository == 'anuraghazra/github-readme-stats'
name: Update top issues Dashboard. name: Update top issues Dashboard.
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
@@ -13,11 +15,16 @@ jobs:
env: env:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
with: with:
top_list_size: 10
filter: "1772" filter: "1772"
label: false label: true
dashboard: true dashboard: true
dashboard_show_total_reactions: true dashboard_show_total_reactions: true
top_issues: true top_issues: true
top_bugs: true top_bugs: true
top_features: true top_features: true
top_pull_requests: true top_pull_requests: true
custom_pull_requests_label: themes
top_custom_pull_requests_label: ":star: top themes"
top_custom_pull_requests_label_description: Top themes
top_custom_pull_requests_label_colour: "#A23599"
+44
View File
@@ -0,0 +1,44 @@
name: Update supported languages
on:
schedule:
- cron: "0 0 */30 * *"
jobs:
updateLanguages:
if: github.repository == 'anuraghazra/github-readme-stats'
name: Update supported languages
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
steps:
- uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: npm
- name: Install dependencies
run: npm ci
env:
CI: true
- name: Run update-languages-json.js script
run: npm run generate-langs-json
- name: Create Pull Request if upstream language file is changed
uses: peter-evans/create-pull-request@v4
with:
commit-message: "refactor: update languages JSON"
branch: "update_langs/patch"
delete-branch: true
title: Update languages JSON
body:
"The
[update-langs](https://github.com/anuraghazra/github-readme-stats/actions/workflows/update-langs.yaml)
action found new/updated languages in the [upstream languages JSON
file](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml)."
labels: "ci, lang-card"
+5 -2
View File
@@ -2,11 +2,14 @@
.env .env
node_modules node_modules
*.lock *.lock
.vscode/
.idea/ .idea/
coverage coverage
vercel_token vercel_token
# IDE # IDE
.vscode .vscode/*
!.vscode/extensions.json
!.vscode/settings.json
*.code-workspace *.code-workspace
.vercel
+1
View File
@@ -0,0 +1 @@
_
+5
View File
@@ -0,0 +1,5 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npm test
npx lint-staged
+1
View File
@@ -0,0 +1 @@
18
+6
View File
@@ -0,0 +1,6 @@
{
"recommendations": [
"yzhang.markdown-all-in-one",
"esbenp.prettier-vscode"
]
}
+5
View File
@@ -0,0 +1,5 @@
{
"markdown.extension.toc.levels": "1..3",
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
+16 -10
View File
@@ -2,11 +2,11 @@
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting an issue - Reporting [an issue](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=bug&template=bug_report.yml).
- Discussing the current state of the code - [Discussing](https://github.com/anuraghazra/github-readme-stats/discussions) the current state of the code.
- Submitting a fix - Submitting [a fix](https://github.com/anuraghazra/github-readme-stats/compare).
- Proposing new features - Proposing [new features](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=enhancement&template=feature_request.yml).
- Becoming a maintainer - Becoming a maintainer.
## All Changes Happen Through Pull Requests ## All Changes Happen Through Pull Requests
@@ -33,11 +33,15 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
1. Install [Vercel CLI](https://vercel.com/download). 1. Install [Vercel CLI](https://vercel.com/download).
2. Fork the repository and clone the code to your local machine. 2. Fork the repository and clone the code to your local machine.
3. Run `npm install` in the repository root. 3. Run `npm install` in the repository root.
4. Run the command "vercel" in the root and follow the steps there. 4. Run the command `vercel` in the root and follow the steps there.
5. Open `vercel.json` and set the maxDuration to 10. 5. Open `vercel.json` and set the maxDuration to 10.
6. Create a `.env` file in the root of the directory. 6. Create a `.env` file in the root of the directory.
7. In the .env file add a new variable named "PAT_1" with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). 7. In the .env file add a new variable named `PAT_1` with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
8. Run the command "vercel dev" to start a development server at <https://localhost:3000>. 8. Run the command `vercel dev` to start a development server at <https://localhost:3000>.
9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
> **Note**
> You can debug the package code in [Vscode](https://code.visualstudio.com/) by using the [Node.js: Attach to process](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_setting-up-an-attach-configuration) debug option. You can also debug any tests using the [VSCode Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest). For more information, see https://github.com/jest-community/vscode-jest/issues/912.
## Themes Contribution ## Themes Contribution
@@ -45,9 +49,11 @@ GitHub Readme Stats supports custom theming, and you can also contribute new the
All you need to do is edit the [themes/index.js](./themes/index.js) file and add your theme at the end of the file. All you need to do is edit the [themes/index.js](./themes/index.js) file and add your theme at the end of the file.
While creating the Pull request to add a new theme **don't forget to add a screenshot of how your theme looks**, you can also test how it looks using custom URL parameters like `title_color`, `icon_color`, `bg_color`, `text_color`, `border_color` > **Note**
> If you are contributing your theme just because you are using it personally, then you can [customize the looks](./readme.md#customization) of your card with URL params instead.
> NOTE: If you are contributing your theme just because you are using it personally, then you can [customize the looks](./readme.md#customization) of your card with URL params instead. > **Note**
> Keep in mind that we already have a vast collection of different themes. To keep their number manageable, we began to add only themes supported by the community. Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935#top-themes-prs)). Remember that you can also support themes of other contributors that you liked to speed up their merge.
## Any contributions you make will be under the MIT Software License ## Any contributions you make will be under the MIT Software License
+19 -7
View File
@@ -1,4 +1,3 @@
import * as dotenv from "dotenv";
import { renderStatsCard } from "../src/cards/stats-card.js"; import { renderStatsCard } from "../src/cards/stats-card.js";
import { blacklist } from "../src/common/blacklist.js"; import { blacklist } from "../src/common/blacklist.js";
import { import {
@@ -11,8 +10,6 @@ import {
import { fetchStats } from "../src/fetchers/stats-fetcher.js"; import { fetchStats } from "../src/fetchers/stats-fetcher.js";
import { isLocaleAvailable } from "../src/translations.js"; import { isLocaleAvailable } from "../src/translations.js";
dotenv.config();
export default async (req, res) => { export default async (req, res) => {
const { const {
username, username,
@@ -22,10 +19,10 @@ export default async (req, res) => {
card_width, card_width,
hide_rank, hide_rank,
show_icons, show_icons,
count_private,
include_all_commits, include_all_commits,
line_height, line_height,
title_color, title_color,
ring_color,
icon_color, icon_color,
text_color, text_color,
text_bold, text_bold,
@@ -37,7 +34,10 @@ export default async (req, res) => {
locale, locale,
disable_animations, disable_animations,
border_radius, border_radius,
number_format,
border_color, border_color,
rank_icon,
show,
} = req.query; } = req.query;
res.setHeader("Content-Type", "image/svg+xml"); res.setHeader("Content-Type", "image/svg+xml");
@@ -52,18 +52,25 @@ export default async (req, res) => {
try { try {
const stats = await fetchStats( const stats = await fetchStats(
username, username,
parseBoolean(count_private),
parseBoolean(include_all_commits), parseBoolean(include_all_commits),
parseArray(exclude_repo), parseArray(exclude_repo),
); );
const cacheSeconds = clampValue( let cacheSeconds = clampValue(
parseInt(cache_seconds || CONSTANTS.FOUR_HOURS, 10), parseInt(cache_seconds || CONSTANTS.FOUR_HOURS, 10),
CONSTANTS.FOUR_HOURS, CONSTANTS.FOUR_HOURS,
CONSTANTS.ONE_DAY, CONSTANTS.ONE_DAY,
); );
cacheSeconds = process.env.CACHE_SECONDS
? parseInt(process.env.CACHE_SECONDS, 10) || cacheSeconds
: cacheSeconds;
res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); res.setHeader(
"Cache-Control",
`max-age=${
cacheSeconds / 2
}, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
);
return res.send( return res.send(
renderStatsCard(stats, { renderStatsCard(stats, {
@@ -76,6 +83,7 @@ export default async (req, res) => {
include_all_commits: parseBoolean(include_all_commits), include_all_commits: parseBoolean(include_all_commits),
line_height, line_height,
title_color, title_color,
ring_color,
icon_color, icon_color,
text_color, text_color,
text_bold: parseBoolean(text_bold), text_bold: parseBoolean(text_bold),
@@ -84,11 +92,15 @@ export default async (req, res) => {
custom_title, custom_title,
border_radius, border_radius,
border_color, border_color,
number_format,
locale: locale ? locale.toLowerCase() : null, locale: locale ? locale.toLowerCase() : null,
disable_animations: parseBoolean(disable_animations), disable_animations: parseBoolean(disable_animations),
rank_icon,
show: parseArray(show),
}), }),
); );
} catch (err) { } catch (err) {
res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
return res.send(renderError(err.message, err.secondaryMessage)); return res.send(renderError(err.message, err.secondaryMessage));
} }
}; };
+10 -1
View File
@@ -44,6 +44,9 @@ export default async (req, res) => {
CONSTANTS.FOUR_HOURS, CONSTANTS.FOUR_HOURS,
CONSTANTS.ONE_DAY, CONSTANTS.ONE_DAY,
); );
cacheSeconds = process.env.CACHE_SECONDS
? parseInt(process.env.CACHE_SECONDS, 10) || cacheSeconds
: cacheSeconds;
/* /*
if star count & fork count is over 1k then we are kFormating the text if star count & fork count is over 1k then we are kFormating the text
@@ -58,7 +61,12 @@ export default async (req, res) => {
cacheSeconds = CONSTANTS.FOUR_HOURS; cacheSeconds = CONSTANTS.FOUR_HOURS;
} }
res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); res.setHeader(
"Cache-Control",
`max-age=${
cacheSeconds / 2
}, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
);
return res.send( return res.send(
renderRepoCard(repoData, { renderRepoCard(repoData, {
@@ -75,6 +83,7 @@ export default async (req, res) => {
}), }),
); );
} catch (err) { } catch (err) {
res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
return res.send(renderError(err.message, err.secondaryMessage)); return res.send(renderError(err.message, err.secondaryMessage));
} }
}; };
+139
View File
@@ -0,0 +1,139 @@
/**
* @file Contains a simple cloud function that can be used to check which PATs are no
* longer working. It returns a list of valid PATs, expired PATs and PATs with errors.
*
* @description This function is currently rate limited to 1 request per 5 minutes.
*/
import { logger, request, dateDiff } from "../../src/common/utils.js";
export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 5 minutes
/**
* Simple uptime check fetcher for the PATs.
*
* @param {import('axios').AxiosRequestHeaders} variables
* @param {string} token
*/
const uptimeFetcher = (variables, token) => {
return request(
{
query: `
query {
rateLimit {
remaining
resetAt
},
}`,
variables,
},
{
Authorization: `bearer ${token}`,
},
);
};
const getAllPATs = () => {
return Object.keys(process.env).filter((key) => /PAT_\d*$/.exec(key));
};
/**
* Check whether any of the PATs is expired.
*/
const getPATInfo = async (fetcher, variables) => {
const details = {};
const PATs = getAllPATs();
for (const pat of PATs) {
try {
const response = await fetcher(variables, process.env[pat]);
const errors = response.data.errors;
const hasErrors = Boolean(errors);
const errorType = errors?.[0]?.type;
const isRateLimited =
(hasErrors && errorType === "RATE_LIMITED") ||
response.data.data?.rateLimit?.remaining === 0;
// Store PATs with errors.
if (hasErrors && errorType !== "RATE_LIMITED") {
details[pat] = {
status: "error",
error: {
type: errors[0].type,
message: errors[0].message,
},
};
continue;
} else if (isRateLimited) {
const date1 = new Date();
const date2 = new Date(response.data?.data?.rateLimit?.resetAt);
details[pat] = {
status: "exhausted",
remaining: 0,
resetIn: dateDiff(date2, date1) + " minutes",
};
} else {
details[pat] = {
status: "valid",
remaining: response.data.data.rateLimit.remaining,
};
}
} catch (err) {
// Store the PAT if it is expired.
const errorMessage = err.response?.data?.message?.toLowerCase();
if (errorMessage === "bad credentials") {
details[pat] = {
status: "expired",
};
} else if (errorMessage === "sorry. your account was suspended.") {
details[pat] = {
status: "suspended",
};
} else {
throw err;
}
}
}
const filterPATsByStatus = (status) => {
return Object.keys(details).filter((pat) => details[pat].status === status);
};
const sortedDetails = Object.keys(details)
.sort()
.reduce((obj, key) => {
obj[key] = details[key];
return obj;
}, {});
return {
validPATs: filterPATsByStatus("valid"),
expiredPATs: filterPATsByStatus("expired"),
exhaustedPATs: filterPATsByStatus("exhausted"),
suspendedPATs: filterPATsByStatus("suspended"),
errorPATs: filterPATsByStatus("error"),
details: sortedDetails,
};
};
/**
* Cloud function that returns information about the used PATs.
*/
export default async (_, res) => {
res.setHeader("Content-Type", "application/json");
try {
// Add header to prevent abuse.
const PATsInfo = await getPATInfo(uptimeFetcher, {});
if (PATsInfo) {
res.setHeader(
"Cache-Control",
`max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`,
);
}
res.send(JSON.stringify(PATsInfo, null, 2));
} catch (err) {
// Throw error if something went wrong.
logger.error(err);
res.setHeader("Cache-Control", "no-store");
res.send("Something went wrong: " + err.message);
}
};
+103
View File
@@ -0,0 +1,103 @@
/**
* @file Contains a simple cloud function that can be used to check if the PATs are still
* functional.
*
* @description This function is currently rate limited to 1 request per 5 minutes.
*/
import retryer from "../../src/common/retryer.js";
import { logger, request } from "../../src/common/utils.js";
export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 5 minutes
/**
* Simple uptime check fetcher for the PATs.
*
* @param {import('axios').AxiosRequestHeaders} variables
* @param {string} token
*/
const uptimeFetcher = (variables, token) => {
return request(
{
query: `
query {
rateLimit {
remaining
}
}
`,
variables,
},
{
Authorization: `bearer ${token}`,
},
);
};
/**
* Creates Json response that can be used for shields.io dynamic card generation.
*
* @param {*} up Whether the PATs are up or not.
* @returns Dynamic shields.io JSON response object.
*
* @see https://shields.io/endpoint.
*/
const shieldsUptimeBadge = (up) => {
const schemaVersion = 1;
const isError = true;
const label = "Public Instance";
const message = up ? "up" : "down";
const color = up ? "brightgreen" : "red";
return {
schemaVersion,
label,
message,
color,
isError,
};
};
/**
* Cloud function that returns whether the PATs are still functional.
*/
export default async (req, res) => {
let { type } = req.query;
type = type ? type.toLowerCase() : "boolean";
res.setHeader("Content-Type", "application/json");
try {
let PATsValid = true;
try {
await retryer(uptimeFetcher, {});
} catch (err) {
PATsValid = false;
}
if (PATsValid) {
res.setHeader(
"Cache-Control",
`max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`,
);
} else {
res.setHeader("Cache-Control", "no-store");
}
switch (type) {
case "shields":
res.send(shieldsUptimeBadge(PATsValid));
break;
case "json":
res.send({ up: PATsValid });
break;
default:
res.send(PATsValid);
break;
}
} catch (err) {
// Return fail boolean if something went wrong.
logger.error(err);
res.setHeader("Cache-Control", "no-store");
res.send("Something went wrong: " + err.message);
}
};
+29 -5
View File
@@ -1,4 +1,3 @@
import * as dotenv from "dotenv";
import { renderTopLanguages } from "../src/cards/top-languages-card.js"; import { renderTopLanguages } from "../src/cards/top-languages-card.js";
import { blacklist } from "../src/common/blacklist.js"; import { blacklist } from "../src/common/blacklist.js";
import { import {
@@ -11,8 +10,6 @@ import {
import { fetchTopLanguages } from "../src/fetchers/top-languages-fetcher.js"; import { fetchTopLanguages } from "../src/fetchers/top-languages-fetcher.js";
import { isLocaleAvailable } from "../src/translations.js"; import { isLocaleAvailable } from "../src/translations.js";
dotenv.config();
export default async (req, res) => { export default async (req, res) => {
const { const {
username, username,
@@ -28,10 +25,14 @@ export default async (req, res) => {
layout, layout,
langs_count, langs_count,
exclude_repo, exclude_repo,
size_weight,
count_weight,
custom_title, custom_title,
locale, locale,
border_radius, border_radius,
border_color, border_color,
disable_animations,
hide_progress,
} = req.query; } = req.query;
res.setHeader("Content-Type", "image/svg+xml"); res.setHeader("Content-Type", "image/svg+xml");
@@ -43,19 +44,39 @@ export default async (req, res) => {
return res.send(renderError("Something went wrong", "Locale not found")); return res.send(renderError("Something went wrong", "Locale not found"));
} }
if (
layout !== undefined &&
(typeof layout !== "string" ||
!["compact", "normal", "donut", "donut-vertical", "pie"].includes(layout))
) {
return res.send(
renderError("Something went wrong", "Incorrect layout input"),
);
}
try { try {
const topLangs = await fetchTopLanguages( const topLangs = await fetchTopLanguages(
username, username,
parseArray(exclude_repo), parseArray(exclude_repo),
size_weight,
count_weight,
); );
const cacheSeconds = clampValue( let cacheSeconds = clampValue(
parseInt(cache_seconds || CONSTANTS.FOUR_HOURS, 10), parseInt(cache_seconds || CONSTANTS.FOUR_HOURS, 10),
CONSTANTS.FOUR_HOURS, CONSTANTS.FOUR_HOURS,
CONSTANTS.ONE_DAY, CONSTANTS.ONE_DAY,
); );
cacheSeconds = process.env.CACHE_SECONDS
? parseInt(process.env.CACHE_SECONDS, 10) || cacheSeconds
: cacheSeconds;
res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); res.setHeader(
"Cache-Control",
`max-age=${
cacheSeconds / 2
}, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
);
return res.send( return res.send(
renderTopLanguages(topLangs, { renderTopLanguages(topLangs, {
@@ -73,9 +94,12 @@ export default async (req, res) => {
border_radius, border_radius,
border_color, border_color,
locale: locale ? locale.toLowerCase() : null, locale: locale ? locale.toLowerCase() : null,
disable_animations: parseBoolean(disable_animations),
hide_progress: parseBoolean(hide_progress),
}), }),
); );
} catch (err) { } catch (err) {
res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
return res.send(renderError(err.message, err.secondaryMessage)); return res.send(renderError(err.message, err.secondaryMessage));
} }
}; };
+11 -6
View File
@@ -1,4 +1,3 @@
import * as dotenv from "dotenv";
import { renderWakatimeCard } from "../src/cards/wakatime-card.js"; import { renderWakatimeCard } from "../src/cards/wakatime-card.js";
import { import {
clampValue, clampValue,
@@ -10,8 +9,6 @@ import {
import { fetchWakatimeStats } from "../src/fetchers/wakatime-fetcher.js"; import { fetchWakatimeStats } from "../src/fetchers/wakatime-fetcher.js";
import { isLocaleAvailable } from "../src/translations.js"; import { isLocaleAvailable } from "../src/translations.js";
dotenv.config();
export default async (req, res) => { export default async (req, res) => {
const { const {
username, username,
@@ -31,7 +28,6 @@ export default async (req, res) => {
langs_count, langs_count,
hide, hide,
api_domain, api_domain,
range,
border_radius, border_radius,
border_color, border_color,
} = req.query; } = req.query;
@@ -43,19 +39,27 @@ export default async (req, res) => {
} }
try { try {
const stats = await fetchWakatimeStats({ username, api_domain, range }); const stats = await fetchWakatimeStats({ username, api_domain });
let cacheSeconds = clampValue( let cacheSeconds = clampValue(
parseInt(cache_seconds || CONSTANTS.FOUR_HOURS, 10), parseInt(cache_seconds || CONSTANTS.FOUR_HOURS, 10),
CONSTANTS.FOUR_HOURS, CONSTANTS.FOUR_HOURS,
CONSTANTS.ONE_DAY, CONSTANTS.ONE_DAY,
); );
cacheSeconds = process.env.CACHE_SECONDS
? parseInt(process.env.CACHE_SECONDS, 10) || cacheSeconds
: cacheSeconds;
if (!cache_seconds) { if (!cache_seconds) {
cacheSeconds = CONSTANTS.FOUR_HOURS; cacheSeconds = CONSTANTS.FOUR_HOURS;
} }
res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); res.setHeader(
"Cache-Control",
`max-age=${
cacheSeconds / 2
}, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
);
return res.send( return res.send(
renderWakatimeCard(stats, { renderWakatimeCard(stats, {
@@ -78,6 +82,7 @@ export default async (req, res) => {
}), }),
); );
} catch (err) { } catch (err) {
res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
return res.send(renderError(err.message, err.secondaryMessage)); return res.send(renderError(err.message, err.secondaryMessage));
} }
}; };
+22 -8
View File
@@ -53,18 +53,32 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">喜欢这个项目?请考虑<a href="https://www.paypal.me/anuraghazra">捐赠</a>来帮助它完善! <p align="center">喜欢这个项目?请考虑<a href="https://www.paypal.me/anuraghazra">捐赠</a>来帮助它完善!
# 特性 # 特性 <!-- omit in toc -->
- [GitHub 统计卡片](#GitHub-统计卡片) - [GitHub 统计卡片](#github-统计卡片)
- [GitHub 更多置顶](#GitHub-更多置顶) - [隐藏指定统计](#隐藏指定统计)
- [将私人项目贡献添加到总提交计数中](#将私人项目贡献添加到总提交计数中)
- [显示图标](#显示图标)
- [主题](#主题)
- [自定义](#自定义)
- [GitHub 更多置顶](#github-更多置顶)
- [使用细则](#使用细则)
- [Demo](#demo)
- [热门语言卡片](#热门语言卡片) - [热门语言卡片](#热门语言卡片)
- [主题](#主题) - [使用细则](#使用细则-1)
- [自定义](#自定义) - [隐藏指定语言](#隐藏指定语言)
- [自己部署](#自己部署) - [紧凑的语言卡片布局](#紧凑的语言卡片布局)
- [Demo](#demo-1)
- [全部 Demos](#全部-demos)
- [快速提示 (对齐 Repo 卡片)](#快速提示-对齐-repo-卡片)
- [自己部署](#自己部署)
- [:sparkling\_heart: 支持这个项目](#sparkling_heart-支持这个项目)
# GitHub 统计卡片 # GitHub 统计卡片
@@ -138,7 +152,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `bg_color` - 卡片背景颜色 _(十六进制色码)_ **或者**_angle,start,end_ 的形式渐变 - `bg_color` - 卡片背景颜色 _(十六进制色码)_ **或者**_angle,start,end_ 的形式渐变
- `hide_border` - 隐藏卡的边框 _(布尔值)_ - `hide_border` - 隐藏卡的边框 _(布尔值)_
- `theme` - 主题名称,从[所有可用主题](../themes/README.md)中选择 - `theme` - 主题名称,从[所有可用主题](../themes/README.md)中选择
- `cache_seconds` - 手动设置缓存头 _(最小值: 1800,最大值: 86400_ - `cache_seconds` - 手动设置缓存头 _(最小值: 14400,最大值: 86400_
- `locale` - 在卡片中设置语言 _(例如 cn, de, es, 等等)_ - `locale` - 在卡片中设置语言 _(例如 cn, de, es, 等等)_
##### bg_color 渐变 ##### bg_color 渐变
@@ -169,7 +183,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `hide` - 从卡片中隐藏指定语言 _(Comma seperated values)_ - `hide` - 从卡片中隐藏指定语言 _(Comma seperated values)_
- `hide_title` - _(boolean)_ - `hide_title` - _(boolean)_
- `layout` - 在两个可用布局 `default` & `compact` 间切换 - `layout` - 提供五種佈局 `normal` & `compact` & `donut` & `donut-vertical` & `pie` 间切换
- `card_width` - 手动设置卡片的宽度 _(number)_ - `card_width` - 手动设置卡片的宽度 _(number)_
> :warning: **重要:** > :warning: **重要:**
+25 -11
View File
@@ -54,19 +54,33 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">Du magst das Projekt? Wie wäre es mit einer kleinen <a href="https://www.paypal.me/anuraghazra">Spende</a> um es weiterhin am Leben zu erhalten? <p align="center">Du magst das Projekt? Wie wäre es mit einer kleinen <a href="https://www.paypal.me/anuraghazra">Spende</a> um es weiterhin am Leben zu erhalten?
# Funktionen # Funktionen <!-- omit in toc -->
- [GitHub Statistiken-Karte](#github-statistiken-karte) - [GitHub Statistiken-Karte](#github-statistiken-karte)
- [GitHub Extra Pins](#github-extra-pins) - [Verbergen individueller Statistiken](#verbergen-individueller-statistiken)
- [Symbole anzeigen](#symbole-anzeigen)
- [Erscheinungsbild/Themes](#erscheinungsbildthemes)
- [Anpassungen/Personalisierung](#anpassungenpersonalisierung)
- [GitHub Extra-Pins](#github-extra-pins)
- [Benutzung](#benutzung)
- [Beispiele](#beispiele)
- [Top Programmiersprachen-Karte](#top-programmiersprachen-karte) - [Top Programmiersprachen-Karte](#top-programmiersprachen-karte)
- [Benutzung](#benutzung-1)
- [Verbirg einzelne Sprachen](#verbirg-einzelne-sprachen)
- [Kompaktes Sprachen-Karte Layout](#kompaktes-sprachen-karte-layout)
- [Beispiel](#beispiel)
- [Wakatime Wochen-Statistik](#wakatime-wochen-statistik) - [Wakatime Wochen-Statistik](#wakatime-wochen-statistik)
- [Erscheinungsbild/Themes](#erscheinungsbildthemes) - [Beispiel](#beispiel-1)
- [Anpassungen/Personalisierung](#anpassungenpersonalisierung) - [Alle Beispiele](#alle-beispiele)
- [Selber betreiben](#betreibe-es-auf-deiner-eigenen-vercel-instanz) - [Kleiner Tipp (Ausrichten der Repo-Karte)](#kleiner-tipp-ausrichten-der-repo-karte)
- [Betreibe es auf deiner eigenen Vercel-Instanz](#betreibe-es-auf-deiner-eigenen-vercel-instanz)
- [:sparkling\_heart: Unterstütze das Projekt](#sparkling_heart-unterstütze-das-projekt)
# GitHub Statistiken-Karte # GitHub Statistiken-Karte
@@ -128,7 +142,7 @@ Du kannst das Erscheinungsbild deiner `Stats Card` oder `Repo Card`, mithilfe vo
- `bg_color` - Hintergrundfarbe _(hex color)_ **oder** ein Farbverlauf in der Form von _winkel,start,ende_ - `bg_color` - Hintergrundfarbe _(hex color)_ **oder** ein Farbverlauf in der Form von _winkel,start,ende_
- `hide_border` - Blendet den Rand der Karte aus _(Boolean)_ - `hide_border` - Blendet den Rand der Karte aus _(Boolean)_
- `theme` - Name des Erscheinungsbildes/Themes [alle verfügbaren Themes](../themes/README.md) - `theme` - Name des Erscheinungsbildes/Themes [alle verfügbaren Themes](../themes/README.md)
- `cache_seconds` - manuelles festlegen der Cachezeiten _(min: 1800, max: 86400)_ - `cache_seconds` - manuelles festlegen der Cachezeiten _(min: 14400, max: 86400)_
- `locale` - Stellen Sie die Sprache auf der Karte ein _(z.B. cn, de, es, etc.)_ - `locale` - Stellen Sie die Sprache auf der Karte ein _(z.B. cn, de, es, etc.)_
##### Farbverlauf in bg_color ##### Farbverlauf in bg_color
@@ -159,7 +173,7 @@ Du kannst mehrere, mit Kommas separierte, Werte in der bg_color Option angeben,
- `hide` - Verbirgt die angegebenen Sprachen von der Karte _(Komma separierte Werte)_ - `hide` - Verbirgt die angegebenen Sprachen von der Karte _(Komma separierte Werte)_
- `hide_title` - _(Boolean)_ - `hide_title` - _(Boolean)_
- `layout` - Wechsel zwischen den zwei verfügbaren Layouts `default` & `compact` - `layout` - Wechseln Sie zwischen den fünf verfügbaren Layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`
- `card_width` - Lege die Breite der Karte manuell fest _(Zahl)_ - `card_width` - Lege die Breite der Karte manuell fest _(Zahl)_
> :warning: **Wichtig:** > :warning: **Wichtig:**
@@ -251,18 +265,18 @@ Du kannst die `&layout=compact` Option nutzen, um das Kartendesign zu ändern.
Ändere `?username=` in den eigenen [Wakatime](https://wakatime.com)-Benutzernamen. Ändere `?username=` in den eigenen [Wakatime](https://wakatime.com)-Benutzernamen.
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### Beispiel ### Beispiel
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
- Kompaktes Layout - Kompaktes Layout
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
--- ---
+28 -13
View File
@@ -60,15 +60,30 @@
</p> </p>
<p align="center">¿Te gusta este proyecto? ¡Por favor, considera <a href="https://www.paypal.me/anuraghazra">donar</a> para ayudar a mejorarlo! <p align="center">¿Te gusta este proyecto? ¡Por favor, considera <a href="https://www.paypal.me/anuraghazra">donar</a> para ayudar a mejorarlo!
# Características # Características <!-- omit in toc -->
- [Tarjeta de estadísticas de GitHub](#tarjeta-de-estadísticas-de-github) - [Tarjeta de estadísticas de GitHub](#tarjeta-de-estadísticas-de-github)
- [Pins adicionales de GitHub](#pines-adicionales-de-github) - [Ocultar estadísticas individualmente](#ocultar-estadísticas-individualmente)
- [Agregar contribuciones privadas al total de commits contados](#agregar-contribuciones-privadas-al-total-de-commits-contados)
- [Mostrar íconos](#mostrar-íconos)
- [Temas](#temas)
- [Personalización](#personalización)
- [Pines adicionales de GitHub](#pines-adicionales-de-github)
- [Utilización](#utilización)
- [Ejemplo](#ejemplo)
- [Tarjeta de Lenguajes Principales](#tarjeta-de-lenguajes-principales) - [Tarjeta de Lenguajes Principales](#tarjeta-de-lenguajes-principales)
- [Wakatime Week Stats](#estadísticas-de-la-semana-de-wakatime) - [Utilización](#utilización-1)
- [Temas](#temas) - [Excluir repositorios individualmente](#excluir-repositorios-individualmente)
- [Personalización](#personalización) - [Ocultar lenguajes individualmente](#ocultar-lenguajes-individualmente)
- [Despliega por tu cuenta](#despliega-tu-propia-instancia-de-vercel) - [Mostrar más lenguajes](#mostrar-más-lenguajes)
- [Diseño Compacto de Tarjeta de Lenguaje](#diseño-compacto-de-tarjeta-de-lenguaje)
- [Ejemplo](#ejemplo-1)
- [Estadísticas de la semana de Wakatime](#estadísticas-de-la-semana-de-wakatime)
- [Ejemplo](#ejemplo-2)
- [Todos los ejemplos](#todos-los-ejemplos)
- [Consejo rápido (para alinear las tarjetas de repositorio)](#consejo-rápido-para-alinear-las-tarjetas-de-repositorio)
- [Despliega tu propia instancia de Vercel](#despliega-tu-propia-instancia-de-vercel)
- [:sparkling\_heart: Apoya al proyecto](#sparkling_heart-apoya-al-proyecto)
# Tarjeta de estadísticas de GitHub # Tarjeta de estadísticas de GitHub
@@ -142,7 +157,7 @@ Puedes personalizar el aspecto de tu `Tarjeta de Estadísticas` o `Tarjeta de Re
- `bg_color` - Color de fondo _(hex color)_ - `bg_color` - Color de fondo _(hex color)_
- `hide_border` - Oculta el borde de la tarjeta _(booleano)_ - `hide_border` - Oculta el borde de la tarjeta _(booleano)_
- `theme` - Nombre del tema, elige uno de [todos los temas disponible ](../themes/README.md) - `theme` - Nombre del tema, elige uno de [todos los temas disponible ](../themes/README.md)
- `cache_seconds` - Cache _(min: 1800, max: 86400)_ - `cache_seconds` - Cache _(min: 14400, max: 86400)_
- `locale` - configurar el idioma en la tarjeta _(p.ej. cn, de, es, etc.)_ - `locale` - configurar el idioma en la tarjeta _(p.ej. cn, de, es, etc.)_
##### Gradiente en `bg_color` ##### Gradiente en `bg_color`
@@ -175,7 +190,7 @@ Puedes pasar mútliples valores separados por coma en la opción `bg_color` para
- `hide` - Oculta de la tarjeta los lenguajes especificados _(valores separados por comas)_ - `hide` - Oculta de la tarjeta los lenguajes especificados _(valores separados por comas)_
- `hide_title` - _(booleano)_ - `hide_title` - _(booleano)_
- `layout` - Cambia entre los dos diseños disponibles `default` & `compact` - `layout` - Cambiar entre los cinco diseños disponibles `normal` & `compact` & `donut` & `donut-vertical` & `pie`
- `card_width` - Establece el ancho de la tarjeta manualmente _(número)_ - `card_width` - Establece el ancho de la tarjeta manualmente _(número)_
- `langs_count` - Muestra más lenguajes en la tarjeta, entre 1-10, por defecto 5 _(número)_ - `langs_count` - Muestra más lenguajes en la tarjeta, entre 1-10, por defecto 5 _(número)_
- `exclude_repo` - Excluye los repositorios especificados _(valores separados por comas)_ - `exclude_repo` - Excluye los repositorios especificados _(valores separados por comas)_
@@ -282,18 +297,18 @@ Puedes usar la opción `& layout = compact` para cambiar el diseño de la tarjet
cambia el valor del parámetro `?username=` a tu username en [Wakatime](https://wakatime.com). cambia el valor del parámetro `?username=` a tu username en [Wakatime](https://wakatime.com).
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### Ejemplo ### Ejemplo
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
- Diseño compacto - Diseño compacto
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -343,7 +358,7 @@ Escoja cualquiera de los [temas por defecto](#themes)
- Tarjeta de Wakatime - Tarjeta de Wakatime
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
--- ---
+22 -21
View File
@@ -53,18 +53,31 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">Vous aimez ce projet? Pensez <a href="https://www.paypal.me/anuraghazra">à faire un don</a> pour l'améliorer! <p align="center">Vous aimez ce projet? Pensez <a href="https://www.paypal.me/anuraghazra">à faire un don</a> pour l'améliorer!
# Features # Features <!-- omit in toc -->
- [Carte des stats GitHub](#carte-des-stats-github) - [Carte des Stats GitHub](#carte-des-stats-github)
- [Cacher les statistiques individuelles](#cacher-les-statistiques-individuelles)
- [Afficher les icônes](#afficher-les-icônes)
- [Thèmes](#thèmes)
- [Personnalisation](#personnalisation)
- [GitHub Extra Pins](#github-extra-pins) - [GitHub Extra Pins](#github-extra-pins)
- [Carte des meilleurs langages](#carte-des-langages-les--utilisés) - [Usage](#usage)
- [Themes](#thèmes) - [Démo](#démo)
- [Personnalisation](#personnalisation) - [Carte des langages les + utilisés](#carte-des-langages-les--utilisés)
- [Deployer toi-même](#déployer-sur-votre-propre-instance-vercel) - [Usage](#usage-1)
- [Cacher certaines langages](#cacher-certaines-langages)
- [Carte compacte des langages](#carte-compacte-des-langages)
- [Démo](#démo-1)
- [Toutes les démos](#toutes-les-démos)
- [Conseil rapide (aligner les cartes des dépôts)](#conseil-rapide-aligner-les-cartes-des-dépôts)
- [Déployer sur votre propre instance Vercel](#déployer-sur-votre-propre-instance-vercel)
- [:sparkling\_heart: Supporter le project](#sparkling_heart-supporter-le-project)
# Carte des Stats GitHub # Carte des Stats GitHub
@@ -88,18 +101,6 @@ Pour masquer des statistiques spécifiques, vous pouvez passer un paramètre de
![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs) ![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
``` ```
### Ajouter le compte des contributions privées au compte des commits totaux
Vous pouvez ajouter le compte de toutes vos contributions privées au compte total des engagements en utilisant le paramètre de requête `?count_private=true`.
_Note: Si vous déployez vous-même ce projet, les contributions privées seront comptées par défaut ; sinon, vous devez choisir de partager les comptes de vos contributions privées._
> Options: `&count_private=true`
```md
![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
```
### Afficher les icônes ### Afficher les icônes
Pour activer les icônes, vous pouvez passer `show_icons=true` dans le paramètre de requête, comme ceci : Pour activer les icônes, vous pouvez passer `show_icons=true` dans le paramètre de requête, comme ceci :
@@ -138,7 +139,7 @@ Vous pouvez personnaliser l'apparence de votre `Carte des stats` ou `Carte de d
- `bg_color` - Couleur du fond de la carte _(hex color)_ **ou** un gradiant de la forme _angle,start,end_ - `bg_color` - Couleur du fond de la carte _(hex color)_ **ou** un gradiant de la forme _angle,start,end_
- `hide_border` - Cache la bordure de la carte _(booléen)_ - `hide_border` - Cache la bordure de la carte _(booléen)_
- `theme` - Nom du thème, parmis [tous les thèmes disponibles](../themes/README.md) - `theme` - Nom du thème, parmis [tous les thèmes disponibles](../themes/README.md)
- `cache_seconds` - Paramétrer le cache manuellement _(min: 1800, max: 86400)_ - `cache_seconds` - Paramétrer le cache manuellement _(min: 14400, max: 86400)_
- `locale` - définir la langue de la carte _(par exemple. cn, de, es, etc.)_ - `locale` - définir la langue de la carte _(par exemple. cn, de, es, etc.)_
##### Gradient in bg_color ##### Gradient in bg_color
@@ -158,7 +159,7 @@ Vous pouvez fournir plusieurs valeurs (suivie d'une virgule) dans l'option bg_co
- `hide_rank` - Masquer le rang _(boolean)_ - `hide_rank` - Masquer le rang _(boolean)_
- `show_icons` - Afficher les icônes _(boolean)_ - `show_icons` - Afficher les icônes _(boolean)_
- `include_all_commits` - Compter le total de commits au lieu de ne compter que les commits de l'année en cours _(boolean)_ - `include_all_commits` - Compter le total de commits au lieu de ne compter que les commits de l'année en cours _(boolean)_
- `count_private` - Compter les commits privés _(boolean)_ - `count_private` - Compter les contributions privées _(boolean)_
- `line_height` - Fixer la hauteur de la ligne entre les textes _(number)_ - `line_height` - Fixer la hauteur de la ligne entre les textes _(number)_
#### Repo Card Exclusive Options: #### Repo Card Exclusive Options:
@@ -169,7 +170,7 @@ Vous pouvez fournir plusieurs valeurs (suivie d'une virgule) dans l'option bg_co
- `hide` - Masquer les langages spécifiés sur la carte _(Comma seperated values)_ - `hide` - Masquer les langages spécifiés sur la carte _(Comma seperated values)_
- `hide_title` - Masquer le titre _(boolean)_ - `hide_title` - Masquer le titre _(boolean)_
- `layout` - Alterner entre 2 mise en page `default` & `compact` - `layout` - Alterner entre 5 mise en page `normal` & `compact` & `donut` & `donut-vertical` & `pie`
- `card_width` - Fixer la largeur de la carte manuellement _(number)_ - `card_width` - Fixer la largeur de la carte manuellement _(number)_
> :warning: **Important:** > :warning: **Important:**
+24 -9
View File
@@ -53,18 +53,33 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">Se ti piace questo progetto, considera la possibilità di <a href="https://www.paypal.me/anuraghazra">donare</a> per aiutare a renderlo migliore! <p align="center">Se ti piace questo progetto, considera la possibilità di <a href="https://www.paypal.me/anuraghazra">donare</a> per aiutare a renderlo migliore!
# Caratteristiche # Caratteristiche <!-- omit in toc -->
- [GitHub Stats Card](#github-stats-card)
- [Nascondere statistiche individuali](#nascondere-statistiche-individuali)
- [Includere i contributi privati nel computo totale](#includere-i-contributi-privati-nel-computo-totale)
- [Mostrare le icone](#mostrare-le-icone)
- [Temi](#temi)
- [Personalizzazione](#personalizzazione)
- [GitHub Extra Pins](#github-extra-pins)
- [Utilizzo](#utilizzo)
- [Demo](#demo)
- [Top Languages Card](#top-languages-card)
- [Utilizzo](#utilizzo-1)
- [Nascondi linguaggi specifici](#nascondi-linguaggi-specifici)
- [Layout compatto](#layout-compatto)
- [Demo](#demo-1)
- [Galleria di esempi](#galleria-di-esempi)
- [Consiglio veloce (Allineare le Card)](#consiglio-veloce-allineare-le-card)
- [Deploy su Vercel](#deploy-su-vercel)
- [:sparkling\_heart: Supporta il progetto](#sparkling_heart-supporta-il-progetto)
- [Statistiche GitHub (GitHub Stats Card)](#github-stats-card)
- [GitHub Extra Pin](#github-extra-pins)
- [Linguaggi più usati (Top Languages Card)](#top-languages-card)
- [Temi](#temi)
- [Personalizzazione](#personalizzazione)
- [Effettua il Deploy](#deploy-su-vercel)
# GitHub Stats Card # GitHub Stats Card
@@ -138,7 +153,7 @@ Puoi personalizzare l'aspetto delle tue `Stats Card` o delle `Repo Card` in qual
- `bg_color` - Colore dello sfondo _(in esadecimale)_ **oppure** un gradiente nella forma _angolo,inizio,fine_ - `bg_color` - Colore dello sfondo _(in esadecimale)_ **oppure** un gradiente nella forma _angolo,inizio,fine_
- `hide_border` - Nasconde il bordo della carta _(booleano)_ - `hide_border` - Nasconde il bordo della carta _(booleano)_
- `theme` - Nome del tema, dai un'occhiata a [tutti i temi disponibili](../themes/README.md) - `theme` - Nome del tema, dai un'occhiata a [tutti i temi disponibili](../themes/README.md)
- `cache_seconds` - Specifica manualmente il valore di cache, in secondi _(min: 1800, max: 86400)_ - `cache_seconds` - Specifica manualmente il valore di cache, in secondi _(min: 14400, max: 86400)_
- `locale` - Impostare la lingua nella scheda _(per esempio. cn, de, es, eccetera.)_ - `locale` - Impostare la lingua nella scheda _(per esempio. cn, de, es, eccetera.)_
##### Gradiente nello sfondo ##### Gradiente nello sfondo
@@ -169,7 +184,7 @@ Puoi fornire valori separati da virgola nel parametro bg_color per creare un gra
- `hide` - Nasconde un linguaggio specifico _(valori separati da virgola)_ - `hide` - Nasconde un linguaggio specifico _(valori separati da virgola)_
- `hide_title` - Nasconde il titolo _(booleano)_ - `hide_title` - Nasconde il titolo _(booleano)_
- `layout` - Specifica il tipo di layout, `default` (esteso) o `compact` (compatto) - `layout` - Specificare il tipo di layout, `normal` (esteso), `compact` (compatto), `donut` (ciambella), `donut-vertical` (ciambella verticale) e `pie` (torta)
- `card_width` - Specifica il valore della larghezza _(numero)_ - `card_width` - Specifica il valore della larghezza _(numero)_
> :warning: **Importante:** > :warning: **Importante:**
+20 -6
View File
@@ -53,18 +53,32 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">このプロジェクトを気に入っていただけましたか?<br>もしよろしければ、プロジェクトのさらなる改善のために<a href="https://www.paypal.me/anuraghazra">寄付</a>を検討して頂けると嬉しいです!</p> <p align="center">このプロジェクトを気に入っていただけましたか?<br>もしよろしければ、プロジェクトのさらなる改善のために<a href="https://www.paypal.me/anuraghazra">寄付</a>を検討して頂けると嬉しいです!</p>
# 主な機能 # 主な機能 <!-- omit in toc -->
- [GitHub Stats Card](#github-stats-card) - [GitHub Stats Card](#github-stats-card)
- [特定の統計情報を隠す](#特定の統計情報を隠す)
- [プライベートリポジトリへのコミットをカウントする](#プライベートリポジトリへのコミットをカウントする)
- [アイコンを表示する](#アイコンを表示する)
- [テーマの変更](#テーマの変更)
- [テーマを自分でカスタマイズする](#テーマを自分でカスタマイズする)
- [GitHub Extra Pins](#github-extra-pins) - [GitHub Extra Pins](#github-extra-pins)
- [使い方](#使い方)
- [デモ](#デモ)
- [Top Languages Card](#top-languages-card) - [Top Languages Card](#top-languages-card)
- [Themes](#テーマの変更) - [使い方](#使い方-1)
- [Customization](#テーマを自分でカスタマイズする) - [特定の言語を隠す](#特定の言語を隠す)
- [Deploy Yourself](#自分の-Vercel-インスタンスにデプロイする) - [レイアウトをコンパクトにする](#レイアウトをコンパクトにする)
- [デモ](#デモ-1)
- [全てのデモ](#全てのデモ)
- [クイックヒント (カードを並べる)](#クイックヒント-カードを並べる)
- [自分の Vercel インスタンスにデプロイする](#自分の-vercel-インスタンスにデプロイする)
- [:sparkling\_heart: このプロジェクトを支援する](#sparkling_heart-このプロジェクトを支援する)
# GitHub Stats Card # GitHub Stats Card
@@ -139,7 +153,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `bg_color` - 背景の色 _(16 進数カラーコード)_ **または** _angle,start,end_ の形式でグラデーションを指定することも可 - `bg_color` - 背景の色 _(16 進数カラーコード)_ **または** _angle,start,end_ の形式でグラデーションを指定することも可
- `hide_border` - カードの境界線を非表示にします _(ブール値)_ - `hide_border` - カードの境界線を非表示にします _(ブール値)_
- `theme` - [使用可能なテーマ一覧](../themes/README.md) から選んだテーマ名 - `theme` - [使用可能なテーマ一覧](../themes/README.md) から選んだテーマ名
- `cache_seconds` - キャッシュ時間の秒数 _(最小値: 1800, 最大値: 86400)_ - `cache_seconds` - キャッシュ時間の秒数 _(最小値: 14400, 最大値: 86400)_
- `locale` - カードに言語を設定する _(例えば cn, de, es, 等)_ - `locale` - カードに言語を設定する _(例えば cn, de, es, 等)_
##### bg_color の グラデーション指定 ##### bg_color の グラデーション指定
@@ -172,7 +186,7 @@ bg_color オプションで複数のカンマ区切りの値を指定してグ
- `hide` - 特定の言語を隠す _(カンマ区切りで指定)_ - `hide` - 特定の言語を隠す _(カンマ区切りで指定)_
- `hide_title` - _(boolean)_ - `hide_title` - _(boolean)_
- `layout` - `default` `compact` のいずれかのレイアウトに切り替える - `layout` - `normal` & `compact` & `donut` & `donut-vertical` & `pie` のいずれかのレイアウトに切り替える
- `card_width` - カードの横幅 _(number)_ - `card_width` - カードの横幅 _(number)_
- `langs_count` - 表示される言語の数 _(1 ~ 10, 初期値 5)_ - `langs_count` - 表示される言語の数 _(1 ~ 10, 初期値 5)_
- `exclude_repo` - 指定されたリポジトリを除外する _(カンマ区切りで指定)_ - `exclude_repo` - 指定されたリポジトリを除外する _(カンマ区切りで指定)_
+31 -14
View File
@@ -1,7 +1,7 @@
<p align="center"> <p align="center">
<img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="GitHub Readme Stats" /> <img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="GitHub Readme Stats" />
<h2 align="center">GitHub Readme Stats</h2> <h2 align="center">GitHub Readme Stats</h2>
<p align="center">동적으로 생성되는 Github 사용량 통계를 여러분의 README 에 추가해보세요!</p> <p align="center">동적으로 생성되는 GitHub 사용량 통계를 여러분의 README 에 추가해보세요!</p>
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/anuraghazra/github-readme-stats/actions"> <a href="https://github.com/anuraghazra/github-readme-stats/actions">
@@ -53,26 +53,43 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">기능들이 마음에 드시나요? 괜찮으시다면, 서비스 개선을 위해 <a href="https://www.paypal.me/anuraghazra">기부</a>를 고려해주세요! <p align="center">기능들이 마음에 드시나요? 괜찮으시다면, 서비스 개선을 위해 <a href="https://www.paypal.me/anuraghazra">기부</a>를 고려해주세요!
# 기능들 # 기능들 <!-- omit in toc -->
- [GitHub 통계](#github-통계) - [GitHub 통계](#github-통계)
- [개별 통계 숨기기](#개별-통계-숨기기)
- [총 커밋 수에 비공개 기여도 (private contribs) 수 추가하기](#총-커밋-수에-비공개-기여도-private-contribs-수-추가하기)
- [아이콘 표시하기](#아이콘-표시하기)
- [테마 설정하기](#테마-설정하기)
- [커스터마이징](#커스터마이징)
- [GitHub 저장소 핀](#github-저장소-핀) - [GitHub 저장소 핀](#github-저장소-핀)
- [사용법](#사용법)
- [미리보기](#미리보기)
- [언어 사용량 통계](#언어-사용량-통계) - [언어 사용량 통계](#언어-사용량-통계)
- [사용법](#사용법-1)
- [통계에서 제외할 저장소 지정하기](#통계에서-제외할-저장소-지정하기)
- [통계에서 특정 언어 제외하기](#통계에서-특정-언어-제외하기)
- [표시할 언어 수 지정하기](#표시할-언어-수-지정하기)
- [컴택트한 카드 레이아웃 설정하기](#컴택트한-카드-레이아웃-설정하기)
- [미리보기](#미리보기-1)
- [Wakatime 주간 통계](#wakatime-주간-통계) - [Wakatime 주간 통계](#wakatime-주간-통계)
- [테마](#테마) - [미리보기](#미리보기-2)
- [커스터마이징](#커스터마이징) - [전체 미리보기](#전체-미리보기)
- [직접 배포하기](#나만의-Vercel-인스턴스에-직접-배포하기) - [꿀팁 (저장소 핀 정렬하기)](#꿀팁-저장소-핀-정렬하기)
- [나만의 Vercel 인스턴스에 직접 배포하기](#나만의-vercel-인스턴스에-직접-배포하기)
- [:sparkling\_heart: 프로젝트 지원하기!](#sparkling_heart-프로젝트-지원하기)
# GitHub 통계 # GitHub 통계
아래 코드를 복사해서 마크다운 파일에 붙여넣으면 끝이에요, 아주 간단해요! 아래 코드를 복사해서 마크다운 파일에 붙여넣으면 끝이에요, 아주 간단해요!
`?username=` 속성의 값을 Github 계정의 사용자 명(닉네임)으로 바꿔주세요. `?username=` 속성의 값을 GitHub 계정의 사용자 명(닉네임)으로 바꿔주세요.
```md ```md
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
@@ -149,7 +166,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `bg_color` - 카드의 배경 색상 _(hex color)_ **혹은** 다음 양식으로 그라데이션 주기 _angle,start,end_ - `bg_color` - 카드의 배경 색상 _(hex color)_ **혹은** 다음 양식으로 그라데이션 주기 _angle,start,end_
- `hide_border` - 카드의 테두리 표시 여부 _(boolean)_ - `hide_border` - 카드의 테두리 표시 여부 _(boolean)_
- `theme` - 테마의 이름, [사용 가능한 모든 테마](../themes/README.md) 에서 선택 - `theme` - 테마의 이름, [사용 가능한 모든 테마](../themes/README.md) 에서 선택
- `cache_seconds` - 수동으로 캐시 헤더 설정 _(min: 1800, max: 86400)_ - `cache_seconds` - 수동으로 캐시 헤더 설정 _(min: 14400, max: 86400)_
- `locale` - 카드에 표시할 언어 _(e.g. kr, cn, de, es, etc.)_ - `locale` - 카드에 표시할 언어 _(e.g. kr, cn, de, es, etc.)_
##### 배경에 그라데이션 주기 ##### 배경에 그라데이션 주기
@@ -187,7 +204,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `hide` - 카드에서 특정 언어 제외 _(Comma-separated values)_ - `hide` - 카드에서 특정 언어 제외 _(Comma-separated values)_
- `hide_title` - 타이틀 제외 _(boolean)_ - `hide_title` - 타이틀 제외 _(boolean)_
- `layout` - 사용 가능한 두 가지 값, `default` & `compact` 중 표시 형태 선택 - `layout` - 5가지 값 사용 가능, `normal` & `compact` & `donut` & `donut-vertical` & `pie` 중 표시 형태 선택
- `card_width` - 카드 너비 직접 설정 _(number)_ - `card_width` - 카드 너비 직접 설정 _(number)_
- `langs_count` - 카드에 표시할 언어의 수 (1-10 사이, 기본 값 : 5) _(number)_ - `langs_count` - 카드에 표시할 언어의 수 (1-10 사이, 기본 값 : 5) _(number)_
- `exclude_repo` - 통계에 제외할 저장소 지정 _(Comma-separated values)_ - `exclude_repo` - 통계에 제외할 저장소 지정 _(Comma-separated values)_
@@ -235,7 +252,7 @@ GitHub 저장소 여분 핀을 이용하면, 6개 이상의 저장소 핀을 여
# 언어 사용량 통계 # 언어 사용량 통계
언어 사용량 통계 카드는 Github 사용자가 가장 많이 사용한 언어가 표시됩니다. 언어 사용량 통계 카드는 GitHub 사용자가 가장 많이 사용한 언어가 표시됩니다.
_참고: _참고:
언어 사용량 통계는 GitHub 에서 가장 많이 사용된 언어의 표기일 뿐입니다. 언어 사용량 통계는 GitHub 에서 가장 많이 사용된 언어의 표기일 뿐입니다.
@@ -296,18 +313,18 @@ _참고:
`?username=` 속성의 값을 [Wakatime](https://wakatime.com) 계정의 사용자 명(닉네임)으로 바꿔주세요. `?username=` 속성의 값을 [Wakatime](https://wakatime.com) 계정의 사용자 명(닉네임)으로 바꿔주세요.
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### 미리보기 ### 미리보기
[![willianrod 님의 wakatime 통계](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok 님의 wakatime 통계](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod 님의 wakatime 통계](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok 님의 wakatime 통계](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
- 컴팩트한 레이아웃 - 컴팩트한 레이아웃
[![willianrod 님의 wakatime 통계](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats) [![Harlok 님의 wakatime 통계](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -357,7 +374,7 @@ _참고:
- Wakatime 카드 - Wakatime 카드
[![willianrod 님의 Wakatime 카드](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok 님의 Wakatime 카드](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
--- ---
+28 -11
View File
@@ -53,19 +53,36 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">Bevalt het project? <a href="https://www.paypal.me/anuraghazra">Doneer</a> om het te verbeteren! <p align="center">Bevalt het project? <a href="https://www.paypal.me/anuraghazra">Doneer</a> om het te verbeteren!
# Functionaliteiten # Functionaliteiten <!-- omit in toc -->
- [GitHub Statistieken Kaart](#github-statistieken-kaart) - [GitHub Statistieken Kaart](#github-statistieken-kaart)
- [Verberg individueele statistieken](#verberg-individueele-statistieken)
- [Voeg privé contributies toe aan totale commits.](#voeg-privé-contributies-toe-aan-totale-commits)
- [Laat icoontjes zien](#laat-icoontjes-zien)
- [Thema's](#themas)
- [Opmaak](#opmaak)
- [GitHub Extra Pins](#github-extra-pins) - [GitHub Extra Pins](#github-extra-pins)
- [Top Programmeertalen Kaart](#top-Programmeertalen-kaart) - [Gebruik](#gebruik)
- [Demo](#demo)
- [Top Programmeertalen Kaart](#top-programmeertalen-kaart)
- [Gebruik](#gebruik-1)
- [Verberg individueele repositories](#verberg-individueele-repositories)
- [Verberg individueele talen](#verberg-individueele-talen)
- [Laat meer programmeertalen zien](#laat-meer-programmeertalen-zien)
- [Compacte Talen Kaart opmaak](#compacte-talen-kaart-opmaak)
- [Demo](#demo-1)
- [Wekelijkse Wakatime Statistieken](#wekelijkse-wakatime-statistieken) - [Wekelijkse Wakatime Statistieken](#wekelijkse-wakatime-statistieken)
- [Thema\'s](#themas) - [Demo](#demo-2)
- [Opmaak](#opmaak) - [Alle demos](#alle-demos)
- [Zelf deployen](#deploy-je-eigen-vercel-instatie) - [Kleine tip (Verstel de repo kaart z'n positie)](#kleine-tip-verstel-de-repo-kaart-zn-positie)
- [Deploy je eigen Vercel instatie](#deploy-je-eigen-vercel-instatie)
- [:sparkling\_heart: Ondersteun het project](#sparkling_heart-ondersteun-het-project)
# GitHub Statistieken Kaart # GitHub Statistieken Kaart
@@ -142,7 +159,7 @@ Je kan het uiterlijk van je `Statistieken kaart` of `Repo kaart` aanpassen hoe j
- `bg_color` - Achtergrond kleur van de kaart _(hex kleur)_ **of** een verloop van kleuren in het formaat van _graden,start,einde_ - `bg_color` - Achtergrond kleur van de kaart _(hex kleur)_ **of** een verloop van kleuren in het formaat van _graden,start,einde_
- `hide_border` - Verbergt de rand van de kaart _(boolean)_ - `hide_border` - Verbergt de rand van de kaart _(boolean)_
- `theme` - Naam van het thema, kies uit [alle beschikbare thema\'s](../themes/README.md) - `theme` - Naam van het thema, kies uit [alle beschikbare thema\'s](../themes/README.md)
- `cache_seconds` - Stel de cache header handmatig in _(min: 1800, max: 86400)_ - `cache_seconds` - Stel de cache header handmatig in _(min: 14400, max: 86400)_
- `locale` - Stel taal van de kaart in _(e.g. cn, de, es, etc.)_ - `locale` - Stel taal van de kaart in _(e.g. cn, de, es, etc.)_
##### Kleurenverloop in bg_color (achtergrond kleur): ##### Kleurenverloop in bg_color (achtergrond kleur):
@@ -174,7 +191,7 @@ Je kan meerdere komma verdeelde waarden in de bg_color optie geven om een kleure
- `hide` - Verbergt specifieke talen van de kaart _(komma gescheiden waardes)_ - `hide` - Verbergt specifieke talen van de kaart _(komma gescheiden waardes)_
- `hide_title` - _(boolean)_ - `hide_title` - _(boolean)_
- `layout` - Keuze voor de twee beschikbare layouts `default` & `compact` - `layout` - Kies uit de vijf beschikbare lay-outs `normal` & `compact` & `donut` & `donut-vertical` & `pie`
- `card_width` - Stelt de breedte van de kaart handmatig in. _(nummer)_ - `card_width` - Stelt de breedte van de kaart handmatig in. _(nummer)_
- `langs_count` - Laat meer talen op de kaart zien, waarde tussen 1-10, staat standaard op to 5 _(nummer)_ - `langs_count` - Laat meer talen op de kaart zien, waarde tussen 1-10, staat standaard op to 5 _(nummer)_
- `exclude_repo` - Verbergt specifieke repositories _(komma gescheiden waardes)_ - `exclude_repo` - Verbergt specifieke repositories _(komma gescheiden waardes)_
@@ -281,14 +298,14 @@ Je kan de `&layout=compact` optie gebruiken om het kaart ontwerp aan te passen.
Verander de `?username=` waarde naar je [Wakatime](https://wakatime.com) gebruikersnaam. Verander de `?username=` waarde naar je [Wakatime](https://wakatime.com) gebruikersnaam.
```md ```md
[![willianrod's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### Demo ### Demo
[![willianrod's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -338,7 +355,7 @@ Kies uit de [standaard thema\'s](#themes)
- Wakatime kaart - Wakatime kaart
[![willianrod's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's Wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
--- ---
+32 -13
View File
@@ -49,21 +49,40 @@
<a href="/docs/readme_it.md">Italiano</a> <a href="/docs/readme_it.md">Italiano</a>
· ·
<a href="/docs/readme_kr.md">한국어</a> <a href="/docs/readme_kr.md">한국어</a>
.
<a href="/docs/readme_nl.md">Nederlands</a>
· ·
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">परियोजना मनपर्‍यो? तपाईं मद्दत गर्न सक्नुहुन्छ <a href="https://www.paypal.me/anuraghazra">यो परियोजना</a> बढ्न <p align="center">परियोजना मनपर्‍यो? तपाईं मद्दत गर्न सक्नुहुन्छ <a href="https://www.paypal.me/anuraghazra">यो परियोजना</a> बढ्न
# विशेषताहरु # विशेषताहरु <!-- omit in toc -->
- [गितहब स्टेट कार्ड](#गितहब-स्टेट-कार्ड) - [गितहब स्टेट कार्ड](#गितहब-स्टेट-कार्ड)
- [लुकाउनु होस् व्यक्तिगत स्टेट](#लुकाउनु-होस्-व्यक्तिगत-स्टेट)
- [जोड्नु होस् निजी टोटल योगदान](#जोड्नु-होस्-निजी-टोटल--योगदान)
- [देखाउनु होस् इकोन](#देखाउनु-होस्-इकोन)
- [विषयवस्तुहरू](#विषयवस्तुहरू)
- [अनुकूलन](#अनुकूलन)
- [गितहब अतिरिक्त पिन्स](#गितहब-अतिरिक्त-पिन्स) - [गितहब अतिरिक्त पिन्स](#गितहब-अतिरिक्त-पिन्स)
- [प्रयोग](#प्रयोग)
- [डेमो](#डेमो)
- [टोप भाषा कार्ड](#टोप-भाषा-कार्ड) - [टोप भाषा कार्ड](#टोप-भाषा-कार्ड)
- [वाका समय वीक स्तट्स ](#वाका-समय-वीक-स्तट्स ) - [प्रयोग](#प्रयोग-1)
- [विषयवस्तुहरू](#विषयवस्तुहरू) - [Exclude individual repositories](#exclude-individual-repositories)
- [अनुकूलन](#अनुकूलन) - [कुनै भाषा चुपौनॆ तरिका](#कुनै-भाषा-चुपौनॆ-तरिका)
- [आफैलाई तैनाथ गर्नुहोस्](#देप्लोय-आफ्नै-वेर्चेल-इन्स्तंस ) - [धेरॆ भाषाहरु हेर्नको लागि](#धेरॆ-भाषाहरु-हेर्नको-लागि)
- [कम्प्याक्ट भाषा कार्ड ळयोउत](#कम्प्याक्ट-भाषा-कार्ड-ळयोउत)
- [डेमो](#डेमो-1)
- [वाका समय वीक स्तट्स](#वाका-समय-वीक-स्तट्स)
- [डेमो](#डेमो-2)
- [सबै डेमोहरु](#सबै-डेमोहरु)
- [टिप् (रेपो कार्डलाए अलिग्न गर्ने )](#टिप्--रेपो-कार्डलाए-अलिग्न-गर्ने-)
- [देप्लोय आफ्नै वेर्चेल इन्स्तंस](#देप्लोय--आफ्नै--वेर्चेल--इन्स्तंस)
- [:sparkling\_heart: सहपोर्ट द प्रोजेक्ट](#sparkling_heart-सहपोर्ट-द-प्रोजेक्ट)
# गितहब स्टेट कार्ड # गितहब स्टेट कार्ड
@@ -138,7 +157,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_ - `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_
- `hide_border` - Hides the card's border _(boolean)_ - `hide_border` - Hides the card's border _(boolean)_
- `theme` - name of the theme, choose from [all available themes](./themes/README.md) - `theme` - name of the theme, choose from [all available themes](./themes/README.md)
- `cache_seconds` - set the cache header manually _(min: 1800, max: 86400)_ - `cache_seconds` - set the cache header manually _(min: 14400, max: 86400)_
- `locale` - set the language in the card _(e.g. cn, de, es, etc.)_ - `locale` - set the language in the card _(e.g. cn, de, es, etc.)_
##### Gradient in bg_color ##### Gradient in bg_color
@@ -170,7 +189,7 @@ You can provide multiple comma-separated values in bg_color option to render a g
- `hide` - Hide the languages specified from the card _(Comma-separated values)_ - `hide` - Hide the languages specified from the card _(Comma-separated values)_
- `hide_title` - _(boolean)_ - `hide_title` - _(boolean)_
- `layout` - Switch between two available layouts `default` & `compact` - `layout` - Switch between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. Default: `normal`.
- `card_width` - Set the card's width manually _(number)_ - `card_width` - Set the card's width manually _(number)_
- `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_ - `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_ - `exclude_repo` - Exclude specified repositories _(Comma-separated values)_
@@ -219,7 +238,7 @@ Use [show_owner](#customization) variable to include the repo's owner username
टोप भाषाकार्डले github परयोग गर्नेहरुको प्रोग्रम्मिंग भाषाहरु देखाऊने गर्दछ |. टोप भाषाकार्डले github परयोग गर्नेहरुको प्रोग्रम्मिंग भाषाहरु देखाऊने गर्दछ |.
_NOTE: टोप भाषाहरुले आफ्नो सिपलाए संकेत गरेको होईन | योचै Github Metricबाट धेरै कुन भाषा परयोग भाकोलाए संकेत गरेको हो | _NOTE: टोप भाषाहरुले आफ्नो सिपलाए संकेत गरेको होईन | योचै GitHub Metricबाट धेरै कुन भाषा परयोग भाकोलाए संकेत गरेको हो |
### प्रयोग ### प्रयोग
कोदलाए कपी- पेसेत readme मा गर्नु होला र लिंक परिवतन गर्नु होला | कोदलाए कपी- पेसेत readme मा गर्नु होला र लिंक परिवतन गर्नु होला |
@@ -275,14 +294,14 @@ You can use the `&langs_count=` option to increase or decrease the number of lan
Change the `?username=` value to your [Wakatime](https://wakatime.com) username. Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### डेमो ### डेमो
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -332,7 +351,7 @@ Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
- वक समय कार्ड - वक समय कार्ड
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -389,7 +408,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
येदि तपाइले यो प्रोजेक्ट चलाउनु बाकोक्ष बने र मलाई अझै प्रसंसा गर्ने हो बने तपाइले थुप्रै तरिका ले गर्नु सक्नु हुने छ :- येदि तपाइले यो प्रोजेक्ट चलाउनु बाकोक्ष बने र मलाई अझै प्रसंसा गर्ने हो बने तपाइले थुप्रै तरिका ले गर्नु सक्नु हुने छ :-
- यो प्रोजेक्टमा तपाइले प्रहयोग गर्दा मलाई क्रेडिट दिन सक्नु हुनेक्ष । - यो प्रोजेक्टमा तपाइले प्रहयोग गर्दा मलाई क्रेडिट दिन सक्नु हुनेक्ष ।
- तपाइले Github ReadMe Stats स्तार्रेड गर्न सक्नु हुनेक्ष :rocket: - तपाइले GitHub ReadMe Stats स्तार्रेड गर्न सक्नु हुनेक्ष :rocket:
- [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - तपाइले पेपाल बाट पनि सहयोग (डक्क्षिन) गर्न सक्नु हुनेक्ष | म ~~कोफी ~~ चिया . :tea: किन्न सक्क्षु । - [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - तपाइले पेपाल बाट पनि सहयोग (डक्क्षिन) गर्न सक्नु हुनेक्ष | म ~~कोफी ~~ चिया . :tea: किन्न सक्क्षु ।
धन्याबाद! :heart: धन्याबाद! :heart:
+26 -11
View File
@@ -53,19 +53,34 @@
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. .
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
.
<a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">Gostou do projeto? Por favor considere <a href="https://www.paypal.me/anuraghazra">fazer uma doação</a> para ajudar a melhorá-lo! <p align="center">Gostou do projeto? Por favor considere <a href="https://www.paypal.me/anuraghazra">fazer uma doação</a> para ajudar a melhorá-lo!
# Características # Características <!-- omit in toc -->
- [Cartão de estatísticas do GitHub](#cartão-de-estatísticas-do-github) - [Cartão de estatísticas do GitHub](#cartão-de-estatísticas-do-github)
- [Ocultando estatísticas específicas](#ocultando-estatísticas-específicas)
- [Adicionando contagem de contribuições privadas à contagem total de commits](#adicionando-contagem-de-contribuições-privadas-à-contagem-total-de-commits)
- [Exibindo ícones](#exibindo-ícones)
- [Temas](#temas)
- [Personalização](#personalização)
- [Pins extras do GitHub](#pins-extras-do-github) - [Pins extras do GitHub](#pins-extras-do-github)
- [Utilização](#utilização)
- [Demonstração](#demonstração)
- [Cartão de principais linguagens de programação](#cartão-de-principais-linguagens-de-programação) - [Cartão de principais linguagens de programação](#cartão-de-principais-linguagens-de-programação)
- [Utilização](#utilização-1)
- [Ocultar linguagens individualmente](#ocultar-linguagens-individualmente)
- [Layout de cartão de linguagens compacto](#layout-de-cartão-de-linguagens-compacto)
- [Demonstração](#demonstração-1)
- [Estatística semanal Wakatime](#estatística-semanal-wakatime) - [Estatística semanal Wakatime](#estatística-semanal-wakatime)
- [Temas](#temas) - [Demonstração](#demonstração-2)
- [Personalização](#personalização) - [Todas as demonstrações](#todas-as-demonstrações)
- [Faça suas próprias implantações](#implante-em-sua-própria-instância-do-vercel) - [Dica (Alinhandos os cartões de repositório)](#dica-alinhandos-os-cartões-de-repositório)
- [Implante em sua própria instância do Vercel](#implante-em-sua-própria-instância-do-vercel)
- [:sparkling\_heart: Apoie o projeto](#sparkling_heart-apoie-o-projeto)
# Cartão de estatísticas do GitHub # Cartão de estatísticas do GitHub
@@ -139,10 +154,10 @@ Personalize a aparência do seu `Stats Card` ou `Repo Card` da maneira que desej
- `bg_color` - Cor de fundo do cartão _(hex color)_ - `bg_color` - Cor de fundo do cartão _(hex color)_
- `hide_border` - Esconde a borda do cartão _(boleano)_ - `hide_border` - Esconde a borda do cartão _(boleano)_
- `theme` - Nome do tema, escolha em [todos os temas disponíveis](../themes/README.md) - `theme` - Nome do tema, escolha em [todos os temas disponíveis](../themes/README.md)
- `cache_seconds` - Defina o cabeçalho do cache manualmente _(min: 1800, max: 86400)_ - `cache_seconds` - Defina o cabeçalho do cache manualmente _(min: 14400, max: 86400)_
- `locale` - defina o idioma no cartão _(por exemplo. cn, de, es, etc.)_ - `locale` - defina o idioma no cartão _(por exemplo. cn, de, es, etc.)_
> Nota sobre o cache: Cartões de repositório tem um cache padrão de 30 minutos (1800 segundos), se o número a contagem de forks e contagem de estrelas é menor que 1 mil o padrão é 2 horas (7200). Note também que o cache é limitado a um mínimo de 30 minutos e um máximo de 24 horas. > Nota sobre o cache: Cartões de repositório tem um cache padrão de 30 minutos (1800 segundos), se o número a contagem de forks e contagem de estrelas é menor que 1 mil o padrão é 2 horas (7200 segundos). Note também que o cache é limitado a um mínimo de 30 minutos e um máximo de 24 horas.
#### Opções exclusivas do cartão de estatísticas: #### Opções exclusivas do cartão de estatísticas:
@@ -162,12 +177,12 @@ Personalize a aparência do seu `Stats Card` ou `Repo Card` da maneira que desej
- `hide` - Oculta linguagens específicas _(Valores separados por vírgulas)_ - `hide` - Oculta linguagens específicas _(Valores separados por vírgulas)_
- `hide_title` - Oculta o título _(boolean)_ - `hide_title` - Oculta o título _(boolean)_
- `layout` - Alterna entre os dois layouts disponíveis `default` & `compact` - `layout` - Alternar entre os cinco layouts disponíveis `normal` & `compact` & `donut` & `donut-vertical` & `pie`
- `card_width` - Define a largura do cartão manualmente _(number)_ - `card_width` - Define a largura do cartão manualmente _(number)_
> :warning: **Importante:** > :warning: **Importante:**
> Nomes de linguagens devem ser uma sequência escapada de URI, como específicado em [Codificação por cento](https://pt.wikipedia.org/wiki/Codificação_por_cento) > Nomes de linguagens devem ser uma sequência escapada de URI, como específicado em [Codificação por cento](https://pt.wikipedia.org/wiki/Codificação_por_cento)
> (Isso é: `c++` deve se tornar `c%2B%2B`, `jupyter notebook` deve se tornar `jupyter%20notebook`, etc.) > (Ou seja: `c++` deve se tornar `c%2B%2B`, `jupyter notebook` deve se tornar `jupyter%20notebook`, etc.)
--- ---
@@ -240,14 +255,14 @@ Utilize a opção `&layout=compact` para mudar o layout do cartão.
Altere o valor de `?username=` para o seu username do Wakatime. Altere o valor de `?username=` para o seu username do Wakatime.
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### Demonstração ### Demonstração
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
--- ---
+36 -21
View File
@@ -59,24 +59,39 @@
</p> </p>
<p align="center">Projeyi sevdiniz mi? Daha da gelişmesi için lütfen <a href="https://www.paypal.me/anuraghazra">bağış</a> yapın! <p align="center">Projeyi sevdiniz mi? Daha da gelişmesi için lütfen <a href="https://www.paypal.me/anuraghazra">bağış</a> yapın!
# Features # Features <!-- omit in toc -->
- [GitHub İstatistikler Kartı](#github-istatistikler-kartı) - [GitHub İstatistikler Kartı](#github-i̇statistikler-kartı)
- [Bazı İstatitistikleri Gizleme](#bazı-i̇statitistikleri-gizleme)
- [Özel Katkı Sayısını Toplam Commit Sayısına Ekleme](#özel-katkı-sayısını-toplam-commit-sayısına-ekleme)
- [İkonları Göstermek](#i̇konları-göstermek)
- [Temalar](#temalar)
- [Özelleştirmeler](#özelleştirmeler)
- [GitHub Ekstra Pinler](#github-ekstra-pinler) - [GitHub Ekstra Pinler](#github-ekstra-pinler)
- [Kullanım](#kullanım)
- [Demo](#demo)
- [En Çok Kullanılan Diller](#en-çok-kullanılan-diller) - [En Çok Kullanılan Diller](#en-çok-kullanılan-diller)
- [Wakatime Haftalık İstatistikler](#wakatime-haftalık-istatistikler) - [Kullanım](#kullanım-1)
- [Temalar](#temalar) - [Belirli Repoları Çıkartın](#belirli-repoları-çıkartın)
- [Özelleştirmeler](#özelleştirmeler) - [Belirli Dilleri Çıkartın](#belirli-dilleri-çıkartın)
- [Yayınlayın](#yayınlayın) - [Daha Fazla Dil Gösterin](#daha-fazla-dil-gösterin)
- [Kompakt Dil Kartı Düzeni](#kompakt-dil-kartı-düzeni)
- [Demo](#demo-1)
- [Wakatime Haftalık İstatistikler](#wakatime-haftalık-i̇statistikler)
- [Demo](#demo-2)
- [Tüm Demolar](#tüm-demolar)
- [Hızlı İpucu (Repo Kartları Hizlayın)](#hızlı-i̇pucu-repo-kartları-hizlayın)
- [Kendi Vercel Örneğinizde Yayınlayın](#kendi-vercel-örneğinizde-yayınlayın)
- [:sparkling\_heart: Projeyi Destekleyin](#sparkling_heart-projeyi-destekleyin)
# GitHub İstatistikler Kartı # GitHub İstatistikler Kartı
Alt kısımdaki kodu Kopyalayın ve yapıştırın. İşte bu kadar. Çok basit! Alt kısımdaki kodu Kopyalayın ve yapıştırın. İşte bu kadar. Çok basit!
`?username=` değerini kendi Github kullanıcı adınız ile değiştirin. `?username=` değerini kendi GitHub kullanıcı adınız ile değiştirin.
```md ```md
[![Anurag'nın Github İstatistikleri](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) [![Anurag'nın GitHub İstatistikleri](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
``` ```
_Not: Şu sıralamalar mevcut: S+ (en üst 1%), S (en üst 25%), A++ (en üst 45%), A+ (en üst 60%), and B+ (herkes). _Not: Şu sıralamalar mevcut: S+ (en üst 1%), S (en üst 25%), A++ (en üst 45%), A+ (en üst 60%), and B+ (herkes).
Buradaki değerler [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) ile hesaplanırken; commitler, katkılar, hatalar, yıldızlar, çekme istekleri, takipçiler ve sahip olunan depolar (repository) göz önünde bulundurulamaktadır. Buradaki değerler [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) ile hesaplanırken; commitler, katkılar, hatalar, yıldızlar, çekme istekleri, takipçiler ve sahip olunan depolar (repository) göz önünde bulundurulamaktadır.
@@ -143,7 +158,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
- `bg_color` - Kartın arkaplan rengi _(hex color / hex rengi)_ **ya da** gradient şeklinde _açı,başlangıç,bitiş_ - `bg_color` - Kartın arkaplan rengi _(hex color / hex rengi)_ **ya da** gradient şeklinde _açı,başlangıç,bitiş_
- `hide_border` - Kartın çerçevelerini gizler _(boolean)_ - `hide_border` - Kartın çerçevelerini gizler _(boolean)_
- `theme` - Temanın rengi [tüm temalar](./themes/README.md) - `theme` - Temanın rengi [tüm temalar](./themes/README.md)
- `cache_seconds` - Manuel olarak cache'i belirleyebilirsiniz _(en az: 1800, en fazla: 86400)_ - `cache_seconds` - Manuel olarak cache'i belirleyebilirsiniz _(en az: 14400, en fazla: 86400)_
- `locale` - Karttaki dili seçebilirsiniz _(örneğin; tr, cn, de, es, vb.)_ - `locale` - Karttaki dili seçebilirsiniz _(örneğin; tr, cn, de, es, vb.)_
##### bg_color'da Gradient ##### bg_color'da Gradient
@@ -176,7 +191,7 @@ bg_color içerisinde birden fazla rengi gradient olarak göstermek için virgül
- `hide` - Belirli bir dili listede gizler _(Virgül ile ayırılmış değerlerle)_ - `hide` - Belirli bir dili listede gizler _(Virgül ile ayırılmış değerlerle)_
- `hide_title` - _(boolean)_ - `hide_title` - _(boolean)_
- `layout` - Uygun olan iki tasarım / layout arasında değişiklik yapar `default` & `compact` - `layout` - Beş uygun tasarım / düzen arasında geçiş yapın `normal` & `compact` & `donut` & `donut-vertical` & `pie`
- `card_width` - Kartın genişliğini manuel olarak belirler _(number)_ - `card_width` - Kartın genişliğini manuel olarak belirler _(number)_
- `langs_count` - 1-10 arasında istediğiniz kadar dil gösterebilirsiniz. Varsayılan: 5 _(number)_ - `langs_count` - 1-10 arasında istediğiniz kadar dil gösterebilirsiniz. Varsayılan: 5 _(number)_
- `exclude_repo` - Belirli repoları listeden çıkartır _(Virgül ile ayırılmış değerlerle)_ - `exclude_repo` - Belirli repoları listeden çıkartır _(Virgül ile ayırılmış değerlerle)_
@@ -199,7 +214,7 @@ bg_color içerisinde birden fazla rengi gradient olarak göstermek için virgül
# GitHub Ekstra Pinler # GitHub Ekstra Pinler
Github ekstra pinler profilinize 6'dan fazla repoyu / depoyu profilinizde pinleyebilirsiniz. GitHub ekstra pinler profilinize 6'dan fazla repoyu / depoyu profilinizde pinleyebilirsiniz.
Hey! Artık 6 pin ile kısıtlı kalmayacaksınız! Hey! Artık 6 pin ile kısıtlı kalmayacaksınız!
@@ -225,7 +240,7 @@ Endpoint: `api/pin?username=mustafacagri&repo=github-readme-stats`
En çok kullanılan diller kartı kullanıcının en çok kullandığı dilleri gösterir. En çok kullanılan diller kartı kullanıcının en çok kullandığı dilleri gösterir.
_NOTE: En çok kullanılan dillerde yer alan bilgiler sizin yeteneğinizi ve benzeri şeyleri göstermek. Bu, kodlarınızda en çok kullandığınız dilleri gösteren bir Github metriğidir. Ayrıca, github-readme-stats'ın yeni özelliğidir. _NOTE: En çok kullanılan dillerde yer alan bilgiler sizin yeteneğinizi ve benzeri şeyleri göstermek. Bu, kodlarınızda en çok kullandığınız dilleri gösteren bir GitHub metriğidir. Ayrıca, github-readme-stats'ın yeni özelliğidir.
### Kullanım ### Kullanım
@@ -282,18 +297,18 @@ Endpoint: `api/top-langs?username=mustafacagri`
`?username=` değerini [Wakatime](https://wakatime.com)'daki kullanıcı adınızla değiştirin. `?username=` değerini [Wakatime](https://wakatime.com)'daki kullanıcı adınızla değiştirin.
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### Demo ### Demo
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
- Kompakt Düzen - Kompakt Düzen
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -343,7 +358,7 @@ Endpoint: `api/top-langs?username=mustafacagri`
- Wakatime kart - Wakatime kart
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
--- ---
@@ -365,7 +380,7 @@ Genellikle resimleri yan yana düzenleyemezsiniz. Bunu yapmak için şu yaklaş
#### [@codeSTACKr'ın Yayınladığı Video Eğitimine Göz Atın](https://youtu.be/n6d4KHSKqGk?t=107) #### [@codeSTACKr'ın Yayınladığı Video Eğitimine Göz Atın](https://youtu.be/n6d4KHSKqGk?t=107)
Github API saatte sadece 5.000 isteğe izin verdiği için `https://github-readme-stats.vercel.app/api` adresindeki API'm bu limite muhtemelen takılmış olabilir. Eğer projeyi kendi Vercel sunucunuzda yayınlarsanız, böyle bir sorun yaşamayabilirsiniz. Deploy butonuna tıkla ve deploy başlasın! GitHub API saatte sadece 5.000 isteğe izin verdiği için `https://github-readme-stats.vercel.app/api` adresindeki API'm bu limite muhtemelen takılmış olabilir. Eğer projeyi kendi Vercel sunucunuzda yayınlarsanız, böyle bir sorun yaşamayabilirsiniz. Deploy butonuna tıkla ve deploy başlasın!
NOT: [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) geliştirmesi sonrasında anlamadığımız bir şekilde 5.000 istek limitine takılmıyoruz :) NOT: [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) geliştirmesi sonrasında anlamadığımız bir şekilde 5.000 istek limitine takılmıyoruz :)
@@ -378,9 +393,9 @@ NOT: [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) geliştir
1. [vercel.com](https://vercel.com/) adresine gidin 1. [vercel.com](https://vercel.com/) adresine gidin
1. `Log in`'e tıklayın 1. `Log in`'e tıklayın
![](https://files.catbox.moe/tct1wg.png) ![](https://files.catbox.moe/tct1wg.png)
1. `Continue with GitHub`'e basarak Github ile giriş yapın 1. `Continue with GitHub`'e basarak GitHub ile giriş yapın
![](https://files.catbox.moe/btd78j.jpeg) ![](https://files.catbox.moe/btd78j.jpeg)
1. Github'a giriş yapın ve eğer çıkarsa tüm repolara izin verin. 1. GitHub'a giriş yapın ve eğer çıkarsa tüm repolara izin verin.
1. Bu repoyu fork'layın 1. Bu repoyu fork'layın
1. [Vercel dashboard](https://vercel.com/dashboard)'unuza geri dönün. 1. [Vercel dashboard](https://vercel.com/dashboard)'unuza geri dönün.
1. `Import Project`'i seçin. 1. `Import Project`'i seçin.
@@ -409,7 +424,7 @@ Teşekkürler! :heart:
--- ---
[![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](./powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss) [![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](../powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss)
Katkılara açığız! <3 Katkılara açığız! <3
+15
View File
@@ -0,0 +1,15 @@
import statsCard from "./api/index.js";
import repoCard from "./api/pin.js";
import langCard from "./api/top-langs.js";
import wakatimeCard from "./api/wakatime.js";
import express from "express";
import dotenv from "dotenv";
dotenv.config();
const app = express();
app.listen(process.env.port || 9000);
app.get("/", statsCard);
app.get("/pin", repoCard);
app.get("/top-langs", langCard);
app.get("/wakatime", wakatimeCard);
+2252 -1811
View File
File diff suppressed because it is too large Load Diff
+30 -13
View File
@@ -1,9 +1,23 @@
{ {
"name": "github-readme-stats", "name": "github-readme-stats",
"version": "1.0.0", "version": "1.0.0",
"description": "Dynamically generate stats for your github readmes", "description": "Dynamically generate stats for your GitHub readme",
"main": "index.js", "keywords": [
"github-readme-stats",
"readme-stats",
"cards",
"card-generator"
],
"main": "src/index.js",
"type": "module", "type": "module",
"homepage": "https://github.com/anuraghazra/github-readme-stats",
"bugs": {
"url": "https://github.com/anuraghazra/github-readme-stats/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/anuraghazra/github-readme-stats.git"
},
"scripts": { "scripts": {
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage", "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
"test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch", "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
@@ -13,8 +27,9 @@
"preview-theme": "node scripts/preview-theme", "preview-theme": "node scripts/preview-theme",
"close-stale-theme-prs": "node scripts/close-stale-theme-prs", "close-stale-theme-prs": "node scripts/close-stale-theme-prs",
"generate-langs-json": "node scripts/generate-langs-json", "generate-langs-json": "node scripts/generate-langs-json",
"format": "./node_modules/.bin/prettier --write .", "format": "prettier --write .",
"format:check": "./node_modules/.bin/prettier --check ." "format:check": "prettier --check .",
"prepare": "husky install"
}, },
"author": "Anurag Hazra", "author": "Anurag Hazra",
"license": "MIT", "license": "MIT",
@@ -24,28 +39,30 @@
"@testing-library/dom": "^8.17.1", "@testing-library/dom": "^8.17.1",
"@testing-library/jest-dom": "^5.16.5", "@testing-library/jest-dom": "^5.16.5",
"@uppercod/css-to-object": "^1.1.1", "@uppercod/css-to-object": "^1.1.1",
"axios-mock-adapter": "^1.18.1", "axios-mock-adapter": "^1.21.2",
"color-contrast-checker": "^2.1.0", "color-contrast-checker": "^2.1.0",
"hjson": "^3.2.2", "hjson": "^3.2.2",
"husky": "^4.2.5", "husky": "^8.0.0",
"jest": "^29.0.3", "jest": "^29.5.0",
"jest-environment-jsdom": "^29.0.3", "jest-environment-jsdom": "^29.5.0",
"js-yaml": "^4.1.0", "js-yaml": "^4.1.0",
"lint-staged": "^13.0.3",
"lodash.snakecase": "^4.1.1", "lodash.snakecase": "^4.1.1",
"parse-diff": "^0.7.0", "parse-diff": "^0.7.0",
"prettier": "^2.1.2" "prettier": "^2.1.2"
}, },
"dependencies": { "dependencies": {
"axios": "^0.24.0", "axios": "^1.4.0",
"dotenv": "^8.2.0", "dotenv": "^8.2.0",
"emoji-name-map": "^1.2.8", "emoji-name-map": "^1.2.8",
"github-username-regex": "^1.0.0", "github-username-regex": "^1.0.0",
"upgrade": "^1.1.0", "upgrade": "^1.1.0",
"word-wrap": "^1.2.3" "word-wrap": "^1.2.3"
}, },
"husky": { "lint-staged": {
"hooks": { "*.{js,css,md}": "prettier --write"
"pre-commit": "npm test" },
} "engines": {
"node": ">=18.0.0"
} }
} }
+451 -177
View File
@@ -7,6 +7,9 @@
<a href="https://github.com/anuraghazra/github-readme-stats/actions"> <a href="https://github.com/anuraghazra/github-readme-stats/actions">
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" /> <img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
</a> </a>
<a href="https://github.com/anuraghazra/github-readme-stats/graphs/contributors">
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/anuraghazra/github-readme-stats" />
</a>
<a href="https://codecov.io/gh/anuraghazra/github-readme-stats"> <a href="https://codecov.io/gh/anuraghazra/github-readme-stats">
<img src="https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" /> <img src="https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" />
</a> </a>
@@ -27,12 +30,14 @@
</p> </p>
<p align="center"> <p align="center">
<a href="#demo">View Demo</a> <a href="#all-demos">View Demo</a>
· ·
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Report Bug</a> <a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Report Bug</a>
· ·
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Request Feature</a> <a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Request Feature</a>
· ·
<a href="https://github.com/anuraghazra/github-readme-stats/discussions/1770">FAQ</a>
·
<a href="https://github.com/anuraghazra/github-readme-stats/discussions">Ask Question</a> <a href="https://github.com/anuraghazra/github-readme-stats/discussions">Ask Question</a>
</p> </p>
<p align="center"> <p align="center">
@@ -51,50 +56,74 @@
<a href="/docs/readme_it.md">Italiano</a> <a href="/docs/readme_it.md">Italiano</a>
· ·
<a href="/docs/readme_kr.md">한국어</a> <a href="/docs/readme_kr.md">한국어</a>
. ·
<a href="/docs/readme_nl.md">Nederlands</a> <a href="/docs/readme_nl.md">Nederlands</a>
. ·
<a href="/docs/readme_np.md">नेपाली</a> <a href="/docs/readme_np.md">नेपाली</a>
. ·
<a href="/docs/readme_tr.md">Türkçe</a> <a href="/docs/readme_tr.md">Türkçe</a>
</p> </p>
</p> </p>
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!</p>
<p>
<a href="https://indiafightscorona.giveindia.org"> <a href="https://indiafightscorona.giveindia.org">
<img src="https://d2wvdrxmr8p0wf.cloudfront.net/static/giveindia.svg" alt="Give india logo" width="200" /> <img src="https://cfstatic.give.do/logo.png" alt="Give india logo" width="200" />
</a> </a>
Are you considering supporting the project by donating? Please DON'T!! Are you considering supporting the project by donating to me? Please DO NOT!!
Instead, Help India fight the 2nd deadly wave of COVID-19. <img src="https://cfstatic.give.do/910ede2a-7892-43fe-8c8a-dea45e96d950.webp" alt="Picture of Coromandel Express train tragedy" width="35%">
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
India just suffered one of the most devastating train accident and your help will be immensely valuable for the people who were effected by this tragedy.
Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of-the-coromandel-express-train-tragedy-in-odisha-donate-now) and make a small donation to help the people in need. A small donation goes a long way. :heart:
Visit [https://indiafightscorona.giveindia.org](https://indiafightscorona.giveindia.org) and make a small donation to help us fight COVID and overcome this crisis.
A small donation goes a long way. :heart:
</p> </p>
# Features <!-- omit in toc -->
# Features
- [GitHub Stats Card](#github-stats-card) - [GitHub Stats Card](#github-stats-card)
- [Hiding individual stats](#hiding-individual-stats)
- [Showing additional individual stats](#showing-additional-individual-stats)
- [Showing icons](#showing-icons)
- [Themes](#themes)
- [Customization](#customization)
- [GitHub Extra Pins](#github-extra-pins) - [GitHub Extra Pins](#github-extra-pins)
- [Usage](#usage)
- [Demo](#demo)
- [Top Languages Card](#top-languages-card) - [Top Languages Card](#top-languages-card)
- [Wakatime Week Stats](#wakatime-week-stats) - [Usage](#usage-1)
- [Themes](#themes) - [Language stats algorithm](#language-stats-algorithm)
- [Customization](#customization) - [Exclude individual repositories](#exclude-individual-repositories)
- [Common Options](#common-options) - [Hide individual languages](#hide-individual-languages)
- [Stats Card Exclusive Options](#stats-card-exclusive-options) - [Show more languages](#show-more-languages)
- [Repo Card Exclusive Options](#repo-card-exclusive-options) - [Compact Language Card Layout](#compact-language-card-layout)
- [Language Card Exclusive Options](#language-card-exclusive-options) - [Donut Chart Language Card Layout](#donut-chart-language-card-layout)
- [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options) - [Donut Vertical Chart Language Card Layout](#donut-vertical-chart-language-card-layout)
- [Deploy Yourself](#deploy-on-your-own-vercel-instance) - [Pie Chart Language Card Layout](#pie-chart-language-card-layout)
- [Hide Progress Bars](#hide-progress-bars)
- [Demo](#demo-1)
- [Wakatime Stats Card](#wakatime-stats-card)
- [Demo](#demo-2)
- [All Demos](#all-demos)
- [Quick Tip (Align The Cards)](#quick-tip-align-the-cards)
- [Deploy on your own](#deploy-on-your-own)
- [On Vercel](#on-vercel)
- [:film\_projector: Check Out Step By Step Video Tutorial By @codeSTACKr](#film_projector-check-out-step-by-step-video-tutorial-by-codestackr)
- [On other platforms](#on-other-platforms)
- [Disable rate limit protections](#disable-rate-limit-protections)
- [Keep your fork up to date](#keep-your-fork-up-to-date)
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
# Important Notice <!-- omit in toc -->
> **Warning**
> Since the GitHub API only [allows 5k requests per hour per user account](https://docs.github.com/en/graphql/overview/resource-limitations), the public Vercel instance hosted on `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). We use caching to prevent this from happening (see https://github.com/anuraghazra/github-readme-stats#common-options). You can turn off these rate limit protections by deploying [your own Vercel instance](#disable-rate-limit-protections).
# GitHub Stats Card # GitHub Stats Card
Copy-paste this into your markdown content, and that's it. Simple! Copy-paste this into your markdown content, and that is it. Simple!
Change the `?username=` value to your GitHub username. Change the `?username=` value to your GitHub username.
@@ -102,13 +131,15 @@ Change the `?username=` value to your GitHub username.
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
``` ```
_Note: Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone). > **Warning**
The values are calculated by using the [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) using commits, contributions, issues, stars, pull requests, followers, and owned repositories. > By default, the stats card only shows statistics like stars, commits and pull requests from public repositories. To show private statistics on the stats card, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token.
The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js)._
> **Note**
> Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the [Japanese academic grading](https://wikipedia.org/wiki/Academic_grading_in_Japan) system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, issues, stars and followers), based on the cumulative distribution function of the [exponential](https://wikipedia.org/wiki/exponential_distribution) and the [log-normal](https://wikipedia.org/wiki/Log-normal_distribution) distributions. The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js). The circle around the rank shows 100 minus the global percentile.
### Hiding individual stats ### Hiding individual stats
To hide any specific stats, you can pass a query parameter `&hide=` with comma-separated values. You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values.
> Options: `&hide=stars,commits,prs,issues,contribs` > Options: `&hide=stars,commits,prs,issues,contribs`
@@ -116,21 +147,19 @@ To hide any specific stats, you can pass a query parameter `&hide=` with comma-s
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
``` ```
### Adding private contributions count to total commits count ### Showing additional individual stats
You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`. You can pass a query parameter `&show=` to show any specific additional stats with comma-separated values.
_Note: If you are deploying this project yourself, the private contributions will be counted by default. Otherwise, you need to choose to share your private contribution counts._ > Options: `&show=reviews,discussions_started,discussions_answered`
> Options: `&count_private=true`
```md ```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show=reviews)
``` ```
### Showing icons ### Showing icons
To enable icons, you can pass `show_icons=true` in the query param, like so: To enable icons, you can pass `&show_icons=true` in the query param, like so:
```md ```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
@@ -140,103 +169,195 @@ To enable icons, you can pass `show_icons=true` in the query param, like so:
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization). With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
Use `&theme=THEME_NAME` parameter like so :- Use `&theme=THEME_NAME` parameter like so :
```md ```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
``` ```
#### All inbuilt themes:- #### All inbuilt themes
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula GitHub readme stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stats Themes" width="600px"/> <img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stats Themes" width="600px"/>
You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D
#### Responsive Card Theme
[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-dark-mode-only)
[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-light-mode-only)
Since GitHub will re-upload the cards and serve them from their [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), we can not infer the browser/GitHub theme on the server side. There are, however, four methods you can use to create dynamics themes on the client side.
##### Use the transparent theme
We have included a `transparent` theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the `&theme=transparent` parameter like so:
```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent)
```
<details>
<summary>:eyes: Show example</summary>
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=transparent)
</details>
##### Add transparent alpha channel to a themes bg\_color
You can use the `bg_color` parameter to make any of [the available themes](./themes/README.md) transparent. This is done by setting the `bg_color` to a color with a transparent alpha channel (i.e. `bg_color=00000000`):
```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000)
```
<details>
<summary>:eyes: Show example</summary>
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&bg_color=00000000)
</details>
##### Use GitHub's theme context tag
You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) tags to switch the theme based on the user GitHub theme automatically. This is done by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme:
```md
[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
```
<details>
<summary>:eyes: Show example</summary>
[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
</details>
##### Use GitHub's new media feature
You can use [GitHub's new media feature](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/) in HTML to specify whether to display images for light or dark themes. This is done using the HTML `<picture>` element in combination with the `prefers-color-scheme` media feature.
```html
<picture>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
media="(prefers-color-scheme: dark)"
/>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true"
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
/>
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
</picture>
```
<details>
<summary>:eyes: Show example</summary>
<picture>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
media="(prefers-color-scheme: dark)"
/>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true"
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
/>
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
</picture>
</details>
### Customization ### Customization
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL params. You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL parameters.
#### Common Options: #### Common Options
- `title_color` - Card's title color _(hex color)_. Default: `2f80ed`. * `title_color` - Card's title color *(hex color)*. Default: `2f80ed`.
- `text_color` - Body text color _(hex color)_. Default: `434d58`. * `text_color` - Body text color *(hex color)*. Default: `434d58`.
- `icon_color` - Icons color if available _(hex color)_. Default: `4c71f2`. * `icon_color` - Icons color if available *(hex color)*. Default: `4c71f2`.
- `border_color` - Card's border color _(hex color)_. Default: `e4e2e2` (Does not apply when `hide_border` is enabled). * `border_color` - Card's border color *(hex color)*. Default: `e4e2e2` (Does not apply when `hide_border` is enabled).
- `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_. Default: `fffefe` * `bg_color` - Card's background color *(hex color)* **or** a gradient in the form of *angle,start,end*. Default: `fffefe`
- `hide_border` - Hides the card's border _(boolean)_. Default: `false` * `hide_border` - Hides the card's border *(boolean)*. Default: `false`
- `theme` - name of the theme, choose from [all available themes](./themes/README.md). Default: `default` theme. * `theme` - name of the theme, choose from [all available themes](./themes/README.md). Default: `default` theme.
- `cache_seconds` - set the cache header manually _(min: 7200, max: 86400)_. Default: `14400 seconds (4 hours)`. * `cache_seconds` - set the cache header manually *(min: 14400, max: 86400)*. Default: `14400 seconds (4 hours)`.
- `locale` - set the language in the card _(e.g. cn, de, es, etc.)_. Default: `en`. * `locale` - set the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`.
- `border_radius` - Corner rounding on the card. Default: `4.5`. * `border_radius` - Corner rounding on the card. Default: `4.5`.
> Note: The minimum of cache_seconds is currently 4 hours as a temporary fix for PATs exhaustion. > **Warning**
> We use caching to decrease the load on our servers (see <https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Our cards have a default cache of 4 hours (14400 seconds). Also, note that the cache is clamped to a minimum of 4 hours and a maximum of 24 hours.
##### Gradient in bg_color ##### Gradient in bg\_color
You can provide multiple comma-separated values in the bg_color option to render a gradient, with the following format: You can provide multiple comma-separated values in the bg\_color option to render a gradient with the following format:
``` &bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
```
> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours. #### Stats Card Exclusive Options
#### Stats Card Exclusive Options: * `hide` - Hides the [specified items](#hiding-individual-stats) from stats *(Comma-separated values)*. Default: `[] (blank array)`.
* `hide_title` - *(boolean)*. Default: `false`.
* `card_width` - Set the card's width manually *(number)*. Default: `500px (approx.)`.
* `hide_rank` - *(boolean)* hides the rank and automatically resizes the card width. Default: `false`.
* `rank_icon` - Shows alternative rank icon (i.e. `github`, `percentile`, `progress` or `default`). Default: `default`.
* `show_icons` - *(boolean)*. Default: `false`.
* `include_all_commits` - Count total commits instead of just the current year commits *(boolean)*. Default: `false`.
* `line_height` - Sets the line height between text *(number)*. Default: `25`.
* `exclude_repo` - Exclude stars from specified repositories *(Comma-separated values)*. Default: `[] (blank array)`.
* `custom_title` - Sets a custom title for the card. Default: `<username> GitHub Stats`.
* `text_bold` - Use bold text *(boolean)*. Default: `true`.
* `disable_animations` - Disables all animations in the card *(boolean)*. Default: `false`.
* `ring_color` - Color of the rank circle *(hex color)*. Defaults to the theme ring color if it exists and otherwise the title color.
* `number_format` - Switch between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`.
* `show` - Show [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started` or `discussions_answered`) *(Comma-separated values)*. Default: `[] (blank array)`.
- `hide` - Hides the [specified items](#hiding-individual-stats) from stats _(Comma-separated values)_. Default: `[] (blank array)`. > **Note**
- `hide_title` - _(boolean)_. Default: `false`. > When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
- `card_width` - Set the card's width manually _(number)_. Default: `500px (approx.)`.
- `hide_rank` - _(boolean)_ hides the rank and automatically resizes the card width. Default: `false`.
- `show_icons` - _(boolean)_. Default: `false`.
- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_. Default: `false`.
- `count_private` - Count private commits _(boolean)_. Default: `false`.
- `line_height` - Sets the line-height between text _(number)_. Default: `25`.
- `exclude_repo` - Exclude stars from specified repositories _(Comma-separated values)_. Default: `[] (blank array)`.
- `custom_title` - Sets a custom title for the card. Default: `<username> Github Stats`.
- `text_bold` - Use bold text _(boolean)_. Default: `true`.
- `disable_animations` - Disables all animations in the card _(boolean)_. Default: `false`.
> Note on `hide_rank`: #### Repo Card Exclusive Options
When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
#### Repo Card Exclusive Options: * `show_owner` - Show the repo's owner name *(boolean)*. Default: `false`.
- `show_owner` - Show the repo's owner name _(boolean)_ #### Language Card Exclusive Options
#### Language Card Exclusive Options: * `hide` - Hide the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
* `hide_title` - *(boolean)*. Default: `false`.
* `layout` - Switch between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. Default: `normal`.
* `card_width` - Set the card's width manually *(number)*. Default `300`.
* `langs_count` - Show more languages on the card, between 1-20 *(number)*. Default: `5` for `normal` and `donut`, `6` for other layouts.
* `exclude_repo` - Exclude specified repositories *(Comma-separated values)*. Default: `[] (blank array)`.
* `custom_title` - Sets a custom title for the card *(string)*. Default `Most Used Languages`.
* `disable_animations` - Disables all animations in the card *(boolean)*. Default: `false`.
* `hide_progress` - It uses the compact layout option, hides percentages, and removes the bars. Default: `false`.
* `size_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 1.
* `count_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 0.
- `hide` - Hide the languages specified from the card _(Comma-separated values)_ > **Warning**
- `hide_title` - _(boolean)_ > Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
- `layout` - Switch between two available layouts `default` & `compact`
- `card_width` - Set the card's width manually _(number)_
- `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_
- `custom_title` - Sets a custom title for the card
> :warning: **Important:**
> Language names should be uri-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use > (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically. > [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
#### Wakatime Card Exclusive Options: #### Wakatime Card Exclusive Options
- `hide` - Hide the languages specified from the card _(Comma-separated values)_ * `hide` - Hide the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
- `hide_title` - _(boolean)_ * `hide_title` - *(boolean)*. Default `false`.
- `line_height` - Sets the line-height between text _(number)_ * `line_height` - Sets the line height between text *(number)*. Default `25`.
- `hide_progress` - Hides the progress bar and percentage _(boolean)_ * `hide_progress` - Hides the progress bar and percentage *(boolean)*. Default `false`.
- `custom_title` - Sets a custom title for the card * `custom_title` - Sets a custom title for the card *(string)*. Default `Wakatime Stats`.
- `layout` - Switch between two available layouts `default` & `compact` * `layout` - Switch between two available layouts `default` & `compact`. Default `default`.
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages * `langs_count` - Limit the number of languages on the card, defaults to all reported languages *(number)*.
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) * `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) *(string)*. Default `Waka API`.
- `range` Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options.
--- ***
# GitHub Extra Pins # GitHub Extra Pins
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile. GitHub extra pins allow you to pin more than six repositories in your profile using a GitHub readme profile.
Yay! You are no longer limited to 6 pinned repositories. Yay! You are no longer limited to 6 pinned repositories.
@@ -252,17 +373,24 @@ Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
### Demo ### Demo
[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats) ![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra\&repo=github-readme-stats)
Use [show_owner](#customization) variable to include the repo's owner username Use [show\_owner](#repo-card-exclusive-options) query option to include the repo's owner username
[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&show_owner=true)](https://github.com/anuraghazra/github-readme-stats) ![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra\&repo=github-readme-stats\&show_owner=true)
# Top Languages Card # Top Languages Card
The top languages card shows a GitHub user's most frequently used top language. The top languages card shows a GitHub user's most frequently used top language.
_NOTE: Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It's a new feature of github-readme-stats._ > **Warning**
> By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token.
> **Note**
> Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats.
> **Warning**
> This card shows languages usage only inside your own non-forked repositories, not depending from who is the author of the commits. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support [this feature request](https://github.com/orgs/community/discussions/18230) created by [@rickstaa](https://github.com/rickstaa) inside GitHub Community.
### Usage ### Usage
@@ -274,12 +402,30 @@ Endpoint: `api/top-langs?username=anuraghazra`
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
``` ```
### Exclude individual repositories ### Language stats algorithm
You can use `&exclude_repo=repo1,repo2` parameter to exclude individual repositories. We use the following algorithm to calculate the languages percentages on the language card:
```js
ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight)
```
By default, only the byte count is used for determining the languages percentages shown on the language card (i.e. `size_weight=1` and `count_weight=0`). You can, however, use the `&size_weight=` and `&count_weight=` options to weight the language usage calculation. The values must be positive real numbers. [More details about the algorithm can be found here](https://github.com/anuraghazra/github-readme-stats/issues/1600#issuecomment-1046056305).
* `&size_weight=1&count_weight=0` - *(default)* Orders by byte count.
* `&size_weight=0.5&count_weight=0.5` - *(recommended)* Uses both byte and repo count for ranking
* `&size_weight=0&count_weight=1` - Orders by repo count
```md ```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5)
```
### Exclude individual repositories
You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
```md
![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io)
``` ```
### Hide individual languages ### Hide individual languages
@@ -287,7 +433,7 @@ You can use `&exclude_repo=repo1,repo2` parameter to exclude individual reposito
You can use `&hide=language1,language2` parameter to hide individual languages. You can use `&hide=language1,language2` parameter to hide individual languages.
```md ```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)
``` ```
### Show more languages ### Show more languages
@@ -295,7 +441,7 @@ You can use `&hide=language1,language2` parameter to hide individual languages.
You can use the `&langs_count=` option to increase or decrease the number of languages shown on the card. Valid values are integers between 1 and 10 (inclusive), and the default is 5. You can use the `&langs_count=` option to increase or decrease the number of languages shown on the card. Valid values are integers between 1 and 10 (inclusive), and the default is 5.
```md ```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8)
``` ```
### Compact Language Card Layout ### Compact Language Card Layout
@@ -303,96 +449,170 @@ You can use the `&langs_count=` option to increase or decrease the number of lan
You can use the `&layout=compact` option to change the card design. You can use the `&layout=compact` option to change the card design.
```md ```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)
```
### Donut Chart Language Card Layout
You can use the `&layout=donut` option to change the card design.
```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut)](https://github.com/anuraghazra/github-readme-stats)
```
### Donut Vertical Chart Language Card Layout
You can use the `&layout=donut-vertical` option to change the card design.
```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut-vertical)](https://github.com/anuraghazra/github-readme-stats)
```
### Pie Chart Language Card Layout
You can use the `&layout=pie` option to change the card design.
```md
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=pie)](https://github.com/anuraghazra/github-readme-stats)
```
### Hide Progress Bars
You can use the `&hide_progress=true` option to hide the percentages and the progress bars (layout will be automatically set to `compact`).
```md
![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true)
``` ```
### Demo ### Demo
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)
- Compact layout * Compact layout
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra\&layout=compact)
# Wakatime Week Stats * Donut Chart layout
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra\&layout=donut)](https://github.com/anuraghazra/github-readme-stats)
* Donut Vertical Chart layout
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra\&layout=donut-vertical)](https://github.com/anuraghazra/github-readme-stats)
* Pie Chart layout
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra\&layout=pie)](https://github.com/anuraghazra/github-readme-stats)
* Hidden progress bars
![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra\&hide_progress=true)
# Wakatime Stats Card
> **Warning**
> Please be aware that we currently only show data from Wakatime profiles that are public. You therefore have to make sure that **BOTH** `Display code time publicly` and `Display languages, editors, os, categories publicly` are enabled.
Change the `?username=` value to your [Wakatime](https://wakatime.com) username. Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
```md ```md
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) [![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
``` ```
> Note: Please be aware that we currently only show data from Wakatime profiles that are public.
### Demo ### Demo
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) ![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) ![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs\&hide_progress=true)
- Compact layout * Compact layout
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats) ![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs\&layout=compact)
--- ***
### All Demos # All Demos
- Default * Default
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)
- Hiding specific stats * Hiding specific stats
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,issues) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&hide=contribs,issues)
- Showing icons * Showing additional stats
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=issues&show_icons=true) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show=reviews,discussions_started,discussions_answered)
- Customize Border Color * Showing icons
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&border_color=2e4058) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&hide=issues\&show_icons=true)
- Include All Commits * Shows Github logo instead rank level
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&include_all_commits=true) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&rank_icon=github)
- Themes * Shows rank progress instead of rank level
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&rank_icon=progress)
* Shows user rank percentile instead of rank level
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&rank_icon=percentile)
* Customize Border Color
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&border_color=2e4058)
* Include All Commits
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&include_all_commits=true)
* Themes
Choose from any of the [default themes](#themes) Choose from any of the [default themes](#themes)
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=radical)
- Gradient * Gradient
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&bg_color=30,e96443,904e95&title_color=fff&text_color=fff) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra\&bg_color=30,e96443,904e95\&title_color=fff\&text_color=fff)
- Customizing stats card * Customizing stats card
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra\&show_icons=true\&title_color=fff\&icon_color=79ff97\&text_color=9f9f9f\&bg_color=151515)
- Setting card locale * Setting card locale
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&locale=es) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra\&locale=es)
- Customizing repo card * Customizing repo card
![Customized Card](https://github-readme-stats.vercel.app/api/pin?username=anuraghazra&repo=github-readme-stats&title_color=fff&icon_color=f9f9f9&text_color=9f9f9f&bg_color=151515) ![Customized Card](https://github-readme-stats.vercel.app/api/pin?username=anuraghazra\&repo=github-readme-stats\&title_color=fff\&icon_color=f9f9f9\&text_color=9f9f9f\&bg_color=151515)
- Top languages * Top languages
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)
- Wakatime card * WakaTime card
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) ![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)
--- ***
### Quick Tip (Align The Repo Cards) ## Quick Tip (Align The Cards)
You usually won't be able to layout the images side by side. To do that you can use this approach: By default, GitHub does not lay out the cards side by side. To do that, you can use this approach:
```html
<a href="https://github.com/anuraghazra/github-readme-stats">
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api?username=anuraghazra" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
</a>
```
```html ```html
<a href="https://github.com/anuraghazra/github-readme-stats"> <a href="https://github.com/anuraghazra/github-readme-stats">
@@ -403,56 +623,110 @@ You usually won't be able to layout the images side by side. To do that you can
</a> </a>
``` ```
## Deploy on your own Vercel instance <details>
<summary>:eyes: Show example</summary>
#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107) <a href="https://github.com/anuraghazra/github-readme-stats">
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api?username=anuraghazra" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
</a>
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started! ***
NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we should be able to handle more than 5k requests and have no issues with downtime :D <a href="https://github.com/anuraghazra/github-readme-stats">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
</details>
# Deploy on your own
## On Vercel
### :film\_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started!
> **Note**
> Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:.
> **Note**
> If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [Vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than `30` seconds to prevent high memory usage.
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats) [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
<details> <details>
<summary><b> Guide on setting up Vercel 🔨 </b></summary> <summary><b>:hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance</b></summary>
1. Go to [vercel.com](https://vercel.com/) 1. Go to [vercel.com](https://vercel.com/).
1. Click on `Log in` 2. Click on `Log in`.
![](https://files.catbox.moe/tct1wg.png) ![](https://files.catbox.moe/pcxk33.png)
1. Sign in with GitHub by pressing `Continue with GitHub` 3. Sign in with GitHub by pressing `Continue with GitHub`.
![](https://files.catbox.moe/btd78j.jpeg) ![](https://files.catbox.moe/b9oxey.png)
1. Sign in to GitHub and allow access to all repositories, if prompted 4. Sign in to GitHub and allow access to all repositories if prompted.
1. Fork this repo 5. Fork this repo.
1. After forking the repo, open the [`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the `maxDuration` field to `10` 6. Go back to your [Vercel dashboard](https://vercel.com/dashboard).
1. Go back to your [Vercel dashboard](https://vercel.com/dashboard) 7. To import a project, click the `Add New...` button and select the `Project` option.
1. Select `Import Project` ![](https://files.catbox.moe/3n76fh.png)
![](https://files.catbox.moe/qckos0.png) 8. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button. Alternatively, you can import a Third-Party Git Repository using the `Import Third-Party Git Repository ->` link at the bottom of the page.
1. Select `Import Git Repository`. Select root and keep everything as is. ![](https://files.catbox.moe/mg5p04.png)
![](https://files.catbox.moe/pqub9q.png) 9. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` and `user` permissions (this allows access to see private repo and user stats).
1. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats) 10. Add the PAT as an environment variable named `PAT_1` (as shown).
1. Add the PAT as an environment variable named `PAT_1` (as shown). ![](https://files.catbox.moe/0yclio.png)
![](https://files.catbox.moe/0ez4g7.png) 11. Click deploy, and you're good to go. See your domains to use the API!
1. Click deploy, and you're good to go. See your domains to use the API!
</details> </details>
## :sparkling_heart: Support the project ## On other platforms
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, > **Warning**
> This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. [#2341](https://github.com/anuraghazra/github-readme-stats/discussions/2341)). The support for this method, therefore, is limited.
<details>
<summary><b>:hammer_and_wrench: Step-by-step guide for deploying on other platforms</b></summary>
1. Fork or clone this repo as per your needs
2. Add `express` to the dependencies section of `package.json`
<https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L54-L61>
3. Run `npm i` if needed (initial setup)
4. Run `node express.js` to start the server, or set the entry point to `express.js` in `package.json` if you're deploying on a managed service
<https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L11>
5. You're done 🎉
</details>
## Disable rate limit protections
Github Readme Stats contains several Vercel environment variables that can be used to remove the rate limit protections:
* `CACHE_SECONDS`: This environment variable takes precedence over our cache minimum and maximum values and can circumvent these values for self Hosted Vercel instances.
See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance.
## Keep your fork up to date
You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHub's [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process.
# :sparkling\_heart: Support the project
I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously,
this takes time. You can use this service for free. this takes time. You can use this service for free.
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:- However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:
- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D * Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
- Starring and sharing the project :rocket: * Starring and sharing the project :rocket:
- [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: * [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
Thanks! :heart: Thanks! :heart:
--- ***
[![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](./powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss)
[![https://vercel.com?utm\_source=github\_readme\_stats\_team\&utm\_campaign=oss](./powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team\&utm_campaign=oss)
Contributions are welcome! <3 Contributions are welcome! <3
+21 -9
View File
@@ -9,19 +9,28 @@ import github from "@actions/github";
import { RequestError } from "@octokit/request-error"; import { RequestError } from "@octokit/request-error";
import { getGithubToken, getRepoInfo } from "./helpers.js"; import { getGithubToken, getRepoInfo } from "./helpers.js";
// Script parameters
const CLOSING_COMMENT = ` const CLOSING_COMMENT = `
\rThis PR has been automatically closed due to inactivity. Please feel free to reopen it if you need to continue working on it.\ \rThis theme PR has been automatically closed due to inactivity. Please reopen it if you want to continue working on it.\
\rThank you for your contributions. \rThank you for your contributions.
`; `;
const REVIEWER = "github-actions[bot]";
/**
* Retrieve the review user.
* @returns {string} review user.
*/
const getReviewer = () => {
return process.env.REVIEWER ? process.env.REVIEWER : REVIEWER;
};
/** /**
* Fetch open PRs from a given repository. * Fetch open PRs from a given repository.
* @param user The user name of the repository owner. * @param user The user name of the repository owner.
* @param repo The name of the repository. * @param repo The name of the repository.
* @param reviewer The reviewer to filter by.
* @returns The open PRs. * @returns The open PRs.
*/ */
export const fetchOpenPRs = async (octokit, user, repo) => { export const fetchOpenPRs = async (octokit, user, repo, reviewer) => {
const openPRs = []; const openPRs = [];
let hasNextPage = true; let hasNextPage = true;
let endCursor; let endCursor;
@@ -49,9 +58,9 @@ export const fetchOpenPRs = async (octokit, user, repo) => {
name name
} }
} }
reviews(first: 1, states: CHANGES_REQUESTED, author: "github-actions[bot]") { reviews(first: 100, states: CHANGES_REQUESTED, author: "${reviewer}") {
nodes { nodes {
updatedAt submittedAt
} }
} }
} }
@@ -99,11 +108,13 @@ const isStale = (pullRequest, staleDays) => {
pullRequest.commits.nodes[0].commit.pushedDate, pullRequest.commits.nodes[0].commit.pushedDate,
); );
if (pullRequest.reviews.nodes[0]) { if (pullRequest.reviews.nodes[0]) {
const lastReviewDate = new Date(pullRequest.reviews.nodes[0].updatedAt); const lastReviewDate = new Date(
pullRequest.reviews.nodes.sort((a, b) => (a < b ? 1 : -1))[0].submittedAt,
);
const lastUpdateDate = const lastUpdateDate =
lastCommitDate >= lastReviewDate ? lastCommitDate : lastReviewDate; lastCommitDate >= lastReviewDate ? lastCommitDate : lastReviewDate;
const now = new Date(); const now = new Date();
return now - lastUpdateDate > 1000 * 60 * 60 * 24 * staleDays; return (now - lastUpdateDate) / (1000 * 60 * 60 * 24) >= staleDays;
} else { } else {
return false; return false;
} }
@@ -116,14 +127,15 @@ const run = async () => {
try { try {
// Create octokit client. // Create octokit client.
const dryRun = process.env.DRY_RUN === "true" || false; const dryRun = process.env.DRY_RUN === "true" || false;
const staleDays = process.env.STALE_DAYS || 15; const staleDays = process.env.STALE_DAYS || 20;
debug("Creating octokit client..."); debug("Creating octokit client...");
const octokit = github.getOctokit(getGithubToken()); const octokit = github.getOctokit(getGithubToken());
const { owner, repo } = getRepoInfo(github.context); const { owner, repo } = getRepoInfo(github.context);
const reviewer = getReviewer();
// Retrieve all theme pull requests. // Retrieve all theme pull requests.
debug("Retrieving all theme pull requests..."); debug("Retrieving all theme pull requests...");
const prs = await fetchOpenPRs(octokit, owner, repo); const prs = await fetchOpenPRs(octokit, owner, repo, reviewer);
const themePRs = pullsWithLabel(prs, "themes"); const themePRs = pullsWithLabel(prs, "themes");
const invalidThemePRs = pullsWithLabel(themePRs, "invalid"); const invalidThemePRs = pullsWithLabel(themePRs, "invalid");
debug("Retrieving stale theme PRs..."); debug("Retrieving stale theme PRs...");
+1 -2
View File
@@ -4,7 +4,6 @@
import { getInput } from "@actions/core"; import { getInput } from "@actions/core";
// Script variables.
const OWNER = "anuraghazra"; const OWNER = "anuraghazra";
const REPO = "github-readme-stats"; const REPO = "github-readme-stats";
@@ -31,7 +30,7 @@ export const getRepoInfo = (ctx) => {
/** /**
* Retrieve github token and throw error if it is not found. * Retrieve github token and throw error if it is not found.
* *
* @returns {string} Github token. * @returns {string} GitHub token.
*/ */
export const getGithubToken = () => { export const getGithubToken = () => {
const token = getInput("github_token") || process.env.GITHUB_TOKEN; const token = getInput("github_token") || process.env.GITHUB_TOKEN;
+149 -57
View File
@@ -16,7 +16,6 @@ import { isValidHexColor } from "../src/common/utils.js";
import { themes } from "../themes/index.js"; import { themes } from "../themes/index.js";
import { getGithubToken, getRepoInfo } from "./helpers.js"; import { getGithubToken, getRepoInfo } from "./helpers.js";
// Script variables.
const COMMENTER = "github-actions[bot]"; const COMMENTER = "github-actions[bot]";
const COMMENT_TITLE = "Automated Theme Preview"; const COMMENT_TITLE = "Automated Theme Preview";
@@ -24,13 +23,16 @@ const THEME_PR_FAIL_TEXT = ":x: Theme PR does not adhere to our guidelines.";
const THEME_PR_SUCCESS_TEXT = const THEME_PR_SUCCESS_TEXT =
":heavy_check_mark: Theme PR does adhere to our guidelines."; ":heavy_check_mark: Theme PR does adhere to our guidelines.";
const FAIL_TEXT = ` const FAIL_TEXT = `
\rUnfortunately, your theme PR does not adhere to our [theme guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). Please fix the issues below, and we will review your\ \rUnfortunately, your theme PR contains an error or does not adhere to our [theme guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). Please fix the issues below, and we will review your\
\r PR again. This pull request will **automatically close in 15 days** if no changes are made. After this time, you must re-open the PR for it to be reviewed. \r PR again. This pull request will **automatically close in 20 days** if no changes are made. After this time, you must re-open the PR for it to be reviewed.
`; `;
const THEME_CONTRIB_GUIDELINESS = ` const THEME_CONTRIB_GUIDELINES = `
\rHi, thanks for the theme contribution. Please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). \rHi, thanks for the theme contribution. Please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution).
\rWe are currently only accepting color combinations from any VSCode theme or themes with good colour combinations to minimize bloating the themes collection.
\r> **Warning**
\r> Keep in mind that we already have a vast collection of different themes. To keep their number manageable, we began to add only themes supported by the community. Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935#top-themes-prs)). Remember that you can also support themes of other contributors that you liked to speed up their merge.
\r> **Note**
\r> Also, note that if this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card [customization options](https://github.com/anuraghazra/github-readme-stats#customization). \r> Also, note that if this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card [customization options](https://github.com/anuraghazra/github-readme-stats#customization).
`; `;
const COLOR_PROPS = { const COLOR_PROPS = {
@@ -44,6 +46,23 @@ const ACCEPTED_COLOR_PROPS = Object.keys(COLOR_PROPS);
const REQUIRED_COLOR_PROPS = ACCEPTED_COLOR_PROPS.slice(0, 4); const REQUIRED_COLOR_PROPS = ACCEPTED_COLOR_PROPS.slice(0, 4);
const INVALID_REVIEW_COMMENT = (commentUrl) => const INVALID_REVIEW_COMMENT = (commentUrl) =>
`Some themes are invalid. See the [Automated Theme Preview](${commentUrl}) comment above for more information.`; `Some themes are invalid. See the [Automated Theme Preview](${commentUrl}) comment above for more information.`;
var OCTOKIT;
var OWNER;
var REPO;
var PULL_REQUEST_ID;
/**
* Incorrect JSON format error.
* @extends Error
* @param {string} message Error message.
* @returns {Error} IncorrectJsonFormatError.
*/
class IncorrectJsonFormatError extends Error {
constructor(message) {
super(message);
this.name = "IncorrectJsonFormatError";
}
}
/** /**
* Retrieve PR number from the event payload. * Retrieve PR number from the event payload.
@@ -93,7 +112,7 @@ const isPreviewComment = (inputs, comment) => {
* @param {number} issueNumber Issue number. * @param {number} issueNumber Issue number.
* @param {string} repo Repository name. * @param {string} repo Repository name.
* @param {string} owner Owner of the repository. * @param {string} owner Owner of the repository.
* @returns {Object} The Github comment object. * @returns {Object} The GitHub comment object.
*/ */
const findComment = async (octokit, issueNumber, owner, repo, commenter) => { const findComment = async (octokit, issueNumber, owner, repo, commenter) => {
const parameters = { const parameters = {
@@ -127,15 +146,36 @@ const findComment = async (octokit, issueNumber, owner, repo, commenter) => {
* Create or update the preview comment. * Create or update the preview comment.
* *
* @param {Object} octokit Octokit instance. * @param {Object} octokit Octokit instance.
* @param {Object} props Comment properties. * @param {number} issueNumber Issue number.
* @param {Object} repo Repository name.
* @param {Object} owner Owner of the repository.
* @param {number} commentId Comment ID.
* @param {string} body Comment body.
* @return {string} The comment URL. * @return {string} The comment URL.
*/ */
const upsertComment = async (octokit, props) => { const upsertComment = async (
octokit,
issueNumber,
repo,
owner,
commentId,
body,
) => {
let resp; let resp;
if (props.comment_id !== undefined) { if (commentId !== undefined) {
resp = await octokit.issues.updateComment(props); resp = await octokit.issues.updateComment({
owner,
repo,
comment_id: commentId,
body,
});
} else { } else {
resp = await octokit.issues.createComment(props); resp = await octokit.issues.createComment({
owner,
repo,
issue_number: issueNumber,
body,
});
} }
return resp.data.html_url; return resp.data.html_url;
}; };
@@ -270,22 +310,38 @@ const parseJSON = (json) => {
if (typeof parsedJson === "object") { if (typeof parsedJson === "object") {
return parsedJson; return parsedJson;
} else { } else {
throw new Error("PR diff is not a valid theme JSON object."); throw new IncorrectJsonFormatError(
"PR diff is not a valid theme JSON object.",
);
} }
} catch (error) { } catch (error) {
let parsedJson = json // Remove trailing commas (if any).
let parsedJson = json.replace(/(,\s*})/g, "}");
// Remove JS comments (if any).
parsedJson = parsedJson.replace(/\/\/[A-z\s]*\s/g, "");
// Fix incorrect open bracket (if any).
const splitJson = parsedJson
.split(/([\s\r\s]*}[\s\r\s]*,[\s\r\s]*)(?=[\w"-]+:)/) .split(/([\s\r\s]*}[\s\r\s]*,[\s\r\s]*)(?=[\w"-]+:)/)
.filter((x) => typeof x !== "string" || !!x.trim()); .filter((x) => typeof x !== "string" || !!x.trim()); // Split json into array of strings and objects.
if (parsedJson[0].replace(/\s+/g, "") === "},") { if (splitJson[0].replace(/\s+/g, "") === "},") {
parsedJson[0] = "},"; splitJson[0] = "},";
if (!/\s*}\s*,?\s*$/.test(parsedJson[1])) { if (!/\s*}\s*,?\s*$/.test(splitJson[1])) {
parsedJson.push(parsedJson.shift()); splitJson.push(splitJson.shift());
} else { } else {
parsedJson.shift(); splitJson.shift();
} }
return Hjson.parse(parsedJson.join("")); parsedJson = splitJson.join("");
} else { }
throw error;
// Try to parse the fixed json.
try {
return Hjson.parse(parsedJson);
} catch (error) {
throw new IncorrectJsonFormatError(
`Theme JSON file could not be parsed: ${error.message}`,
);
} }
} }
}; };
@@ -299,53 +355,64 @@ const themeNameAlreadyExists = (name) => {
return themes[name] !== undefined; return themes[name] !== undefined;
}; };
const DRY_RUN = process.env.DRY_RUN === "true" || false;
/** /**
* Main function. * Main function.
*/ */
export const run = async (prNumber) => { export const run = async () => {
try { try {
const dryRun = process.env.DRY_RUN === "true" || false;
debug("Retrieve action information from context..."); debug("Retrieve action information from context...");
debug(`Context: ${inspect(github.context)}`); debug(`Context: ${inspect(github.context)}`);
let commentBody = ` let commentBody = `
\r# ${COMMENT_TITLE} \r# ${COMMENT_TITLE}
\r${THEME_CONTRIB_GUIDELINESS} \r${THEME_CONTRIB_GUIDELINES}
`; `;
const ccc = new ColorContrastChecker(); const ccc = new ColorContrastChecker();
const octokit = github.getOctokit(getGithubToken()); OCTOKIT = github.getOctokit(getGithubToken());
const pullRequestId = prNumber ? prNumber : getPrNumber(); PULL_REQUEST_ID = getPrNumber();
const commenter = getCommenter();
const { owner, repo } = getRepoInfo(github.context); const { owner, repo } = getRepoInfo(github.context);
debug(`Owner: ${owner}`); OWNER = owner;
debug(`Repo: ${repo}`); REPO = repo;
const commenter = getCommenter();
PULL_REQUEST_ID = getPrNumber();
debug(`Owner: ${OWNER}`);
debug(`Repo: ${REPO}`);
debug(`Commenter: ${commenter}`); debug(`Commenter: ${commenter}`);
// Retrieve the PR diff and preview-theme comment. // Retrieve the PR diff and preview-theme comment.
debug("Retrieve PR diff..."); debug("Retrieve PR diff...");
const res = await octokit.pulls.get({ const res = await OCTOKIT.pulls.get({
owner, owner: OWNER,
repo, repo: REPO,
pull_number: pullRequestId, pull_number: PULL_REQUEST_ID,
mediaType: { mediaType: {
format: "diff", format: "diff",
}, },
}); });
debug("Retrieve preview-theme comment..."); debug("Retrieve preview-theme comment...");
const comment = await findComment( const comment = await findComment(
octokit, OCTOKIT,
pullRequestId, PULL_REQUEST_ID,
owner, OWNER,
repo, REPO,
commenter, commenter,
); );
// Retrieve theme changes from the PR diff. // Retrieve theme changes from the PR diff.
debug("Retrieve themes..."); debug("Retrieve themes...");
const diff = parse(res.data); const diff = parse(res.data);
// Retrieve all theme changes from the PR diff and convert to JSON.
debug("Retrieve theme changes...");
const content = diff const content = diff
.find((file) => file.to === "themes/index.js") .find((file) => file.to === "themes/index.js")
.chunks[0].changes.filter((c) => c.type === "add") .chunks.map((chunk) =>
.map((c) => c.content.replace("+", "")) chunk.changes
.filter((c) => c.type === "add")
.map((c) => c.content.replace("+", ""))
.join(""),
)
.join(""); .join("");
const themeObject = parseJSON(content); const themeObject = parseJSON(content);
if ( if (
@@ -514,14 +581,15 @@ export const run = async (prNumber) => {
// Create or update theme-preview comment. // Create or update theme-preview comment.
debug("Create or update theme-preview comment..."); debug("Create or update theme-preview comment...");
let comment_url; let comment_url;
if (!dryRun) { if (!DRY_RUN) {
comment_url = await upsertComment(octokit, { comment_url = await upsertComment(
comment_id: comment?.id, OCTOKIT,
issue_number: pullRequestId, PULL_REQUEST_ID,
owner, REPO,
repo, OWNER,
body: commentBody, comment?.id,
}); commentBody,
);
} else { } else {
info(`DRY_RUN: Comment body: ${commentBody}`); info(`DRY_RUN: Comment body: ${commentBody}`);
comment_url = ""; comment_url = "";
@@ -536,20 +604,20 @@ export const run = async (prNumber) => {
const reviewReason = themesValid const reviewReason = themesValid
? undefined ? undefined
: INVALID_REVIEW_COMMENT(comment_url); : INVALID_REVIEW_COMMENT(comment_url);
if (!dryRun) { if (!DRY_RUN) {
await addReview( await addReview(
octokit, OCTOKIT,
pullRequestId, PULL_REQUEST_ID,
owner, OWNER,
repo, REPO,
reviewState, reviewState,
reviewReason, reviewReason,
); );
await addRemoveLabel( await addRemoveLabel(
octokit, OCTOKIT,
pullRequestId, PULL_REQUEST_ID,
owner, OWNER,
repo, REPO,
"invalid", "invalid",
!themesValid, !themesValid,
); );
@@ -558,6 +626,30 @@ export const run = async (prNumber) => {
info(`DRY_RUN: Review reason: ${reviewReason}`); info(`DRY_RUN: Review reason: ${reviewReason}`);
} }
} catch (error) { } catch (error) {
debug("Set review state to `REQUEST_CHANGES` and add `invalid` label...");
if (!DRY_RUN) {
await addReview(
OCTOKIT,
PULL_REQUEST_ID,
OWNER,
REPO,
"REQUEST_CHANGES",
"**Something went wrong in the theme preview action:** `" +
error.message +
"`",
);
await addRemoveLabel(
OCTOKIT,
PULL_REQUEST_ID,
OWNER,
REPO,
"invalid",
true,
);
} else {
info(`DRY_RUN: Review state: REQUEST_CHANGES`);
info(`DRY_RUN: Review reason: ${error.message}`);
}
setFailed(error.message); setFailed(error.message);
} }
}; };
+3 -2
View File
@@ -5,10 +5,11 @@ set -e
export BRANCH_NAME=updated-theme-readme export BRANCH_NAME=updated-theme-readme
git --version git --version
git config --global user.email "no-reply@githubreadmestats.com" git config --global user.email "no-reply@githubreadmestats.com"
git config --global user.name "Github Readme Stats Bot" git config --global user.name "GitHub Readme Stats Bot"
git config --global --add safe.directory ${GITHUB_WORKSPACE}
git branch -d $BRANCH_NAME || true git branch -d $BRANCH_NAME || true
git checkout -b $BRANCH_NAME git checkout -b $BRANCH_NAME
git add --all git add --all
git commit --message "docs(theme): Auto update theme readme" || exit 0 git commit --no-verify --message "docs(theme): Auto update theme readme"
git remote add origin-$BRANCH_NAME https://${PERSONAL_TOKEN}@github.com/${GH_REPO}.git git remote add origin-$BRANCH_NAME https://${PERSONAL_TOKEN}@github.com/${GH_REPO}.git
git push --force --quiet --set-upstream origin-$BRANCH_NAME $BRANCH_NAME git push --force --quiet --set-upstream origin-$BRANCH_NAME $BRANCH_NAME
+53 -63
View File
@@ -1,77 +1,67 @@
// https://stackoverflow.com/a/5263759/10629172 function exponential_cdf(x) {
function normalcdf(mean, sigma, to) { return 1 - 2 ** -x;
var z = (to - mean) / Math.sqrt(2 * sigma * sigma);
var t = 1 / (1 + 0.3275911 * Math.abs(z));
var a1 = 0.254829592;
var a2 = -0.284496736;
var a3 = 1.421413741;
var a4 = -1.453152027;
var a5 = 1.061405429;
var erf =
1 - ((((a5 * t + a4) * t + a3) * t + a2) * t + a1) * t * Math.exp(-z * z);
var sign = 1;
if (z < 0) {
sign = -1;
}
return (1 / 2) * (1 + sign * erf);
} }
function log_normal_cdf(x) {
// approximation
return x / (1 + x);
}
/**
* Calculates the users rank.
*
* @param {object} params Parameters on which the user's rank depends.
* @param {boolean} params.all_commits Whether `include_all_commits` was used.
* @param {number} params.commits Number of commits.
* @param {number} params.prs The number of pull requests.
* @param {number} params.issues The number of issues.
* @param {number} params.repos Total number of repos.
* @param {number} params.stars The number of stars.
* @param {number} params.followers The number of followers.
* @returns {{level: string, percentile: number}}} The users rank.
*/
function calculateRank({ function calculateRank({
totalRepos, all_commits,
totalCommits, commits,
contributions,
followers,
prs, prs,
issues, issues,
stargazers, repos, // unused
stars,
followers,
}) { }) {
const COMMITS_OFFSET = 1.65; const COMMITS_MEDIAN = all_commits ? 1000 : 250,
const CONTRIBS_OFFSET = 1.65; COMMITS_WEIGHT = 2;
const ISSUES_OFFSET = 1; const PRS_MEDIAN = 50,
const STARS_OFFSET = 0.75; PRS_WEIGHT = 3;
const PRS_OFFSET = 0.5; const ISSUES_MEDIAN = 25,
const FOLLOWERS_OFFSET = 0.45; ISSUES_WEIGHT = 1;
const REPO_OFFSET = 1; const STARS_MEDIAN = 50,
STARS_WEIGHT = 4;
const FOLLOWERS_MEDIAN = 10,
FOLLOWERS_WEIGHT = 1;
const ALL_OFFSETS = const TOTAL_WEIGHT =
CONTRIBS_OFFSET + COMMITS_WEIGHT +
ISSUES_OFFSET + PRS_WEIGHT +
STARS_OFFSET + ISSUES_WEIGHT +
PRS_OFFSET + STARS_WEIGHT +
FOLLOWERS_OFFSET + FOLLOWERS_WEIGHT;
REPO_OFFSET;
const RANK_S_VALUE = 1; const THRESHOLDS = [1, 12.5, 25, 37.5, 50, 62.5, 75, 87.5, 100];
const RANK_DOUBLE_A_VALUE = 25; const LEVELS = ["S", "A+", "A", "A-", "B+", "B", "B-", "C+", "C"];
const RANK_A2_VALUE = 45;
const RANK_A3_VALUE = 60;
const RANK_B_VALUE = 100;
const TOTAL_VALUES = const rank =
RANK_S_VALUE + RANK_A2_VALUE + RANK_A3_VALUE + RANK_B_VALUE; 1 -
(COMMITS_WEIGHT * exponential_cdf(commits / COMMITS_MEDIAN) +
PRS_WEIGHT * exponential_cdf(prs / PRS_MEDIAN) +
ISSUES_WEIGHT * exponential_cdf(issues / ISSUES_MEDIAN) +
STARS_WEIGHT * log_normal_cdf(stars / STARS_MEDIAN) +
FOLLOWERS_WEIGHT * log_normal_cdf(followers / FOLLOWERS_MEDIAN)) /
TOTAL_WEIGHT;
// prettier-ignore const level = LEVELS[THRESHOLDS.findIndex((t) => rank * 100 <= t)];
const score = (
totalCommits * COMMITS_OFFSET +
contributions * CONTRIBS_OFFSET +
issues * ISSUES_OFFSET +
stargazers * STARS_OFFSET +
prs * PRS_OFFSET +
followers * FOLLOWERS_OFFSET +
totalRepos * REPO_OFFSET
) / 100;
const normalizedScore = normalcdf(score, TOTAL_VALUES, ALL_OFFSETS) * 100; return { level: level, percentile: rank * 100 };
const level = (() => {
if (normalizedScore < RANK_S_VALUE) return "S+";
if (normalizedScore < RANK_DOUBLE_A_VALUE) return "S";
if (normalizedScore < RANK_A2_VALUE) return "A++";
if (normalizedScore < RANK_A3_VALUE) return "A+";
return "B+";
})();
return { level, score: normalizedScore };
} }
export { calculateRank }; export { calculateRank };
+4
View File
@@ -0,0 +1,4 @@
export { renderRepoCard } from "./repo-card.js";
export { renderStatsCard } from "./stats-card.js";
export { renderTopLanguages } from "./top-languages-card.js";
export { renderWakatimeCard } from "./wakatime-card.js";
+25 -10
View File
@@ -14,9 +14,11 @@ import {
import { repoCardLocales } from "../translations.js"; import { repoCardLocales } from "../translations.js";
/** /**
* @param {string} label * Retrieves the repository description and wraps it to fit the card width.
* @param {string} textColor *
* @returns {string} * @param {string} label The repository description.
* @param {string} textColor The color of the text.
* @returns {string} Wrapped repo description SVG object.
*/ */
const getBadgeSVG = (label, textColor) => ` const getBadgeSVG = (label, textColor) => `
<g data-testid="badge" class="badge" transform="translate(320, -18)"> <g data-testid="badge" class="badge" transform="translate(320, -18)">
@@ -34,9 +36,11 @@ const getBadgeSVG = (label, textColor) => `
`; `;
/** /**
* @param {string} langName * Creates a node to display the primary programming language of the repository.
* @param {string} langColor *
* @returns {string} * @param {string} langName Language name.
* @param {string} langColor Language color.
* @returns {string} Language display SVG object.
*/ */
const createLanguageNode = (langName, langColor) => { const createLanguageNode = (langName, langColor) => {
return ` return `
@@ -48,6 +52,15 @@ const createLanguageNode = (langName, langColor) => {
}; };
const ICON_SIZE = 16; const ICON_SIZE = 16;
/**
* Creates an icon with label to display repository stats like forks, stars, etc.
*
* @param {string} icon The icon to display.
* @param {number|string} label The label to display.
* @param {string} testid The testid to assign to the label.
* @returns {string} Icon with label SVG object.
*/
const iconWithLabel = (icon, label, testid) => { const iconWithLabel = (icon, label, testid) => {
if (label <= 0) return ""; if (label <= 0) return "";
const iconSvg = ` const iconSvg = `
@@ -67,9 +80,11 @@ const iconWithLabel = (icon, label, testid) => {
}; };
/** /**
* @param {import('../fetchers/types').RepositoryData} repo * Renders repository card details.
* @param {Partial<import("./types").RepoCardOptions>} options *
* @returns {string} * @param {import('../fetchers/types').RepositoryData} repo Repository data.
* @param {Partial<import("./types").RepoCardOptions>} options Card options.
* @returns {string} Repository card SVG object.
*/ */
const renderRepoCard = (repo, options = {}) => { const renderRepoCard = (repo, options = {}) => {
const { const {
@@ -88,7 +103,7 @@ const renderRepoCard = (repo, options = {}) => {
icon_color, icon_color,
text_color, text_color,
bg_color, bg_color,
show_owner, show_owner = false,
theme = "default_repocard", theme = "default_repocard",
border_radius, border_radius,
border_color, border_color,
+129 -67
View File
@@ -1,7 +1,7 @@
// @ts-check // @ts-check
import { Card } from "../common/Card.js"; import { Card } from "../common/Card.js";
import { I18n } from "../common/I18n.js"; import { I18n } from "../common/I18n.js";
import { icons } from "../common/icons.js"; import { icons, rankIcon } from "../common/icons.js";
import { import {
clampValue, clampValue,
flexLayout, flexLayout,
@@ -12,6 +12,26 @@ import {
import { getStyles } from "../getStyles.js"; import { getStyles } from "../getStyles.js";
import { statCardLocales } from "../translations.js"; import { statCardLocales } from "../translations.js";
const CARD_MIN_WIDTH = 287;
const CARD_DEFAULT_WIDTH = 287;
const RANK_CARD_MIN_WIDTH = 420;
const RANK_CARD_DEFAULT_WIDTH = 450;
/**
* Create a stats card text item.
*
* @param {object} createTextNodeParams Object that contains the createTextNode parameters.
* @param {string} createTextNodeParams.icon The icon to display.
* @param {string} createTextNodeParams.label The label to display.
* @param {number} createTextNodeParams.value The value to display.
* @param {string} createTextNodeParams.id The id of the stat.
* @param {number} createTextNodeParams.index The index of the stat.
* @param {boolean} createTextNodeParams.showIcons Whether to show icons.
* @param {number} createTextNodeParams.shiftValuePos Number of pixels the value has to be shifted to the right.
* @param {boolean} createTextNodeParams.bold Whether to bold the label.
* @param {string} createTextNodeParams.number_format The format of numbers on card.
* @returns
*/
const createTextNode = ({ const createTextNode = ({
icon, icon,
label, label,
@@ -21,8 +41,10 @@ const createTextNode = ({
showIcons, showIcons,
shiftValuePos, shiftValuePos,
bold, bold,
number_format,
}) => { }) => {
const kValue = kFormatter(value); const kValue =
number_format.toLowerCase() === "long" ? value : kFormatter(value);
const staggerDelay = (index + 3) * 150; const staggerDelay = (index + 3) * 150;
const labelOffset = showIcons ? `x="25"` : ""; const labelOffset = showIcons ? `x="25"` : "";
@@ -50,17 +72,22 @@ const createTextNode = ({
}; };
/** /**
* @param {Partial<import('../fetchers/types').StatsData>} stats * Renders the stats card.
* @param {Partial<import("./types").StatCardOptions>} options *
* @returns {string} * @param {Partial<import('../fetchers/types').StatsData>} stats The stats data.
* @param {Partial<import("./types").StatCardOptions>} options The card options.
* @returns {string} The stats card SVG object.
*/ */
const renderStatsCard = (stats = {}, options = { hide: [] }) => { const renderStatsCard = (stats = {}, options = {}) => {
const { const {
name, name,
totalStars, totalStars,
totalCommits, totalCommits,
totalIssues, totalIssues,
totalPRs, totalPRs,
totalReviews,
totalDiscussionsStarted,
totalDiscussionsAnswered,
contributedTo, contributedTo,
rank, rank,
} = stats; } = stats;
@@ -74,6 +101,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
include_all_commits = false, include_all_commits = false,
line_height = 25, line_height = 25,
title_color, title_color,
ring_color,
icon_color, icon_color,
text_color, text_color,
text_bold = true, text_bold = true,
@@ -82,20 +110,24 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
custom_title, custom_title,
border_radius, border_radius,
border_color, border_color,
number_format = "short",
locale, locale,
disable_animations = false, disable_animations = false,
rank_icon = "default",
show = [],
} = options; } = options;
const lheight = parseInt(String(line_height), 10); const lheight = parseInt(String(line_height), 10);
// returns theme based colors with proper overrides and defaults // returns theme based colors with proper overrides and defaults
const { titleColor, textColor, iconColor, bgColor, borderColor } = const { titleColor, iconColor, textColor, bgColor, borderColor, ringColor } =
getCardColors({ getCardColors({
title_color, title_color,
icon_color,
text_color, text_color,
icon_color,
bg_color, bg_color,
border_color, border_color,
ring_color,
theme, theme,
}); });
@@ -108,39 +140,67 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
}); });
// Meta data for creating text nodes with createTextNode function // Meta data for creating text nodes with createTextNode function
const STATS = { const STATS = {};
stars: {
icon: icons.star, STATS.stars = {
label: i18n.t("statcard.totalstars"), icon: icons.star,
value: totalStars, label: i18n.t("statcard.totalstars"),
id: "stars", value: totalStars,
}, id: "stars",
commits: { };
icon: icons.commits, STATS.commits = {
label: `${i18n.t("statcard.commits")}${ icon: icons.commits,
include_all_commits ? "" : ` (${new Date().getFullYear()})` label: `${i18n.t("statcard.commits")}${
}`, include_all_commits ? "" : ` (${new Date().getFullYear()})`
value: totalCommits, }`,
id: "commits", value: totalCommits,
}, id: "commits",
prs: { };
icon: icons.prs, STATS.prs = {
label: i18n.t("statcard.prs"), icon: icons.prs,
value: totalPRs, label: i18n.t("statcard.prs"),
id: "prs", value: totalPRs,
}, id: "prs",
issues: { };
icon: icons.issues,
label: i18n.t("statcard.issues"), if (show.includes("reviews")) {
value: totalIssues, STATS.reviews = {
id: "issues", icon: icons.reviews,
}, label: i18n.t("statcard.reviews"),
contribs: { value: totalReviews,
icon: icons.contribs, id: "reviews",
label: i18n.t("statcard.contribs"), };
value: contributedTo, }
id: "contribs",
}, STATS.issues = {
icon: icons.issues,
label: i18n.t("statcard.issues"),
value: totalIssues,
id: "issues",
};
if (show.includes("discussions_started")) {
STATS.discussions_started = {
icon: icons.discussions_started,
label: i18n.t("statcard.discussions-started"),
value: totalDiscussionsStarted,
id: "discussions_started",
};
}
if (show.includes("discussions_answered")) {
STATS.discussions_answered = {
icon: icons.discussions_answered,
label: i18n.t("statcard.discussions-answered"),
value: totalDiscussionsAnswered,
id: "discussions_answered",
};
}
STATS.contribs = {
icon: icons.contribs,
label: i18n.t("statcard.contribs"),
value: contributedTo,
id: "contribs",
}; };
const longLocales = [ const longLocales = [
@@ -155,8 +215,9 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
"pl", "pl",
"de", "de",
"nl", "nl",
"zh-tw",
]; ];
const isLongLocale = longLocales.includes(locale) === true; const isLongLocale = longLocales.includes(locale);
// filter out hidden stats defined by user & create the text nodes // filter out hidden stats defined by user & create the text nodes
const statItems = Object.keys(STATS) const statItems = Object.keys(STATS)
@@ -167,9 +228,9 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
...STATS[key], ...STATS[key],
index, index,
showIcons: show_icons, showIcons: show_icons,
shiftValuePos: shiftValuePos: 79.01 + (isLongLocale ? 50 : 0),
(!include_all_commits ? 50 : 35) + (isLongLocale ? 50 : 0),
bold: text_bold, bold: text_bold,
number_format,
}), }),
); );
@@ -180,11 +241,11 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
hide_rank ? 0 : 150, hide_rank ? 0 : 150,
); );
// the better user's score the the rank will be closer to zero so // the lower the user's percentile the better
// subtracting 100 to get the progress in 100% const progress = 100 - rank.percentile;
const progress = 100 - rank.score;
const cssStyles = getStyles({ const cssStyles = getStyles({
titleColor, titleColor,
ringColor,
textColor, textColor,
iconColor, iconColor,
show_icons, show_icons,
@@ -200,11 +261,17 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
When hide_rank=false, the minimum card_width is 340 px + the icon width (if show_icons=true). When hide_rank=false, the minimum card_width is 340 px + the icon width (if show_icons=true).
Numbers are picked by looking at existing dimensions on production. Numbers are picked by looking at existing dimensions on production.
*/ */
const iconWidth = show_icons ? 16 : 0; const iconWidth = show_icons ? 16 + /* padding */ 1 : 0;
const minCardWidth = hide_rank const minCardWidth =
? clampValue(50 /* padding */ + calculateTextWidth() * 2, 270, Infinity) (hide_rank
: 340 + iconWidth; ? clampValue(
const defaultCardWidth = hide_rank ? 270 : 495; 50 /* padding */ + calculateTextWidth() * 2,
CARD_MIN_WIDTH,
Infinity,
)
: RANK_CARD_MIN_WIDTH) + iconWidth;
const defaultCardWidth =
(hide_rank ? CARD_DEFAULT_WIDTH : RANK_CARD_DEFAULT_WIDTH) + iconWidth;
let width = isNaN(card_width) ? defaultCardWidth : card_width; let width = isNaN(card_width) ? defaultCardWidth : card_width;
if (width < minCardWidth) { if (width < minCardWidth) {
width = minCardWidth; width = minCardWidth;
@@ -233,18 +300,21 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
/** /**
* Calculates the right rank circle translation values such that the rank circle * Calculates the right rank circle translation values such that the rank circle
* keeps respecting the padding. * keeps respecting the following padding:
* *
* width > 450: The default left padding of 50 px will be used. * width > RANK_CARD_DEFAULT_WIDTH: The default right padding of 70 px will be used.
* width < 450: The left and right padding will shrink equally. * width < RANK_CARD_DEFAULT_WIDTH: The left and right padding will be enlarged
* equally from a certain minimum at RANK_CARD_MIN_WIDTH.
* *
* @returns {number} - Rank circle translation value. * @returns {number} - Rank circle translation value.
*/ */
const calculateRankXTranslation = () => { const calculateRankXTranslation = () => {
if (width < 450) { const minXTranslation = RANK_CARD_MIN_WIDTH + iconWidth - 70;
return width - 95 + (45 * (450 - 340)) / 110; if (width > RANK_CARD_DEFAULT_WIDTH) {
const xMaxExpansion = minXTranslation + (450 - minCardWidth) / 2;
return xMaxExpansion + width - RANK_CARD_DEFAULT_WIDTH;
} else { } else {
return width - 95; return minXTranslation + (width - minCardWidth) / 2;
} }
}; };
@@ -258,15 +328,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
<circle class="rank-circle-rim" cx="-10" cy="8" r="40" /> <circle class="rank-circle-rim" cx="-10" cy="8" r="40" />
<circle class="rank-circle" cx="-10" cy="8" r="40" /> <circle class="rank-circle" cx="-10" cy="8" r="40" />
<g class="rank-text"> <g class="rank-text">
<text ${rankIcon(rank_icon, rank?.level, rank?.percentile)}
x="-5"
y="3"
alignment-baseline="central"
dominant-baseline="central"
text-anchor="middle"
>
${rank.level}
</text>
</g> </g>
</g>`; </g>`;
+661 -102
View File
@@ -13,17 +13,27 @@ import {
import { langCardLocales } from "../translations.js"; import { langCardLocales } from "../translations.js";
const DEFAULT_CARD_WIDTH = 300; const DEFAULT_CARD_WIDTH = 300;
const MIN_CARD_WIDTH = 230; const MIN_CARD_WIDTH = 280;
const DEFAULT_LANGS_COUNT = 5;
const DEFAULT_LANG_COLOR = "#858585"; const DEFAULT_LANG_COLOR = "#858585";
const CARD_PADDING = 25; const CARD_PADDING = 25;
const COMPACT_LAYOUT_BASE_HEIGHT = 90;
const MAXIMUM_LANGS_COUNT = 20;
const NORMAL_LAYOUT_DEFAULT_LANGS_COUNT = 5;
const COMPACT_LAYOUT_DEFAULT_LANGS_COUNT = 6;
const DONUT_LAYOUT_DEFAULT_LANGS_COUNT = 5;
const PIE_LAYOUT_DEFAULT_LANGS_COUNT = 6;
const DONUT_VERTICAL_LAYOUT_DEFAULT_LANGS_COUNT = 6;
/** /**
* @typedef {import("../fetchers/types").Lang} Lang * @typedef {import("../fetchers/types").Lang} Lang
*/ */
/** /**
* @param {Lang[]} arr * Retrieves the programming language whose name is the longest.
*
* @param {Lang[]} arr Array of programming languages.
* @returns {Object} Longest programming language object.
*/ */
const getLongestLang = (arr) => const getLongestLang = (arr) =>
arr.reduce( arr.reduce(
@@ -33,53 +43,226 @@ const getLongestLang = (arr) =>
); );
/** /**
* @param {{ * Convert degrees to radians.
* width: number, *
* color: string, * @param {number} angleInDegrees Angle in degrees.
* name: string, * @returns Angle in radians.
* progress: string
* }} props
*/ */
const createProgressTextNode = ({ width, color, name, progress }) => { const degreesToRadians = (angleInDegrees) => angleInDegrees * (Math.PI / 180.0);
/**
* Convert radians to degrees.
*
* @param {number} angleInRadians Angle in radians.
* @returns Angle in degrees.
*/
const radiansToDegrees = (angleInRadians) => angleInRadians / (Math.PI / 180.0);
/**
* Convert polar coordinates to cartesian coordinates.
*
* @param {number} centerX Center x coordinate.
* @param {number} centerY Center y coordinate.
* @param {number} radius Radius of the circle.
* @param {number} angleInDegrees Angle in degrees.
* @returns {{x: number, y: number}} Cartesian coordinates.
*/
const polarToCartesian = (centerX, centerY, radius, angleInDegrees) => {
const rads = degreesToRadians(angleInDegrees);
return {
x: centerX + radius * Math.cos(rads),
y: centerY + radius * Math.sin(rads),
};
};
/**
* Convert cartesian coordinates to polar coordinates.
*
* @param {number} centerX Center x coordinate.
* @param {number} centerY Center y coordinate.
* @param {number} x Point x coordinate.
* @param {number} y Point y coordinate.
* @returns {{radius: number, angleInDegrees: number}} Polar coordinates.
*/
const cartesianToPolar = (centerX, centerY, x, y) => {
const radius = Math.sqrt(Math.pow(x - centerX, 2) + Math.pow(y - centerY, 2));
let angleInDegrees = radiansToDegrees(Math.atan2(y - centerY, x - centerX));
if (angleInDegrees < 0) angleInDegrees += 360;
return { radius, angleInDegrees };
};
/**
* Calculates length of circle.
*
* @param {number} radius Radius of the circle.
* @returns {number} The length of the circle.
*/
const getCircleLength = (radius) => {
return 2 * Math.PI * radius;
};
/**
* Calculates height for the compact layout.
*
* @param {number} totalLangs Total number of languages.
* @returns {number} Card height.
*/
const calculateCompactLayoutHeight = (totalLangs) => {
return COMPACT_LAYOUT_BASE_HEIGHT + Math.round(totalLangs / 2) * 25;
};
/**
* Calculates height for the normal layout.
*
* @param {number} totalLangs Total number of languages.
* @returns {number} Card height.
*/
const calculateNormalLayoutHeight = (totalLangs) => {
return 45 + (totalLangs + 1) * 40;
};
/**
* Calculates height for the donut layout.
*
* @param {number} totalLangs Total number of languages.
* @returns {number} Card height.
*/
const calculateDonutLayoutHeight = (totalLangs) => {
return 215 + Math.max(totalLangs - 5, 0) * 32;
};
/**
* Calculates height for the donut vertical layout.
*
* @param {number} totalLangs Total number of languages.
* @returns {number} Card height.
*/
const calculateDonutVerticalLayoutHeight = (totalLangs) => {
return 300 + Math.round(totalLangs / 2) * 25;
};
/**
* Calculates height for the pie layout.
*
* @param {number} totalLangs Total number of languages.
* @returns {number} Card height.
*/
const calculatePieLayoutHeight = (totalLangs) => {
return 300 + Math.round(totalLangs / 2) * 25;
};
/**
* Calculates the center translation needed to keep the donut chart centred.
* @param {number} totalLangs Total number of languages.
* @returns {number} Donut center translation.
*/
const donutCenterTranslation = (totalLangs) => {
return -45 + Math.max(totalLangs - 5, 0) * 16;
};
/**
* Trim top languages to lang_count while also hiding certain languages.
*
* @param {Record<string, Lang>} topLangs Top languages.
* @param {number} langs_count Number of languages to show.
* @param {string[]=} hide Languages to hide.
* @returns {{ langs: Lang[], totalLanguageSize: number }} Trimmed top languages and total size.
*/
const trimTopLanguages = (topLangs, langs_count, hide) => {
let langs = Object.values(topLangs);
let langsToHide = {};
let langsCount = clampValue(langs_count, 1, MAXIMUM_LANGS_COUNT);
// populate langsToHide map for quick lookup
// while filtering out
if (hide) {
hide.forEach((langName) => {
langsToHide[lowercaseTrim(langName)] = true;
});
}
// filter out languages to be hidden
langs = langs
.sort((a, b) => b.size - a.size)
.filter((lang) => {
return !langsToHide[lowercaseTrim(lang.name)];
})
.slice(0, langsCount);
const totalLanguageSize = langs.reduce((acc, curr) => acc + curr.size, 0);
return { langs, totalLanguageSize };
};
/**
* Create progress bar text item for a programming language.
*
* @param {object} props Function properties.
* @param {number} props.width The card width
* @param {string} props.color Color of the programming language.
* @param {string} props.name Name of the programming language.
* @param {string} props.progress Usage of the programming language in percentage.
* @param {number} props.index Index of the programming language.
* @returns {string} Programming language SVG node.
*/
const createProgressTextNode = ({ width, color, name, progress, index }) => {
const staggerDelay = (index + 3) * 150;
const paddingRight = 95; const paddingRight = 95;
const progressTextX = width - paddingRight + 10; const progressTextX = width - paddingRight + 10;
const progressWidth = width - paddingRight; const progressWidth = width - paddingRight;
return ` return `
<text data-testid="lang-name" x="2" y="15" class="lang-name">${name}</text> <g class="stagger" style="animation-delay: ${staggerDelay}ms">
<text x="${progressTextX}" y="34" class="lang-name">${progress}%</text> <text data-testid="lang-name" x="2" y="15" class="lang-name">${name}</text>
${createProgressNode({ <text x="${progressTextX}" y="34" class="lang-name">${progress}%</text>
x: 0, ${createProgressNode({
y: 25, x: 0,
color, y: 25,
width: progressWidth, color,
progress, width: progressWidth,
progressBarBackgroundColor: "#ddd", progress,
})} progressBarBackgroundColor: "#ddd",
delay: staggerDelay + 300,
})}
</g>
`; `;
}; };
/** /**
* @param {{ lang: Lang, totalSize: number }} props * Creates compact text item for a programming language.
*
* @param {object} props Function properties.
* @param {Lang} props.lang Programming language object.
* @param {number} props.totalSize Total size of all languages.
* @param {boolean} props.hideProgress Whether to hide percentage.
* @param {number} props.index Index of the programming language.
* @returns {string} Compact layout programming language SVG node.
*/ */
const createCompactLangNode = ({ lang, totalSize }) => { const createCompactLangNode = ({ lang, totalSize, hideProgress, index }) => {
const percentage = ((lang.size / totalSize) * 100).toFixed(2); const percentage = ((lang.size / totalSize) * 100).toFixed(2);
const staggerDelay = (index + 3) * 150;
const color = lang.color || "#858585"; const color = lang.color || "#858585";
return ` return `
<g> <g class="stagger" style="animation-delay: ${staggerDelay}ms">
<circle cx="5" cy="6" r="5" fill="${color}" /> <circle cx="5" cy="6" r="5" fill="${color}" />
<text data-testid="lang-name" x="15" y="10" class='lang-name'> <text data-testid="lang-name" x="15" y="10" class='lang-name'>
${lang.name} ${percentage}% ${lang.name} ${hideProgress ? "" : percentage + "%"}
</text> </text>
</g> </g>
`; `;
}; };
/** /**
* @param {{ langs: Lang[], totalSize: number }} props * Create compact languages text items for all programming languages.
*
* @param {object} props Function properties.
* @param {Lang[]} props.langs Array of programming languages.
* @param {number} props.totalSize Total size of all languages.
* @param {boolean} props.hideProgress Whether to hide percentage.
* @returns {string} Programming languages SVG node.
*/ */
const createLanguageTextNode = ({ langs, totalSize }) => { const createLanguageTextNode = ({ langs, totalSize, hideProgress }) => {
const longestLang = getLongestLang(langs); const longestLang = getLongestLang(langs);
const chunked = chunkArray(langs, langs.length / 2); const chunked = chunkArray(langs, langs.length / 2);
const layouts = chunked.map((array) => { const layouts = chunked.map((array) => {
@@ -88,7 +271,7 @@ const createLanguageTextNode = ({ langs, totalSize }) => {
createCompactLangNode({ createCompactLangNode({
lang, lang,
totalSize, totalSize,
// @ts-ignore hideProgress,
index, index,
}), }),
); );
@@ -109,19 +292,45 @@ const createLanguageTextNode = ({ langs, totalSize }) => {
}; };
/** /**
* @param {Lang[]} langs * Create donut languages text items for all programming languages.
* @param {number} width *
* @param {number} totalLanguageSize * @param {object} props Function properties.
* @returns {string} * @param {Lang[]} props.langs Array of programming languages.
* @param {number} props.totalSize Total size of all languages.
* @returns {string} Donut layout programming language SVG node.
*/
const createDonutLanguagesNode = ({ langs, totalSize }) => {
return flexLayout({
items: langs.map((lang, index) => {
return createCompactLangNode({
lang,
totalSize,
hideProgress: false,
index,
});
}),
gap: 32,
direction: "column",
}).join("");
};
/**
* Renders the default language card layout.
*
* @param {Lang[]} langs Array of programming languages.
* @param {number} width Card width.
* @param {number} totalLanguageSize Total size of all languages.
* @returns {string} Normal layout card SVG object.
*/ */
const renderNormalLayout = (langs, width, totalLanguageSize) => { const renderNormalLayout = (langs, width, totalLanguageSize) => {
return flexLayout({ return flexLayout({
items: langs.map((lang) => { items: langs.map((lang, index) => {
return createProgressTextNode({ return createProgressTextNode({
width: width, width,
name: lang.name, name: lang.name,
color: lang.color || DEFAULT_LANG_COLOR, color: lang.color || DEFAULT_LANG_COLOR,
progress: ((lang.size / totalLanguageSize) * 100).toFixed(2), progress: ((lang.size / totalLanguageSize) * 100).toFixed(2),
index,
}); });
}), }),
gap: 40, gap: 40,
@@ -130,12 +339,15 @@ const renderNormalLayout = (langs, width, totalLanguageSize) => {
}; };
/** /**
* @param {Lang[]} langs * Renders the compact language card layout.
* @param {number} width *
* @param {number} totalLanguageSize * @param {Lang[]} langs Array of programming languages.
* @returns {string} * @param {number} width Card width.
* @param {number} totalLanguageSize Total size of all languages.
* @param {boolean} hideProgress Whether to hide progress bar.
* @returns {string} Compact layout card SVG object.
*/ */
const renderCompactLayout = (langs, width, totalLanguageSize) => { const renderCompactLayout = (langs, width, totalLanguageSize, hideProgress) => {
const paddingRight = 50; const paddingRight = 50;
const offsetWidth = width - paddingRight; const offsetWidth = width - paddingRight;
// progressOffset holds the previous language's width and used to offset the next language // progressOffset holds the previous language's width and used to offset the next language
@@ -166,89 +378,353 @@ const renderCompactLayout = (langs, width, totalLanguageSize) => {
.join(""); .join("");
return ` return `
<mask id="rect-mask"> ${
<rect x="0" y="0" width="${offsetWidth}" height="8" fill="white" rx="5" /> !hideProgress
? `
<mask id="rect-mask">
<rect x="0" y="0" width="${offsetWidth}" height="8" fill="white" rx="5"/>
</mask> </mask>
${compactProgressBar} ${compactProgressBar}
`
<g transform="translate(0, 25)"> : ""
}
<g transform="translate(0, ${hideProgress ? "0" : "25"})">
${createLanguageTextNode({ ${createLanguageTextNode({
langs, langs,
totalSize: totalLanguageSize, totalSize: totalLanguageSize,
hideProgress: hideProgress,
})} })}
</g> </g>
`; `;
}; };
/** /**
* @param {number} totalLangs * Renders donut vertical layout to display user's most frequently used programming languages.
* @returns {number}
*/
const calculateCompactLayoutHeight = (totalLangs) => {
return 90 + Math.round(totalLangs / 2) * 25;
};
/**
* @param {number} totalLangs
* @returns {number}
*/
const calculateNormalLayoutHeight = (totalLangs) => {
return 45 + (totalLangs + 1) * 40;
};
/**
* *
* @param {Record<string, Lang>} topLangs * @param {Lang[]} langs Array of programming languages.
* @param {string[]} hide * @param {number} totalLanguageSize Total size of all languages.
* @param {string} langs_count * @returns {string} Compact layout card SVG object.
*/ */
const useLanguages = (topLangs, hide, langs_count) => { const renderDonutVerticalLayout = (langs, totalLanguageSize) => {
let langs = Object.values(topLangs); // Donut vertical chart radius and total length
let langsToHide = {}; const radius = 80;
let langsCount = clampValue(parseInt(langs_count), 1, 10); const totalCircleLength = getCircleLength(radius);
// populate langsToHide map for quick lookup // SVG circles
// while filtering out let circles = [];
if (hide) {
hide.forEach((langName) => { // Start indent for donut vertical chart parts
langsToHide[lowercaseTrim(langName)] = true; let indent = 0;
});
// Start delay coefficient for donut vertical chart parts
let startDelayCoefficient = 1;
// Generate each donut vertical chart part
for (const lang of langs) {
const percentage = (lang.size / totalLanguageSize) * 100;
const circleLength = totalCircleLength * (percentage / 100);
const delay = startDelayCoefficient * 100;
circles.push(`
<g class="stagger" style="animation-delay: ${delay}ms">
<circle
cx="150"
cy="100"
r="${radius}"
fill="transparent"
stroke="${lang.color}"
stroke-width="25"
stroke-dasharray="${totalCircleLength}"
stroke-dashoffset="${indent}"
size="${percentage}"
data-testid="lang-donut"
/>
</g>
`);
// Update the indent for the next part
indent += circleLength;
// Update the start delay coefficient for the next part
startDelayCoefficient += 1;
} }
// filter out languages to be hidden return `
langs = langs <svg data-testid="lang-items">
.sort((a, b) => b.size - a.size) <g transform="translate(0, 0)">
.filter((lang) => { <svg data-testid="donut">
return !langsToHide[lowercaseTrim(lang.name)]; ${circles.join("")}
}) </svg>
.slice(0, langsCount); </g>
<g transform="translate(0, 220)">
const totalLanguageSize = langs.reduce((acc, curr) => acc + curr.size, 0); <svg data-testid="lang-names" x="${CARD_PADDING}">
${createLanguageTextNode({
return { langs, totalLanguageSize }; langs,
totalSize: totalLanguageSize,
hideProgress: false,
})}
</svg>
</g>
</svg>
`;
}; };
/** /**
* @param {import('../fetchers/types').TopLangData} topLangs * Renders pie layout to display user's most frequently used programming languages.
* @param {Partial<import("./types").TopLangOptions>} options *
* @returns {string} * @param {Lang[]} langs Array of programming languages.
* @param {number} totalLanguageSize Total size of all languages.
* @returns {string} Compact layout card SVG object.
*/
const renderPieLayout = (langs, totalLanguageSize) => {
// Pie chart radius and center coordinates
const radius = 90;
const centerX = 150;
const centerY = 100;
// Start angle for the pie chart parts
let startAngle = 0;
// Start delay coefficient for the pie chart parts
let startDelayCoefficient = 1;
// SVG paths
const paths = [];
// Generate each pie chart part
for (const lang of langs) {
if (langs.length === 1) {
paths.push(`
<circle
cx="${centerX}"
cy="${centerY}"
r="${radius}"
stroke="none"
fill="${lang.color}"
data-testid="lang-pie"
size="100"
/>
`);
break;
}
const langSizePart = lang.size / totalLanguageSize;
const percentage = langSizePart * 100;
// Calculate the angle for the current part
const angle = langSizePart * 360;
// Calculate the end angle
const endAngle = startAngle + angle;
// Calculate the coordinates of the start and end points of the arc
const startPoint = polarToCartesian(centerX, centerY, radius, startAngle);
const endPoint = polarToCartesian(centerX, centerY, radius, endAngle);
// Determine the large arc flag based on the angle
const largeArcFlag = angle > 180 ? 1 : 0;
// Calculate delay
const delay = startDelayCoefficient * 100;
// SVG arc markup
paths.push(`
<g class="stagger" style="animation-delay: ${delay}ms">
<path
data-testid="lang-pie"
size="${percentage}"
d="M ${centerX} ${centerY} L ${startPoint.x} ${startPoint.y} A ${radius} ${radius} 0 ${largeArcFlag} 1 ${endPoint.x} ${endPoint.y} Z"
fill="${lang.color}"
/>
</g>
`);
// Update the start angle for the next part
startAngle = endAngle;
// Update the start delay coefficient for the next part
startDelayCoefficient += 1;
}
return `
<svg data-testid="lang-items">
<g transform="translate(0, 0)">
<svg data-testid="pie">
${paths.join("")}
</svg>
</g>
<g transform="translate(0, 220)">
<svg data-testid="lang-names" x="${CARD_PADDING}">
${createLanguageTextNode({
langs,
totalSize: totalLanguageSize,
hideProgress: false,
})}
</svg>
</g>
</svg>
`;
};
/**
* Creates the SVG paths for the language donut chart.
*
* @param {number} cx Donut center x-position.
* @param {number} cy Donut center y-position.
* @param {number} radius Donut arc Radius.
* @param {number[]} percentages Array with donut section percentages.
* @returns {{d: string, percent: number}[]} Array of svg path elements
*/
const createDonutPaths = (cx, cy, radius, percentages) => {
const paths = [];
let startAngle = 0;
let endAngle = 0;
const totalPercent = percentages.reduce((acc, curr) => acc + curr, 0);
for (let i = 0; i < percentages.length; i++) {
const tmpPath = {};
let percent = parseFloat(
((percentages[i] / totalPercent) * 100).toFixed(2),
);
endAngle = 3.6 * percent + startAngle;
const startPoint = polarToCartesian(cx, cy, radius, endAngle - 90); // rotate donut 90 degrees counter-clockwise.
const endPoint = polarToCartesian(cx, cy, radius, startAngle - 90); // rotate donut 90 degrees counter-clockwise.
const largeArc = endAngle - startAngle <= 180 ? 0 : 1;
tmpPath.percent = percent;
tmpPath.d = `M ${startPoint.x} ${startPoint.y} A ${radius} ${radius} 0 ${largeArc} 0 ${endPoint.x} ${endPoint.y}`;
paths.push(tmpPath);
startAngle = endAngle;
}
return paths;
};
/**
* Renders the donut language card layout.
*
* @param {Lang[]} langs Array of programming languages.
* @param {number} width Card width.
* @param {number} totalLanguageSize Total size of all languages.
* @returns {string} Donut layout card SVG object.
*/
const renderDonutLayout = (langs, width, totalLanguageSize) => {
const centerX = width / 3;
const centerY = width / 3;
const radius = centerX - 60;
const strokeWidth = 12;
const colors = langs.map((lang) => lang.color);
const langsPercents = langs.map((lang) =>
parseFloat(((lang.size / totalLanguageSize) * 100).toFixed(2)),
);
const langPaths = createDonutPaths(centerX, centerY, radius, langsPercents);
const donutPaths =
langs.length === 1
? `<circle cx="${centerX}" cy="${centerY}" r="${radius}" stroke="${colors[0]}" fill="none" stroke-width="${strokeWidth}" data-testid="lang-donut" size="100"/>`
: langPaths
.map((section, index) => {
const staggerDelay = (index + 3) * 100;
const delay = staggerDelay + 300;
const output = `
<g class="stagger" style="animation-delay: ${delay}ms">
<path
data-testid="lang-donut"
size="${section.percent}"
d="${section.d}"
stroke="${colors[index]}"
fill="none"
stroke-width="${strokeWidth}">
</path>
</g>
`;
return output;
})
.join("");
const donut = `<svg width="${width}" height="${width}">${donutPaths}</svg>`;
return `
<g transform="translate(0, 0)">
<g transform="translate(0, 0)">
${createDonutLanguagesNode({ langs, totalSize: totalLanguageSize })}
</g>
<g transform="translate(125, ${donutCenterTranslation(langs.length)})">
${donut}
</g>
</g>
`;
};
/**
* Creates the no languages data SVG node.
*
* @param {object} props Object with function properties.
* @param {string} props.color No languages data text color.
* @param {string} props.text No languages data translated text.
* @param {import("./types").TopLangOptions["layout"] | undefined} props.layout Card layout.
* @return {string} No languages data SVG node string.
*/
const noLanguagesDataNode = ({ color, text, layout }) => {
return `
<text x="${
layout === "pie" || layout === "donut-vertical" ? CARD_PADDING : 0
}" y="11" class="stat bold" fill="${color}">${text}</text>
`;
};
/**
* Get default languages count for provided card layout.
*
* @param {object} props Function properties.
* @param {import("./types").TopLangOptions["layout"]=} props.layout Input layout string.
* @param {boolean=} props.hide_progress Input hide_progress parameter value.
* @return {number} Default languages count for input layout.
*/
const getDefaultLanguagesCountByLayout = ({ layout, hide_progress }) => {
if (layout === "compact" || hide_progress === true) {
return COMPACT_LAYOUT_DEFAULT_LANGS_COUNT;
} else if (layout === "donut") {
return DONUT_LAYOUT_DEFAULT_LANGS_COUNT;
} else if (layout === "donut-vertical") {
return DONUT_VERTICAL_LAYOUT_DEFAULT_LANGS_COUNT;
} else if (layout === "pie") {
return PIE_LAYOUT_DEFAULT_LANGS_COUNT;
} else {
return NORMAL_LAYOUT_DEFAULT_LANGS_COUNT;
}
};
/**
* Renders card that display user's most frequently used programming languages.
*
* @param {import('../fetchers/types').TopLangData} topLangs User's most frequently used programming languages.
* @param {Partial<import("./types").TopLangOptions>} options Card options.
* @returns {string} Language card SVG object.
*/ */
const renderTopLanguages = (topLangs, options = {}) => { const renderTopLanguages = (topLangs, options = {}) => {
const { const {
hide_title, hide_title = false,
hide_border, hide_border,
card_width, card_width,
title_color, title_color,
text_color, text_color,
bg_color, bg_color,
hide, hide,
hide_progress,
theme, theme,
layout, layout,
custom_title, custom_title,
locale, locale,
langs_count = DEFAULT_LANGS_COUNT, langs_count = getDefaultLanguagesCountByLayout({ layout, hide_progress }),
border_radius, border_radius,
border_color, border_color,
disable_animations,
} = options; } = options;
const i18n = new I18n({ const i18n = new I18n({
@@ -256,10 +732,10 @@ const renderTopLanguages = (topLangs, options = {}) => {
translations: langCardLocales, translations: langCardLocales,
}); });
const { langs, totalLanguageSize } = useLanguages( const { langs, totalLanguageSize } = trimTopLanguages(
topLangs, topLangs,
langs_count,
hide, hide,
String(langs_count),
); );
let width = isNaN(card_width) let width = isNaN(card_width)
@@ -269,16 +745,6 @@ const renderTopLanguages = (topLangs, options = {}) => {
: card_width; : card_width;
let height = calculateNormalLayoutHeight(langs.length); let height = calculateNormalLayoutHeight(langs.length);
let finalLayout = "";
if (layout === "compact") {
width = width + 50; // padding
height = calculateCompactLayoutHeight(langs.length);
finalLayout = renderCompactLayout(langs, width, totalLanguageSize);
} else {
finalLayout = renderNormalLayout(langs, width, totalLanguageSize);
}
// returns theme based colors with proper overrides and defaults // returns theme based colors with proper overrides and defaults
const colors = getCardColors({ const colors = getCardColors({
title_color, title_color,
@@ -288,6 +754,38 @@ const renderTopLanguages = (topLangs, options = {}) => {
theme, theme,
}); });
let finalLayout = "";
if (langs.length === 0) {
height = COMPACT_LAYOUT_BASE_HEIGHT;
finalLayout = noLanguagesDataNode({
color: colors.textColor,
text: i18n.t("langcard.nodata"),
layout,
});
} else if (layout === "pie") {
height = calculatePieLayoutHeight(langs.length);
finalLayout = renderPieLayout(langs, totalLanguageSize);
} else if (layout === "donut-vertical") {
height = calculateDonutVerticalLayoutHeight(langs.length);
finalLayout = renderDonutVerticalLayout(langs, totalLanguageSize);
} else if (layout === "compact" || hide_progress == true) {
height =
calculateCompactLayoutHeight(langs.length) + (hide_progress ? -25 : 0);
finalLayout = renderCompactLayout(
langs,
width,
totalLanguageSize,
hide_progress,
);
} else if (layout === "donut") {
height = calculateDonutLayoutHeight(langs.length);
width = width + 50; // padding
finalLayout = renderDonutLayout(langs, width, totalLanguageSize);
} else {
finalLayout = renderNormalLayout(langs, width, totalLanguageSize);
}
const card = new Card({ const card = new Card({
customTitle: custom_title, customTitle: custom_title,
defaultTitle: i18n.t("langcard.title"), defaultTitle: i18n.t("langcard.title"),
@@ -297,13 +795,57 @@ const renderTopLanguages = (topLangs, options = {}) => {
colors, colors,
}); });
card.disableAnimations(); if (disable_animations) card.disableAnimations();
card.setHideBorder(hide_border); card.setHideBorder(hide_border);
card.setHideTitle(hide_title); card.setHideTitle(hide_title);
card.setCSS( card.setCSS(
`.lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${colors.textColor} }`, `
@keyframes slideInAnimation {
from {
width: 0;
}
to {
width: calc(100%-100px);
}
}
@keyframes growWidthAnimation {
from {
width: 0;
}
to {
width: 100%;
}
}
.stat {
font: 600 14px 'Segoe UI', Ubuntu, "Helvetica Neue", Sans-Serif; fill: ${colors.textColor};
}
@supports(-moz-appearance: auto) {
/* Selector detects Firefox */
.stat { font-size:12px; }
}
.bold { font-weight: 700 }
.lang-name {
font: 400 11px "Segoe UI", Ubuntu, Sans-Serif;
fill: ${colors.textColor};
}
.stagger {
opacity: 0;
animation: fadeInAnimation 0.3s ease-in-out forwards;
}
#rect-mask rect{
animation: slideInAnimation 1s ease-in-out forwards;
}
.lang-progress{
animation: growWidthAnimation 0.6s ease-in-out forwards;
}
`,
); );
if (layout === "pie" || layout === "donut-vertical") {
return card.render(finalLayout);
}
return card.render(` return card.render(`
<svg data-testid="lang-items" x="${CARD_PADDING}"> <svg data-testid="lang-items" x="${CARD_PADDING}">
${finalLayout} ${finalLayout}
@@ -311,4 +853,21 @@ const renderTopLanguages = (topLangs, options = {}) => {
`); `);
}; };
export { renderTopLanguages, MIN_CARD_WIDTH }; export {
getLongestLang,
degreesToRadians,
radiansToDegrees,
polarToCartesian,
cartesianToPolar,
getCircleLength,
calculateCompactLayoutHeight,
calculateNormalLayoutHeight,
calculateDonutLayoutHeight,
calculateDonutVerticalLayoutHeight,
calculatePieLayoutHeight,
donutCenterTranslation,
trimTopLanguages,
renderTopLanguages,
MIN_CARD_WIDTH,
getDefaultLanguagesCountByLayout,
};
+9 -1
View File
@@ -1,4 +1,5 @@
type ThemeNames = keyof typeof import("../../themes/index.js"); type ThemeNames = keyof typeof import("../../themes/index.js");
type RankIcon = "default" | "github" | "percentile" | "progress";
export type CommonOptions = { export type CommonOptions = {
title_color: string; title_color: string;
@@ -22,6 +23,11 @@ export type StatCardOptions = CommonOptions & {
line_height: number | string; line_height: number | string;
custom_title: string; custom_title: string;
disable_animations: boolean; disable_animations: boolean;
number_format: string;
ring_color: string;
text_bold: boolean;
rank_icon: RankIcon;
show: string[];
}; };
export type RepoCardOptions = CommonOptions & { export type RepoCardOptions = CommonOptions & {
@@ -34,9 +40,11 @@ export type TopLangOptions = CommonOptions & {
hide_border: boolean; hide_border: boolean;
card_width: number; card_width: number;
hide: string[]; hide: string[];
layout: "compact" | "normal"; layout: "compact" | "normal" | "donut" | "donut-vertical" | "pie";
custom_title: string; custom_title: string;
langs_count: number; langs_count: number;
disable_animations: boolean;
hide_progress: boolean;
}; };
type WakaTimeOptions = CommonOptions & { type WakaTimeOptions = CommonOptions & {
+110 -47
View File
@@ -23,7 +23,12 @@ const require = createRequire(import.meta.url);
const languageColors = require("../common/languageColors.json"); // now works const languageColors = require("../common/languageColors.json"); // now works
/** /**
* @param {{color: string, text: string}} param0 * Creates the no coding activity SVG node.
*
* @param {object} props The function properties.
* @param {string} props.color No coding activity text color.
* @param {string} props.text No coding activity translated text.
* @return {string} No coding activity SVG node string.
*/ */
const noCodingActivityNode = ({ color, text }) => { const noCodingActivityNode = ({ color, text }) => {
return ` return `
@@ -32,13 +37,13 @@ const noCodingActivityNode = ({ color, text }) => {
}; };
/** /**
* Create compact WakaTime layout.
* *
* @param {{ * @param {Object} args The function arguments.
* lang: import("../fetchers/types").WakaTimeLang, * @param {import("../fetchers/types").WakaTimeLang} args.lang The languages array.
* totalSize: number, * @param {number} args.totalSize The total size of the languages.
* x: number, * @param {number} args.x The x position of the language node.
* y: number * @param {number} args.y The y position of the language node.
* }} props
*/ */
const createCompactLangNode = ({ lang, totalSize, x, y }) => { const createCompactLangNode = ({ lang, totalSize, x, y }) => {
const color = languageColors[lang.name] || "#858585"; const color = languageColors[lang.name] || "#858585";
@@ -54,12 +59,13 @@ const createCompactLangNode = ({ lang, totalSize, x, y }) => {
}; };
/** /**
* @param {{ * Create WakaTime language text node item.
* langs: import("../fetchers/types").WakaTimeLang[], *
* totalSize: number, * @param {Object} args The function arguments.
* x: number, * @param {import("../fetchers/types").WakaTimeLang[]} args.langs The language objects.
* y: number * @param {number} args.totalSize The total size of the languages.
* }} props * @param {number} args.x The x position of the language node.
* @param {number} args.y The y position of the language node.
*/ */
const createLanguageTextNode = ({ langs, totalSize, x, y }) => { const createLanguageTextNode = ({ langs, totalSize, x, y }) => {
return langs.map((lang, index) => { return langs.map((lang, index) => {
@@ -81,17 +87,17 @@ const createLanguageTextNode = ({ langs, totalSize, x, y }) => {
}; };
/** /**
* Create WakaTime text item.
* *
* @param {{ * @param {Object} args The function arguments.
* id: string; * @param {string} args.id The id of the text node item.
* label: string; * @param {string} args.label The label of the text node item.
* value: string; * @param {string} args.value The value of the text node item.
* index: number; * @param {number} args.index The index of the text node item.
* percent: number; * @param {string} args.percent Percentage of the text node item.
* hideProgress: boolean; * @param {boolean} args.hideProgress Whether to hide the progress bar.
* progressBarColor: string; * @param {string} args.progressBarColor The color of the progress bar.
* progressBarBackgroundColor: string * @param {string} args.progressBarBackgroundColor The color of the progress bar background.
* }} props
*/ */
const createTextNode = ({ const createTextNode = ({
id, id,
@@ -116,6 +122,7 @@ const createTextNode = ({
// @ts-ignore // @ts-ignore
name: label, name: label,
progressBarBackgroundColor, progressBarBackgroundColor,
delay: staggerDelay + 300,
}); });
return ` return `
@@ -132,11 +139,13 @@ const createTextNode = ({
}; };
/** /**
* @param {import("../fetchers/types").WakaTimeLang[]} languages * Recalculating percentages so that, compact layout's progress bar does not break when
* hiding languages.
*
* @param {import("../fetchers/types").WakaTimeLang[]} languages The languages array.
* @return {void} The recalculated languages array.
*/ */
const recalculatePercentages = (languages) => { const recalculatePercentages = (languages) => {
// recalculating percentages so that,
// compact layout's progress bar does not break when hiding languages
const totalSum = languages.reduce( const totalSum = languages.reduce(
(totalSum, language) => totalSum + language.percent, (totalSum, language) => totalSum + language.percent,
0, 0,
@@ -148,12 +157,14 @@ const recalculatePercentages = (languages) => {
}; };
/** /**
* @param {Partial<import('../fetchers/types').WakaTimeData>} stats * Renders WakaTime card.
* @param {Partial<import('./types').WakaTimeOptions>} options *
* @returns {string} * @param {Partial<import('../fetchers/types').WakaTimeData>} stats WakaTime stats.
* @param {Partial<import('./types').WakaTimeOptions>} options Card options.
* @returns {string} WakaTime card SVG.
*/ */
const renderWakatimeCard = (stats = {}, options = { hide: [] }) => { const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
let { languages } = stats; let { languages = [] } = stats;
const { const {
hide_title = false, hide_title = false,
hide_border = false, hide_border = false,
@@ -168,20 +179,24 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
custom_title, custom_title,
locale, locale,
layout, layout,
langs_count = languages ? languages.length : 0, langs_count = languages.length,
border_radius, border_radius,
border_color, border_color,
} = options; } = options;
const shouldHideLangs = Array.isArray(hide) && hide.length > 0; const shouldHideLangs = Array.isArray(hide) && hide.length > 0;
if (shouldHideLangs && languages !== undefined) { if (shouldHideLangs) {
const languagesToHide = new Set(hide.map((lang) => lowercaseTrim(lang))); const languagesToHide = new Set(hide.map((lang) => lowercaseTrim(lang)));
languages = languages.filter( languages = languages.filter(
(lang) => !languagesToHide.has(lowercaseTrim(lang.name)), (lang) => !languagesToHide.has(lowercaseTrim(lang.name)),
); );
recalculatePercentages(languages);
} }
// Since the percentages are sorted in descending order, we can just
// slice from the beginning without sorting.
languages = languages.slice(0, langs_count);
recalculatePercentages(languages);
const i18n = new I18n({ const i18n = new I18n({
locale, locale,
translations: wakatimeCardLocales, translations: wakatimeCardLocales,
@@ -189,7 +204,7 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
const lheight = parseInt(String(line_height), 10); const lheight = parseInt(String(line_height), 10);
const langsCount = clampValue(parseInt(String(langs_count)), 1, langs_count); const langsCount = clampValue(langs_count, 1, langs_count);
// returns theme based colors with proper overrides and defaults // returns theme based colors with proper overrides and defaults
const { titleColor, textColor, iconColor, bgColor, borderColor } = const { titleColor, textColor, iconColor, bgColor, borderColor } =
@@ -203,10 +218,8 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
}); });
const filteredLanguages = languages const filteredLanguages = languages
? languages .filter((language) => language.hours || language.minutes)
.filter((language) => language.hours || language.minutes) .slice(0, langsCount);
.slice(0, langsCount)
: [];
// Calculate the card height depending on how many items there are // Calculate the card height depending on how many items there are
// but if rank circle is visible clamp the minimum height to `150` // but if rank circle is visible clamp the minimum height to `150`
@@ -258,21 +271,34 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
<rect x="25" y="0" width="${width - 50}" height="8" fill="white" rx="5" /> <rect x="25" y="0" width="${width - 50}" height="8" fill="white" rx="5" />
</mask> </mask>
${compactProgressBar} ${compactProgressBar}
${createLanguageTextNode({ ${
x: 0, filteredLanguages.length
y: 25, ? createLanguageTextNode({
langs: filteredLanguages, x: 0,
totalSize: 100, y: 25,
}).join("")} langs: filteredLanguages,
totalSize: 100,
}).join("")
: noCodingActivityNode({
// @ts-ignore
color: textColor,
text: !stats.is_coding_activity_visible
? i18n.t("wakatimecard.notpublic")
: stats.is_other_usage_visible
? i18n.t("wakatimecard.nocodingactivity")
: i18n.t("wakatimecard.nocodedetails"),
})
}
`; `;
} else { } else {
finalLayout = flexLayout({ finalLayout = flexLayout({
items: filteredLanguages.length items: filteredLanguages.length
? filteredLanguages.map((language) => { ? filteredLanguages.map((language, index) => {
return createTextNode({ return createTextNode({
id: language.name, id: language.name,
label: language.name, label: language.name,
value: language.text, value: language.text,
index: index,
percent: language.percent, percent: language.percent,
// @ts-ignore // @ts-ignore
progressBarColor: titleColor, progressBarColor: titleColor,
@@ -285,7 +311,11 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
noCodingActivityNode({ noCodingActivityNode({
// @ts-ignore // @ts-ignore
color: textColor, color: textColor,
text: i18n.t("wakatimecard.nocodingactivity"), text: !stats.is_coding_activity_visible
? i18n.t("wakatimecard.notpublic")
: stats.is_other_usage_visible
? i18n.t("wakatimecard.nocodingactivity")
: i18n.t("wakatimecard.nocodedetails"),
}), }),
], ],
gap: lheight, gap: lheight,
@@ -293,9 +323,20 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
}).join(""); }).join("");
} }
// Get title range text
let titleText = i18n.t("wakatimecard.title");
switch (stats.range) {
case "last_7_days":
titleText += ` (${i18n.t("wakatimecard.last7days")})`;
break;
case "last_year":
titleText += ` (${i18n.t("wakatimecard.lastyear")})`;
break;
}
const card = new Card({ const card = new Card({
customTitle: custom_title, customTitle: custom_title,
defaultTitle: i18n.t("wakatimecard.title"), defaultTitle: titleText,
width: 495, width: 495,
height, height,
border_radius, border_radius,
@@ -313,7 +354,29 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
card.setCSS( card.setCSS(
` `
${cssStyles} ${cssStyles}
@keyframes slideInAnimation {
from {
width: 0;
}
to {
width: calc(100%-100px);
}
}
@keyframes growWidthAnimation {
from {
width: 0;
}
to {
width: 100%;
}
}
.lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${textColor} } .lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${textColor} }
#rect-mask rect{
animation: slideInAnimation 1s ease-in-out forwards;
}
.lang-progress{
animation: growWidthAnimation 0.6s ease-in-out forwards;
}
`, `,
); );
+16 -8
View File
@@ -3,14 +3,22 @@ import { encodeHTML, flexLayout } from "./utils.js";
class Card { class Card {
/** /**
* @param {object} args * Creates a new card instance.
* @param {number?=} args.width *
* @param {number?=} args.height * @param {object} args Card arguments.
* @param {number?=} args.border_radius * @param {number?=} args.width Card width.
* @param {string?=} args.customTitle * @param {number?=} args.height Card height.
* @param {string?=} args.defaultTitle * @param {number?=} args.border_radius Card border radius.
* @param {string?=} args.titlePrefixIcon * @param {string?=} args.customTitle Card custom title.
* @param {ReturnType<import('../common/utils.js').getCardColors>?=} args.colors * @param {string?=} args.defaultTitle Card default title.
* @param {string?=} args.titlePrefixIcon Card title prefix icon.
* @param {object?=} args.colors Card colors arguments.
* @param {string} args.colors.titleColor Card title color.
* @param {string} args.colors.textColor Card text color.
* @param {string} args.colors.iconColor Card icon color.
* @param {string|Array} args.colors.bgColor Card background color.
* @param {string} args.colors.borderColor Card border color.
* @returns {Card} Card instance.
*/ */
constructor({ constructor({
width = 100, width = 100,
+8 -3
View File
@@ -1,3 +1,6 @@
/**
* I18n translation class.
*/
class I18n { class I18n {
constructor({ locale, translations }) { constructor({ locale, translations }) {
this.locale = locale; this.locale = locale;
@@ -6,15 +9,17 @@ class I18n {
} }
t(str) { t(str) {
const locale = this.locale || this.fallbackLocale;
if (!this.translations[str]) { if (!this.translations[str]) {
throw new Error(`${str} Translation string not found`); throw new Error(`${str} Translation string not found`);
} }
if (!this.translations[str][this.locale || this.fallbackLocale]) { if (!this.translations[str][locale]) {
throw new Error(`${str} Translation locale not found`); throw new Error(`'${str}' translation not found for locale '${locale}'`);
} }
return this.translations[str][this.locale || this.fallbackLocale]; return this.translations[str][locale];
} }
} }
+23 -8
View File
@@ -1,5 +1,18 @@
import { clampValue } from "./utils.js"; import { clampValue } from "./utils.js";
/**
* Create a node to indicate progress in percentage along a horizontal line.
*
* @param {Object} createProgressNodeParams Object that contains the createProgressNode parameters.
* @param {number} createProgressNodeParams.x X-axis position.
* @param {number} createProgressNodeParams.y Y-axis position.
* @param {number} createProgressNodeParams.width Width of progress bar.
* @param {string} createProgressNodeParams.color Progress color.
* @param {string} createProgressNodeParams.progress Progress value.
* @param {string} createProgressNodeParams.progressBarBackgroundColor Progress bar bg color.
* @param {number} createProgressNodeParams.delay Delay before animation starts.
* @returns {string} Progress node.
*/
const createProgressNode = ({ const createProgressNode = ({
x, x,
y, y,
@@ -7,20 +20,22 @@ const createProgressNode = ({
color, color,
progress, progress,
progressBarBackgroundColor, progressBarBackgroundColor,
delay,
}) => { }) => {
const progressPercentage = clampValue(progress, 2, 100); const progressPercentage = clampValue(progress, 2, 100);
return ` return `
<svg width="${width}" x="${x}" y="${y}"> <svg width="${width}" x="${x}" y="${y}">
<rect rx="5" ry="5" x="0" y="0" width="${width}" height="8" fill="${progressBarBackgroundColor}"></rect> <rect rx="5" ry="5" x="0" y="0" width="${width}" height="8" fill="${progressBarBackgroundColor}"></rect>
<rect <svg data-testid="lang-progress" width="${progressPercentage}%">
height="8" <rect
fill="${color}" height="8"
rx="5" ry="5" x="0" y="0" fill="${color}"
data-testid="lang-progress" rx="5" ry="5" x="0" y="0"
width="${progressPercentage}%" class="lang-progress"
> style="animation-delay: ${delay}ms;"
</rect> />
</svg>
</svg> </svg>
`; `;
}; };
+45 -1
View File
@@ -6,7 +6,51 @@ const icons = {
icon: `<path fill-rule="evenodd" d="M2 2.5A2.5 2.5 0 014.5 0h8.75a.75.75 0 01.75.75v12.5a.75.75 0 01-.75.75h-2.5a.75.75 0 110-1.5h1.75v-2h-8a1 1 0 00-.714 1.7.75.75 0 01-1.072 1.05A2.495 2.495 0 012 11.5v-9zm10.5-1V9h-8c-.356 0-.694.074-1 .208V2.5a1 1 0 011-1h8zM5 12.25v3.25a.25.25 0 00.4.2l1.45-1.087a.25.25 0 01.3 0L8.6 15.7a.25.25 0 00.4-.2v-3.25a.25.25 0 00-.25-.25h-3.5a.25.25 0 00-.25.25z"/>`, icon: `<path fill-rule="evenodd" d="M2 2.5A2.5 2.5 0 014.5 0h8.75a.75.75 0 01.75.75v12.5a.75.75 0 01-.75.75h-2.5a.75.75 0 110-1.5h1.75v-2h-8a1 1 0 00-.714 1.7.75.75 0 01-1.072 1.05A2.495 2.495 0 012 11.5v-9zm10.5-1V9h-8c-.356 0-.694.074-1 .208V2.5a1 1 0 011-1h8zM5 12.25v3.25a.25.25 0 00.4.2l1.45-1.087a.25.25 0 01.3 0L8.6 15.7a.25.25 0 00.4-.2v-3.25a.25.25 0 00-.25-.25h-3.5a.25.25 0 00-.25.25z"/>`,
contribs: `<path fill-rule="evenodd" d="M2 2.5A2.5 2.5 0 014.5 0h8.75a.75.75 0 01.75.75v12.5a.75.75 0 01-.75.75h-2.5a.75.75 0 110-1.5h1.75v-2h-8a1 1 0 00-.714 1.7.75.75 0 01-1.072 1.05A2.495 2.495 0 012 11.5v-9zm10.5-1V9h-8c-.356 0-.694.074-1 .208V2.5a1 1 0 011-1h8zM5 12.25v3.25a.25.25 0 00.4.2l1.45-1.087a.25.25 0 01.3 0L8.6 15.7a.25.25 0 00.4-.2v-3.25a.25.25 0 00-.25-.25h-3.5a.25.25 0 00-.25.25z"/>`, contribs: `<path fill-rule="evenodd" d="M2 2.5A2.5 2.5 0 014.5 0h8.75a.75.75 0 01.75.75v12.5a.75.75 0 01-.75.75h-2.5a.75.75 0 110-1.5h1.75v-2h-8a1 1 0 00-.714 1.7.75.75 0 01-1.072 1.05A2.495 2.495 0 012 11.5v-9zm10.5-1V9h-8c-.356 0-.694.074-1 .208V2.5a1 1 0 011-1h8zM5 12.25v3.25a.25.25 0 00.4.2l1.45-1.087a.25.25 0 01.3 0L8.6 15.7a.25.25 0 00.4-.2v-3.25a.25.25 0 00-.25-.25h-3.5a.25.25 0 00-.25.25z"/>`,
fork: `<path fill-rule="evenodd" d="M5 3.25a.75.75 0 11-1.5 0 .75.75 0 011.5 0zm0 2.122a2.25 2.25 0 10-1.5 0v.878A2.25 2.25 0 005.75 8.5h1.5v2.128a2.251 2.251 0 101.5 0V8.5h1.5a2.25 2.25 0 002.25-2.25v-.878a2.25 2.25 0 10-1.5 0v.878a.75.75 0 01-.75.75h-4.5A.75.75 0 015 6.25v-.878zm3.75 7.378a.75.75 0 11-1.5 0 .75.75 0 011.5 0zm3-8.75a.75.75 0 100-1.5.75.75 0 000 1.5z"></path>`, fork: `<path fill-rule="evenodd" d="M5 3.25a.75.75 0 11-1.5 0 .75.75 0 011.5 0zm0 2.122a2.25 2.25 0 10-1.5 0v.878A2.25 2.25 0 005.75 8.5h1.5v2.128a2.251 2.251 0 101.5 0V8.5h1.5a2.25 2.25 0 002.25-2.25v-.878a2.25 2.25 0 10-1.5 0v.878a.75.75 0 01-.75.75h-4.5A.75.75 0 015 6.25v-.878zm3.75 7.378a.75.75 0 11-1.5 0 .75.75 0 011.5 0zm3-8.75a.75.75 0 100-1.5.75.75 0 000 1.5z"></path>`,
reviews: `<path fill-rule="evenodd" d="M8 2c1.981 0 3.671.992 4.933 2.078 1.27 1.091 2.187 2.345 2.637 3.023a1.62 1.62 0 0 1 0 1.798c-.45.678-1.367 1.932-2.637 3.023C11.67 13.008 9.981 14 8 14c-1.981 0-3.671-.992-4.933-2.078C1.797 10.83.88 9.576.43 8.898a1.62 1.62 0 0 1 0-1.798c.45-.677 1.367-1.931 2.637-3.022C4.33 2.992 6.019 2 8 2ZM1.679 7.932a.12.12 0 0 0 0 .136c.411.622 1.241 1.75 2.366 2.717C5.176 11.758 6.527 12.5 8 12.5c1.473 0 2.825-.742 3.955-1.715 1.124-.967 1.954-2.096 2.366-2.717a.12.12 0 0 0 0-.136c-.412-.621-1.242-1.75-2.366-2.717C10.824 4.242 9.473 3.5 8 3.5c-1.473 0-2.825.742-3.955 1.715-1.124.967-1.954 2.096-2.366 2.717ZM8 10a2 2 0 1 1-.001-3.999A2 2 0 0 1 8 10Z"/>`,
discussions_started: `<path fill-rule="evenodd" d="M1.75 1h8.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0 1 10.25 10H7.061l-2.574 2.573A1.458 1.458 0 0 1 2 11.543V10h-.25A1.75 1.75 0 0 1 0 8.25v-5.5C0 1.784.784 1 1.75 1ZM1.5 2.75v5.5c0 .138.112.25.25.25h1a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h3.5a.25.25 0 0 0 .25-.25v-5.5a.25.25 0 0 0-.25-.25h-8.5a.25.25 0 0 0-.25.25Zm13 2a.25.25 0 0 0-.25-.25h-.5a.75.75 0 0 1 0-1.5h.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0 1 14.25 12H14v1.543a1.458 1.458 0 0 1-2.487 1.03L9.22 12.28a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215l2.22 2.22v-2.19a.75.75 0 0 1 .75-.75h1a.25.25 0 0 0 .25-.25Z" />`,
discussions_answered: `<path fill-rule="evenodd" d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z" />`,
}; };
export { icons }; /**
* Get rank icon
*
* @param {string} rankIcon - The rank icon type.
* @param {number} rankLevel - The rank level.
* @param {number} percentile - The rank percentile.
* @returns {string} - The SVG code of the rank icon
*/
const rankIcon = (rankIcon, rankLevel, percentile) => {
switch (rankIcon) {
case "github":
return `
<svg x="-38" y="-30" height="66" width="66" aria-hidden="true" viewBox="0 0 16 16" version="1.1" data-view-component="true" data-testid="github-rank-icon">
<path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path>
</svg>
`;
case "percentile":
return `
<text x="-5" y="-12" alignment-baseline="central" dominant-baseline="central" text-anchor="middle" data-testid="percentile-top-header" class="rank-percentile-header">
Top
</text>
<text x="-5" y="12" alignment-baseline="central" dominant-baseline="central" text-anchor="middle" data-testid="percentile-rank-value" class="rank-percentile-text">
${percentile.toFixed(1)}%
</text>
`;
case "progress":
return `
<text x="-5" y="3" alignment-baseline="central" dominant-baseline="central" text-anchor="middle" data-testid="progress-rank-icon" class="rank-percentile-text">
${(100.0 - percentile).toFixed(1)}%
</text>
`;
case "default":
default:
return `
<text x="-5" y="3" alignment-baseline="central" dominant-baseline="central" text-anchor="middle" data-testid="level-rank-icon">
${rankLevel}
</text>
`;
}
};
export { icons, rankIcon };
export default icons; export default icons;
+30
View File
@@ -0,0 +1,30 @@
export { blacklist } from "./blacklist.js";
export { Card } from "./Card.js";
export { createProgressNode } from "./createProgressNode.js";
export { I18n } from "./I18n.js";
export { icons } from "./icons.js";
export { retryer } from "./retryer.js";
export {
ERROR_CARD_LENGTH,
renderError,
encodeHTML,
kFormatter,
isValidHexColor,
parseBoolean,
parseArray,
clampValue,
isValidGradient,
fallbackColor,
request,
flexLayout,
getCardColors,
wrapTextMultiline,
logger,
CONSTANTS,
CustomError,
MissingParamError,
measureText,
lowercaseTrim,
chunkArray,
parseEmojis,
} from "./utils.js";
+39 -2
View File
@@ -79,6 +79,7 @@
"Ceylon": "#dfa535", "Ceylon": "#dfa535",
"Chapel": "#8dc63f", "Chapel": "#8dc63f",
"ChucK": "#3f8000", "ChucK": "#3f8000",
"Circom": "#707575",
"Cirru": "#ccccff", "Cirru": "#ccccff",
"Clarion": "#db901e", "Clarion": "#db901e",
"Clarity": "#5546ff", "Clarity": "#5546ff",
@@ -102,8 +103,10 @@
"Csound Score": "#1a1a1a", "Csound Score": "#1a1a1a",
"Cuda": "#3A4E3A", "Cuda": "#3A4E3A",
"Curry": "#531242", "Curry": "#531242",
"Cypher": "#34c0eb",
"Cython": "#fedf5b", "Cython": "#fedf5b",
"D": "#ba595e", "D": "#ba595e",
"D2": "#526ee8",
"DM": "#447265", "DM": "#447265",
"Dafny": "#FFEC25", "Dafny": "#FFEC25",
"Darcs Patch": "#8eff23", "Darcs Patch": "#8eff23",
@@ -115,6 +118,7 @@
"DirectX 3D File": "#aace60", "DirectX 3D File": "#aace60",
"Dockerfile": "#384d54", "Dockerfile": "#384d54",
"Dogescript": "#cca760", "Dogescript": "#cca760",
"Dotenv": "#e5d559",
"Dylan": "#6c616e", "Dylan": "#6c616e",
"E": "#ccce35", "E": "#ccce35",
"ECL": "#8a1267", "ECL": "#8a1267",
@@ -124,11 +128,13 @@
"Earthly": "#2af0ff", "Earthly": "#2af0ff",
"Easybuild": "#069406", "Easybuild": "#069406",
"Ecere Projects": "#913960", "Ecere Projects": "#913960",
"Ecmarkup": "#eb8131",
"EditorConfig": "#fff1f2", "EditorConfig": "#fff1f2",
"Eiffel": "#4d6977", "Eiffel": "#4d6977",
"Elixir": "#6e4a7e", "Elixir": "#6e4a7e",
"Elm": "#60B5CC", "Elm": "#60B5CC",
"Elvish": "#55BB55", "Elvish": "#55BB55",
"Elvish Transcript": "#55BB55",
"Emacs Lisp": "#c065db", "Emacs Lisp": "#c065db",
"EmberScript": "#FFF4F3", "EmberScript": "#FFF4F3",
"Erlang": "#B83998", "Erlang": "#B83998",
@@ -147,7 +153,7 @@
"Forth": "#341708", "Forth": "#341708",
"Fortran": "#4d41b1", "Fortran": "#4d41b1",
"Fortran Free Form": "#4d41b1", "Fortran Free Form": "#4d41b1",
"FreeBasic": "#867db1", "FreeBasic": "#141AC9",
"FreeMarker": "#0050b2", "FreeMarker": "#0050b2",
"Frege": "#00cafe", "Frege": "#00cafe",
"Futhark": "#5f021f", "Futhark": "#5f021f",
@@ -180,6 +186,8 @@
"Go": "#00ADD8", "Go": "#00ADD8",
"Go Checksums": "#00ADD8", "Go Checksums": "#00ADD8",
"Go Module": "#00ADD8", "Go Module": "#00ADD8",
"Go Workspace": "#00ADD8",
"Godot Resource": "#355570",
"Golo": "#88562A", "Golo": "#88562A",
"Gosu": "#82937f", "Gosu": "#82937f",
"Grace": "#615f8b", "Grace": "#615f8b",
@@ -190,6 +198,7 @@
"Groovy": "#4298b8", "Groovy": "#4298b8",
"Groovy Server Pages": "#4298b8", "Groovy Server Pages": "#4298b8",
"HAProxy": "#106da9", "HAProxy": "#106da9",
"HCL": "#844FBA",
"HLSL": "#aace60", "HLSL": "#aace60",
"HOCON": "#9ff8ee", "HOCON": "#9ff8ee",
"HTML": "#e34c26", "HTML": "#e34c26",
@@ -215,6 +224,7 @@
"Idris": "#b30000", "Idris": "#b30000",
"Ignore List": "#000000", "Ignore List": "#000000",
"ImageJ Macro": "#99AAFF", "ImageJ Macro": "#99AAFF",
"Imba": "#16cec6",
"Inno Setup": "#264b99", "Inno Setup": "#264b99",
"Io": "#a9188d", "Io": "#a9188d",
"Ioke": "#078193", "Ioke": "#078193",
@@ -222,6 +232,7 @@
"Isabelle ROOT": "#FEFE00", "Isabelle ROOT": "#FEFE00",
"J": "#9EEDFF", "J": "#9EEDFF",
"JAR Manifest": "#b07219", "JAR Manifest": "#b07219",
"JCL": "#d90e09",
"JFlex": "#DBCA00", "JFlex": "#DBCA00",
"JSON": "#292929", "JSON": "#292929",
"JSON with Comments": "#292929", "JSON with Comments": "#292929",
@@ -244,9 +255,11 @@
"Jsonnet": "#0064bd", "Jsonnet": "#0064bd",
"Julia": "#a270ba", "Julia": "#a270ba",
"Jupyter Notebook": "#DA5B0B", "Jupyter Notebook": "#DA5B0B",
"Just": "#384d54",
"KRL": "#28430A", "KRL": "#28430A",
"Kaitai Struct": "#773b37", "Kaitai Struct": "#773b37",
"KakouneScript": "#6f8042", "KakouneScript": "#6f8042",
"KerboScript": "#41adf0",
"KiCad Layout": "#2f4aab", "KiCad Layout": "#2f4aab",
"KiCad Legacy Layout": "#2f4aab", "KiCad Legacy Layout": "#2f4aab",
"KiCad Schematic": "#2f4aab", "KiCad Schematic": "#2f4aab",
@@ -273,6 +286,7 @@
"Lua": "#000080", "Lua": "#000080",
"MATLAB": "#e16737", "MATLAB": "#e16737",
"MAXScript": "#00a6a6", "MAXScript": "#00a6a6",
"MDX": "#fcb32c",
"MLIR": "#5EC8DB", "MLIR": "#5EC8DB",
"MQL4": "#62A8D6", "MQL4": "#62A8D6",
"MQL5": "#4A76B8", "MQL5": "#4A76B8",
@@ -286,6 +300,7 @@
"Mathematica": "#dd1100", "Mathematica": "#dd1100",
"Max": "#c4a79c", "Max": "#c4a79c",
"Mercury": "#ff2b2b", "Mercury": "#ff2b2b",
"Mermaid": "#ff3670",
"Meson": "#007800", "Meson": "#007800",
"Metal": "#8f14e9", "Metal": "#8f14e9",
"MiniYAML": "#ff1111", "MiniYAML": "#ff1111",
@@ -318,7 +333,12 @@
"Nu": "#c9df40", "Nu": "#c9df40",
"NumPy": "#9C8AF9", "NumPy": "#9C8AF9",
"Nunjucks": "#3d8137", "Nunjucks": "#3d8137",
"OCaml": "#3be133", "Nushell": "#4E9906",
"OASv2-json": "#85ea2d",
"OASv2-yaml": "#85ea2d",
"OASv3-json": "#85ea2d",
"OASv3-yaml": "#85ea2d",
"OCaml": "#ef7a08",
"ObjectScript": "#424893", "ObjectScript": "#424893",
"Objective-C": "#438eff", "Objective-C": "#438eff",
"Objective-C++": "#6866fb", "Objective-C++": "#6866fb",
@@ -327,19 +347,24 @@
"Omgrofl": "#cabbff", "Omgrofl": "#cabbff",
"Opal": "#f7ede0", "Opal": "#f7ede0",
"Open Policy Agent": "#7d9199", "Open Policy Agent": "#7d9199",
"OpenAPI Specification v2": "#85ea2d",
"OpenAPI Specification v3": "#85ea2d",
"OpenCL": "#ed2e2d", "OpenCL": "#ed2e2d",
"OpenEdge ABL": "#5ce600", "OpenEdge ABL": "#5ce600",
"OpenQASM": "#AA70FF", "OpenQASM": "#AA70FF",
"OpenSCAD": "#e5cd45", "OpenSCAD": "#e5cd45",
"Option List": "#476732",
"Org": "#77aa99", "Org": "#77aa99",
"Oxygene": "#cdd0e3", "Oxygene": "#cdd0e3",
"Oz": "#fab738", "Oz": "#fab738",
"P4": "#7055b5", "P4": "#7055b5",
"PDDL": "#0d00ff",
"PEG.js": "#234d6b", "PEG.js": "#234d6b",
"PHP": "#4F5D95", "PHP": "#4F5D95",
"PLSQL": "#dad8d8", "PLSQL": "#dad8d8",
"PLpgSQL": "#336790", "PLpgSQL": "#336790",
"POV-Ray SDL": "#6bac65", "POV-Ray SDL": "#6bac65",
"Pact": "#F7A8B8",
"Pan": "#cc0000", "Pan": "#cc0000",
"Papyrus": "#6600cc", "Papyrus": "#6600cc",
"Parrot": "#f3ca0a", "Parrot": "#f3ca0a",
@@ -350,7 +375,9 @@
"PicoLisp": "#6067af", "PicoLisp": "#6067af",
"PigLatin": "#fcd7de", "PigLatin": "#fcd7de",
"Pike": "#005390", "Pike": "#005390",
"PlantUML": "#fbbd16",
"PogoScript": "#d80074", "PogoScript": "#d80074",
"Polar": "#ae81ff",
"Portugol": "#f8bd00", "Portugol": "#f8bd00",
"PostCSS": "#dc3a0c", "PostCSS": "#dc3a0c",
"PostScript": "#da291c", "PostScript": "#da291c",
@@ -366,6 +393,7 @@
"Puppet": "#302B6D", "Puppet": "#302B6D",
"PureBasic": "#5a6986", "PureBasic": "#5a6986",
"PureScript": "#1D222D", "PureScript": "#1D222D",
"Pyret": "#ee1e10",
"Python": "#3572A5", "Python": "#3572A5",
"Python console": "#3572A5", "Python console": "#3572A5",
"Python traceback": "#3572A5", "Python traceback": "#3572A5",
@@ -375,6 +403,7 @@
"Quake": "#882233", "Quake": "#882233",
"R": "#198CE7", "R": "#198CE7",
"RAML": "#77d9fb", "RAML": "#77d9fb",
"RBS": "#701516",
"RDoc": "#701516", "RDoc": "#701516",
"REXX": "#d90e09", "REXX": "#d90e09",
"RMarkdown": "#198ce7", "RMarkdown": "#198ce7",
@@ -414,6 +443,7 @@
"Sass": "#a53b70", "Sass": "#a53b70",
"Scala": "#c22d40", "Scala": "#c22d40",
"Scaml": "#bd181a", "Scaml": "#bd181a",
"Scenic": "#fdc700",
"Scheme": "#1e4aec", "Scheme": "#1e4aec",
"Scilab": "#ca0f21", "Scilab": "#ca0f21",
"Self": "#0579aa", "Self": "#0579aa",
@@ -421,6 +451,7 @@
"Shell": "#89e051", "Shell": "#89e051",
"ShellCheck Config": "#cecfcb", "ShellCheck Config": "#cecfcb",
"Shen": "#120F14", "Shen": "#120F14",
"Simple File Verification": "#C9BFED",
"Singularity": "#64E6AD", "Singularity": "#64E6AD",
"Slash": "#007eff", "Slash": "#007eff",
"Slice": "#003fa2", "Slice": "#003fa2",
@@ -428,6 +459,8 @@
"SmPL": "#c94949", "SmPL": "#c94949",
"Smalltalk": "#596706", "Smalltalk": "#596706",
"Smarty": "#f0c040", "Smarty": "#f0c040",
"Smithy": "#c44536",
"Snakemake": "#419179",
"Solidity": "#AA6746", "Solidity": "#AA6746",
"SourcePawn": "#f69e1d", "SourcePawn": "#f69e1d",
"Squirrel": "#800000", "Squirrel": "#800000",
@@ -441,9 +474,11 @@
"SugarSS": "#2fcc9f", "SugarSS": "#2fcc9f",
"SuperCollider": "#46390b", "SuperCollider": "#46390b",
"Svelte": "#ff3e00", "Svelte": "#ff3e00",
"Sway": "#dea584",
"Swift": "#F05138", "Swift": "#F05138",
"SystemVerilog": "#DAE1C2", "SystemVerilog": "#DAE1C2",
"TI Program": "#A0AA87", "TI Program": "#A0AA87",
"TL-Verilog": "#C40023",
"TLA": "#4b0079", "TLA": "#4b0079",
"TOML": "#9c4221", "TOML": "#9c4221",
"TSQL": "#e38c00", "TSQL": "#e38c00",
@@ -478,11 +513,13 @@
"Vim Script": "#199f4b", "Vim Script": "#199f4b",
"Vim Snippet": "#199f4b", "Vim Snippet": "#199f4b",
"Visual Basic .NET": "#945db7", "Visual Basic .NET": "#945db7",
"Visual Basic 6.0": "#2c6353",
"Volt": "#1F1F1F", "Volt": "#1F1F1F",
"Vue": "#41b883", "Vue": "#41b883",
"Vyper": "#2980b9", "Vyper": "#2980b9",
"Web Ontology Language": "#5b70bd", "Web Ontology Language": "#5b70bd",
"WebAssembly": "#04133b", "WebAssembly": "#04133b",
"WebAssembly Interface Type": "#6250e7",
"Whiley": "#d5c397", "Whiley": "#d5c397",
"Wikitext": "#fc5757", "Wikitext": "#fc5757",
"Windows Registry Entries": "#52d5ff", "Windows Registry Entries": "#52d5ff",
+22 -2
View File
@@ -1,7 +1,22 @@
import { CustomError, logger } from "./utils.js"; import { CustomError, logger } from "./utils.js";
// Script variables.
const PATs = Object.keys(process.env).filter((key) =>
/PAT_\d*$/.exec(key),
).length;
const RETRIES = PATs ? PATs : 7;
/**
* Try to execute the fetcher function until it succeeds or the max number of retries is reached.
*
* @param {object[]} retryerParams Object that contains the createTextNode parameters.
* @param {object[]} retryerParams.fetcher The fetcher function.
* @param {object[]} retryerParams.variables Object with arguments to pass to the fetcher function.
* @param {number} retryerParams.retries How many times to retry.
* @returns Promise<retryer>
*/
const retryer = async (fetcher, variables, retries = 0) => { const retryer = async (fetcher, variables, retries = 0) => {
if (retries > 7) { if (retries > RETRIES) {
throw new CustomError("Maximum retries exceeded", CustomError.MAX_RETRY); throw new CustomError("Maximum retries exceeded", CustomError.MAX_RETRY);
} }
try { try {
@@ -30,12 +45,17 @@ const retryer = async (fetcher, variables, retries = 0) => {
// prettier-ignore // prettier-ignore
// also checking for bad credentials if any tokens gets invalidated // also checking for bad credentials if any tokens gets invalidated
const isBadCredential = err.response.data && err.response.data.message === "Bad credentials"; const isBadCredential = err.response.data && err.response.data.message === "Bad credentials";
const isAccountSuspended =
err.response.data &&
err.response.data.message === "Sorry. Your account was suspended.";
if (isBadCredential) { if (isBadCredential || isAccountSuspended) {
logger.log(`PAT_${retries + 1} Failed`); logger.log(`PAT_${retries + 1} Failed`);
retries++; retries++;
// directly return from the function // directly return from the function
return retryer(fetcher, variables, retries); return retryer(fetcher, variables, retries);
} else {
return err.response;
} }
} }
}; };
+175 -103
View File
@@ -4,20 +4,27 @@ import toEmoji from "emoji-name-map";
import wrap from "word-wrap"; import wrap from "word-wrap";
import { themes } from "../../themes/index.js"; import { themes } from "../../themes/index.js";
// Script parameters.
const ERROR_CARD_LENGTH = 576.5;
/** /**
* @param {string} message * Renders error message on the card.
* @param {string} secondaryMessage *
* @returns {string} * @param {string} message Main error message.
* @param {string} secondaryMessage The secondary error message.
* @returns {string} The SVG markup.
*/ */
const renderError = (message, secondaryMessage = "") => { const renderError = (message, secondaryMessage = "") => {
return ` return `
<svg width="495" height="120" viewBox="0 0 495 120" fill="none" xmlns="http://www.w3.org/2000/svg"> <svg width="${ERROR_CARD_LENGTH}" height="120" viewBox="0 0 ${ERROR_CARD_LENGTH} 120" fill="none" xmlns="http://www.w3.org/2000/svg">
<style> <style>
.text { font: 600 16px 'Segoe UI', Ubuntu, Sans-Serif; fill: #2F80ED } .text { font: 600 16px 'Segoe UI', Ubuntu, Sans-Serif; fill: #2F80ED }
.small { font: 600 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: #252525 } .small { font: 600 12px 'Segoe UI', Ubuntu, Sans-Serif; fill: #252525 }
.gray { fill: #858585 } .gray { fill: #858585 }
</style> </style>
<rect x="0.5" y="0.5" width="494" height="99%" rx="4.5" fill="#FFFEFE" stroke="#E4E2E2"/> <rect x="0.5" y="0.5" width="${
ERROR_CARD_LENGTH - 1
}" height="99%" rx="4.5" fill="#FFFEFE" stroke="#E4E2E2"/>
<text x="25" y="45" class="text">Something went wrong! file an issue at https://tiny.one/readme-stats</text> <text x="25" y="45" class="text">Something went wrong! file an issue at https://tiny.one/readme-stats</text>
<text data-testid="message" x="25" y="55" class="text small"> <text data-testid="message" x="25" y="55" class="text small">
<tspan x="25" dy="18">${encodeHTML(message)}</tspan> <tspan x="25" dy="18">${encodeHTML(message)}</tspan>
@@ -28,86 +35,110 @@ const renderError = (message, secondaryMessage = "") => {
}; };
/** /**
* Encode string as HTML.
*
* @see https://stackoverflow.com/a/48073476/10629172 * @see https://stackoverflow.com/a/48073476/10629172
* @param {string} str *
* @returns {string} * @param {string} str String to encode.
* @returns {string} Encoded string.
*/ */
function encodeHTML(str) { const encodeHTML = (str) => {
return str return str
.replace(/[\u00A0-\u9999<>&](?!#)/gim, (i) => { .replace(/[\u00A0-\u9999<>&](?!#)/gim, (i) => {
return "&#" + i.charCodeAt(0) + ";"; return "&#" + i.charCodeAt(0) + ";";
}) })
.replace(/\u0008/gim, ""); .replace(/\u0008/gim, "");
} };
/** /**
* @param {number} num * Retrieves num with suffix k(thousands) precise to 1 decimal if greater than 999.
*
* @param {number} num The number to format.
* @returns {string|number} The formatted number.
*/ */
function kFormatter(num) { const kFormatter = (num) => {
return Math.abs(num) > 999 return Math.abs(num) > 999
? Math.sign(num) * parseFloat((Math.abs(num) / 1000).toFixed(1)) + "k" ? Math.sign(num) * parseFloat((Math.abs(num) / 1000).toFixed(1)) + "k"
: Math.sign(num) * Math.abs(num); : Math.sign(num) * Math.abs(num);
} };
/** /**
* @param {string} hexColor * Checks if a string is a valid hex color.
* @returns {boolean} *
* @param {string} hexColor String to check.
* @returns {boolean} True if the given string is a valid hex color.
*/ */
function isValidHexColor(hexColor) { const isValidHexColor = (hexColor) => {
return new RegExp( return new RegExp(
/^([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3}|[A-Fa-f0-9]{4})$/, /^([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3}|[A-Fa-f0-9]{4})$/,
).test(hexColor); ).test(hexColor);
} };
/** /**
* @param {string} value * Returns boolean if value is either "true" or "false" else the value as it is.
* @returns {boolean | string} *
* @param {string | boolean} value The value to parse.
* @returns {boolean | undefined } The parsed value.
*/ */
function parseBoolean(value) { const parseBoolean = (value) => {
if (value === "true") { if (typeof value === "boolean") return value;
return true;
} else if (value === "false") { if (typeof value === "string") {
return false; if (value.toLowerCase() === "true") {
} else { return true;
return value; } else if (value.toLowerCase() === "false") {
return false;
}
} }
} return undefined;
};
/** /**
* @param {string} str * Parse string to array of strings.
*
* @param {string} str The string to parse.
* @returns {string[]} The array of strings.
*/ */
function parseArray(str) { const parseArray = (str) => {
if (!str) return []; if (!str) return [];
return str.split(","); return str.split(",");
} };
/** /**
* @param {number} number * Clamp the given number between the given range.
* @param {number} min *
* @param {number} max * @param {number} number The number to clamp.
* @param {number} min The minimum value.
* @param {number} max The maximum value.
* @returns {number} The clamped number.
*/ */
function clampValue(number, min, max) { const clampValue = (number, min, max) => {
// @ts-ignore // @ts-ignore
if (Number.isNaN(parseInt(number))) return min; if (Number.isNaN(parseInt(number))) return min;
return Math.max(min, Math.min(number, max)); return Math.max(min, Math.min(number, max));
} };
/** /**
* @param {string[]} colors * Check if the given string is a valid gradient.
*
* @param {string[]} colors Array of colors.
* @returns {boolean} True if the given string is a valid gradient.
*/ */
function isValidGradient(colors) { const isValidGradient = (colors) => {
return isValidHexColor(colors[1]) && isValidHexColor(colors[2]); return isValidHexColor(colors[1]) && isValidHexColor(colors[2]);
} };
/** /**
* @param {string} color * Retrieves a gradient if color has more than one valid hex codes else a single color.
* @param {string} fallbackColor *
* @returns {string | string[]} * @param {string} color The color to parse.
* @param {string} fallbackColor The fallback color.
* @returns {string | string[]} The gradient or color.
*/ */
function fallbackColor(color, fallbackColor) { const fallbackColor = (color, fallbackColor) => {
let colors = color.split(",");
let gradient = null; let gradient = null;
let colors = color ? color.split(",") : [];
if (colors.length > 1 && isValidGradient(colors)) { if (colors.length > 1 && isValidGradient(colors)) {
gradient = colors; gradient = colors;
} }
@@ -116,13 +147,16 @@ function fallbackColor(color, fallbackColor) {
(gradient ? gradient : isValidHexColor(color) && `#${color}`) || (gradient ? gradient : isValidHexColor(color) && `#${color}`) ||
fallbackColor fallbackColor
); );
} };
/** /**
* @param {import('axios').AxiosRequestConfig['data']} data * Send GraphQL request to GitHub API.
* @param {import('axios').AxiosRequestConfig['headers']} headers *
* @param {import('axios').AxiosRequestConfig['data']} data Request data.
* @param {import('axios').AxiosRequestConfig['headers']} headers Request headers.
* @returns {Promise<any>} Request response.
*/ */
function request(data, headers) { const request = (data, headers) => {
// @ts-ignore // @ts-ignore
return axios({ return axios({
url: "https://api.github.com/graphql", url: "https://api.github.com/graphql",
@@ -130,22 +164,20 @@ function request(data, headers) {
headers, headers,
data, data,
}); });
} };
/** /**
* @param {object} props * Auto layout utility, allows us to layout things vertically or horizontally with
* @param {string[]} props.items * proper gaping.
* @param {number} props.gap
* @param {number[]?=} props.sizes
* @param {"column" | "row"?=} props.direction
* *
* @returns {string[]} * @param {object} props Function properties.
* * @param {string[]} props.items Array of items to layout.
* @description * @param {number} props.gap Gap between items.
* Auto layout utility, allows us to layout things * @param {number[]?=} props.sizes Array of sizes for each item.
* vertically or horizontally with proper gaping * @param {"column" | "row"?=} props.direction Direction to layout items.
* @returns {string[]} Array of items with proper layout.
*/ */
function flexLayout({ items, gap, direction, sizes = [] }) { const flexLayout = ({ items, gap, direction, sizes = [] }) => {
let lastSize = 0; let lastSize = 0;
// filter() for filtering out empty strings // filter() for filtering out empty strings
return items.filter(Boolean).map((item, i) => { return items.filter(Boolean).map((item, i) => {
@@ -157,31 +189,31 @@ function flexLayout({ items, gap, direction, sizes = [] }) {
lastSize += size + gap; lastSize += size + gap;
return `<g transform="${transform}">${item}</g>`; return `<g transform="${transform}">${item}</g>`;
}); });
} };
/** /**
* @typedef {object} CardColors * Returns theme based colors with proper overrides and defaults.
* @prop {string?=} title_color *
* @prop {string?=} text_color * @param {Object} args Function arguments.
* @prop {string?=} icon_color * @param {string} args.title_color Card title color.
* @prop {string?=} bg_color * @param {string} args.text_color Card text color.
* @prop {string?=} border_color * @param {string} args.icon_color Card icon color.
* @prop {keyof typeof import('../../themes')?=} fallbackTheme * @param {string} args.bg_color Card background color.
* @prop {keyof typeof import('../../themes')?=} theme * @param {string} args.border_color Card border color.
* @param {string} args.ring_color Card ring color.
* @param {string} args.theme Card theme.
* @param {string} args.fallbackTheme Fallback theme.
*/ */
/** const getCardColors = ({
* returns theme based colors with proper overrides and defaults
* @param {CardColors} options
*/
function getCardColors({
title_color, title_color,
text_color, text_color,
icon_color, icon_color,
bg_color, bg_color,
border_color, border_color,
ring_color,
theme, theme,
fallbackTheme = "default", fallbackTheme = "default",
}) { }) => {
const defaultTheme = themes[fallbackTheme]; const defaultTheme = themes[fallbackTheme];
const selectedTheme = themes[theme] || defaultTheme; const selectedTheme = themes[theme] || defaultTheme;
const defaultBorderColor = const defaultBorderColor =
@@ -193,6 +225,13 @@ function getCardColors({
title_color || selectedTheme.title_color, title_color || selectedTheme.title_color,
"#" + defaultTheme.title_color, "#" + defaultTheme.title_color,
); );
// get the color provided by the user else the theme color
// finally if both colors are invalid we use the titleColor
const ringColor = fallbackColor(
ring_color || selectedTheme.ring_color,
titleColor,
);
const iconColor = fallbackColor( const iconColor = fallbackColor(
icon_color || selectedTheme.icon_color, icon_color || selectedTheme.icon_color,
"#" + defaultTheme.icon_color, "#" + defaultTheme.icon_color,
@@ -211,16 +250,18 @@ function getCardColors({
"#" + defaultBorderColor, "#" + defaultBorderColor,
); );
return { titleColor, iconColor, textColor, bgColor, borderColor }; return { titleColor, iconColor, textColor, bgColor, borderColor, ringColor };
} };
/** /**
* @param {string} text * Split text over multiple lines based on the card width.
* @param {number} width *
* @param {number} maxLines * @param {string} text Text to split.
* @returns {string[]} * @param {number} width Line width in number of characters.
* @param {number} maxLines Maximum number of lines.
* @returns {string[]} Array of lines.
*/ */
function wrapTextMultiline(text, width = 59, maxLines = 3) { const wrapTextMultiline = (text, width = 59, maxLines = 3) => {
const fullWidthComma = ""; const fullWidthComma = "";
const encoded = encodeHTML(text); const encoded = encodeHTML(text);
const isChinese = encoded.includes(fullWidthComma); const isChinese = encoded.includes(fullWidthComma);
@@ -245,7 +286,7 @@ function wrapTextMultiline(text, width = 59, maxLines = 3) {
// Remove empty lines if text fits in less than maxLines lines // Remove empty lines if text fits in less than maxLines lines
const multiLineText = lines.filter(Boolean); const multiLineText = lines.filter(Boolean);
return multiLineText; return multiLineText;
} };
const noop = () => {}; const noop = () => {};
// return console instance based on the environment // return console instance based on the environment
@@ -263,12 +304,17 @@ const SECONDARY_ERROR_MESSAGES = {
MAX_RETRY: MAX_RETRY:
"Please add an env variable called PAT_1 with your github token in vercel", "Please add an env variable called PAT_1 with your github token in vercel",
USER_NOT_FOUND: "Make sure the provided username is not an organization", USER_NOT_FOUND: "Make sure the provided username is not an organization",
GRAPHQL_ERROR: "Please try again later",
WAKATIME_USER_NOT_FOUND: "Make sure you have a public WakaTime profile",
}; };
/**
* Custom error class to handle custom GRS errors.
*/
class CustomError extends Error { class CustomError extends Error {
/** /**
* @param {string} message * @param {string} message Error message.
* @param {string} type * @param {string} type Error type.
*/ */
constructor(message, type) { constructor(message, type) {
super(message); super(message);
@@ -278,8 +324,13 @@ class CustomError extends Error {
static MAX_RETRY = "MAX_RETRY"; static MAX_RETRY = "MAX_RETRY";
static USER_NOT_FOUND = "USER_NOT_FOUND"; static USER_NOT_FOUND = "USER_NOT_FOUND";
static GRAPHQL_ERROR = "GRAPHQL_ERROR";
static WAKATIME_ERROR = "WAKATIME_ERROR";
} }
/**
* Missing query parameter class.
*/
class MissingParamError extends Error { class MissingParamError extends Error {
/** /**
* @param {string[]} missedParams * @param {string[]} missedParams
@@ -296,12 +347,14 @@ class MissingParamError extends Error {
} }
/** /**
* Retrieve text length.
*
* @see https://stackoverflow.com/a/48172630/10629172 * @see https://stackoverflow.com/a/48172630/10629172
* @param {string} str * @param {string} str String to measure.
* @param {number} fontSize * @param {number} fontSize Font size.
* @returns * @returns {number} Text length.
*/ */
function measureText(str, fontSize = 10) { const measureText = (str, fontSize = 10) => {
// prettier-ignore // prettier-ignore
const widths = [ const widths = [
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
@@ -333,18 +386,20 @@ function measureText(str, fontSize = 10) {
) )
.reduce((cur, acc) => acc + cur) * fontSize .reduce((cur, acc) => acc + cur) * fontSize
); );
} };
/** @param {string} name */ /** @param {string} name */
const lowercaseTrim = (name) => name.toLowerCase().trim(); const lowercaseTrim = (name) => name.toLowerCase().trim();
/** /**
* @template T * Split array of languages in two columns.
* @param {Array<T>} arr *
* @param {number} perChunk * @template T Language object.
* @returns {Array<T>} * @param {Array<T>} arr Array of languages.
* @param {number} perChunk Number of languages per column.
* @returns {Array<T>} Array of languages split in two columns.
*/ */
function chunkArray(arr, perChunk) { const chunkArray = (arr, perChunk) => {
return arr.reduce((resultArray, item, index) => { return arr.reduce((resultArray, item, index) => {
const chunkIndex = Math.floor(index / perChunk); const chunkIndex = Math.floor(index / perChunk);
@@ -356,39 +411,56 @@ function chunkArray(arr, perChunk) {
return resultArray; return resultArray;
}, []); }, []);
} };
/** /**
* Parse emoji from string.
* *
* @param {string} str * @param {string} str String to parse emoji from.
* @returns {string} * @returns {string} String with emoji parsed.
*/ */
function parseEmojis(str) { const parseEmojis = (str) => {
if (!str) throw new Error("[parseEmoji]: str argument not provided"); if (!str) throw new Error("[parseEmoji]: str argument not provided");
return str.replace(/:\w+:/gm, (emoji) => { return str.replace(/:\w+:/gm, (emoji) => {
return toEmoji.get(emoji) || ""; return toEmoji.get(emoji) || "";
}); });
} };
/**
* Get diff in minutes
* @param {Date} d1
* @param {Date} d2
* @returns {number}
*/
const dateDiff = (d1, d2) => {
const date1 = new Date(d1);
const date2 = new Date(d2);
const diff = date1.getTime() - date2.getTime();
return Math.round(diff / (1000 * 60));
};
export { export {
ERROR_CARD_LENGTH,
renderError, renderError,
kFormatter,
encodeHTML, encodeHTML,
kFormatter,
isValidHexColor, isValidHexColor,
request,
parseArray,
parseBoolean, parseBoolean,
parseArray,
clampValue,
isValidGradient,
fallbackColor, fallbackColor,
request,
flexLayout, flexLayout,
getCardColors, getCardColors,
clampValue,
wrapTextMultiline, wrapTextMultiline,
measureText,
logger, logger,
CONSTANTS, CONSTANTS,
CustomError, CustomError,
MissingParamError, MissingParamError,
measureText,
lowercaseTrim, lowercaseTrim,
chunkArray, chunkArray,
parseEmojis, parseEmojis,
dateDiff,
}; };
+12 -7
View File
@@ -3,8 +3,11 @@ import { retryer } from "../common/retryer.js";
import { MissingParamError, request } from "../common/utils.js"; import { MissingParamError, request } from "../common/utils.js";
/** /**
* @param {import('Axios').AxiosRequestHeaders} variables * Repo data fetcher.
* @param {string} token *
* @param {import('axios').AxiosRequestHeaders} variables Fetcher variables.
* @param {string} token GitHub token.
* @returns {Promise<import('axios').AxiosResponse>} The response.
*/ */
const fetcher = (variables, token) => { const fetcher = (variables, token) => {
return request( return request(
@@ -51,11 +54,13 @@ const fetcher = (variables, token) => {
const urlExample = "/api/pin?username=USERNAME&amp;repo=REPO_NAME"; const urlExample = "/api/pin?username=USERNAME&amp;repo=REPO_NAME";
/** /**
* @param {string} username * Fetch repository data.
* @param {string} reponame *
* @returns {Promise<import("./types").RepositoryData>} * @param {string} username GitHub username.
* @param {string} reponame GitHub repository name.
* @returns {Promise<import("./types").RepositoryData>} Repository data.
*/ */
async function fetchRepo(username, reponame) { const fetchRepo = async (username, reponame) => {
if (!username && !reponame) { if (!username && !reponame) {
throw new MissingParamError(["username", "repo"], urlExample); throw new MissingParamError(["username", "repo"], urlExample);
} }
@@ -95,7 +100,7 @@ async function fetchRepo(username, reponame) {
starCount: data.organization.repository.stargazers.totalCount, starCount: data.organization.repository.stargazers.totalCount,
}; };
} }
} };
export { fetchRepo }; export { fetchRepo };
export default fetchRepo; export default fetchRepo;
+161 -80
View File
@@ -9,53 +9,83 @@ import {
logger, logger,
MissingParamError, MissingParamError,
request, request,
wrapTextMultiline,
} from "../common/utils.js"; } from "../common/utils.js";
dotenv.config(); dotenv.config();
// GraphQL queries.
const GRAPHQL_REPOS_FIELD = `
repositories(first: 100, ownerAffiliations: OWNER, orderBy: {direction: DESC, field: STARGAZERS}, after: $after) {
totalCount
nodes {
name
stargazers {
totalCount
}
}
pageInfo {
hasNextPage
endCursor
}
}
`;
const GRAPHQL_REPOS_QUERY = `
query userInfo($login: String!, $after: String) {
user(login: $login) {
${GRAPHQL_REPOS_FIELD}
}
}
`;
const GRAPHQL_STATS_QUERY = `
query userInfo($login: String!, $after: String) {
user(login: $login) {
name
login
contributionsCollection {
totalCommitContributions,
totalPullRequestReviewContributions
}
repositoriesContributedTo(first: 1, contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]) {
totalCount
}
pullRequests(first: 1) {
totalCount
}
openIssues: issues(states: OPEN) {
totalCount
}
closedIssues: issues(states: CLOSED) {
totalCount
}
followers {
totalCount
}
repositoryDiscussions {
totalCount
}
repositoryDiscussionComments(onlyAnswers: true) {
totalCount
}
${GRAPHQL_REPOS_FIELD}
}
}
`;
/** /**
* @param {import('axios').AxiosRequestHeaders} variables * Stats fetcher object.
* @param {string} token *
* @param {import('axios').AxiosRequestHeaders} variables Fetcher variables.
* @param {string} token GitHub token.
* @returns {Promise<import('../common/types').Fetcher>} Stats fetcher response.
*/ */
const fetcher = (variables, token) => { const fetcher = (variables, token) => {
const query = !variables.after ? GRAPHQL_STATS_QUERY : GRAPHQL_REPOS_QUERY;
return request( return request(
{ {
query: ` query,
query userInfo($login: String!) {
user(login: $login) {
name
login
contributionsCollection {
totalCommitContributions
restrictedContributionsCount
}
repositoriesContributedTo(first: 1, contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]) {
totalCount
}
pullRequests(first: 1) {
totalCount
}
openIssues: issues(states: OPEN) {
totalCount
}
closedIssues: issues(states: CLOSED) {
totalCount
}
followers {
totalCount
}
repositories(first: 100, ownerAffiliations: OWNER, orderBy: {direction: DESC, field: STARGAZERS}) {
totalCount
nodes {
name
stargazers {
totalCount
}
}
}
}
}
`,
variables, variables,
}, },
{ {
@@ -64,8 +94,54 @@ const fetcher = (variables, token) => {
); );
}; };
// https://github.com/anuraghazra/github-readme-stats/issues/92#issuecomment-661026467 /**
// https://github.com/anuraghazra/github-readme-stats/pull/211/ * Fetch stats information for a given username.
*
* @param {string} username Github username.
* @returns {Promise<import('../common/types').StatsFetcher>} GraphQL Stats object.
*
* @description This function supports multi-page fetching if the 'FETCH_MULTI_PAGE_STARS' environment variable is set to true.
*/
const statsFetcher = async (username) => {
let stats;
let hasNextPage = true;
let endCursor = null;
while (hasNextPage) {
const variables = { login: username, first: 100, after: endCursor };
let res = await retryer(fetcher, variables);
if (res.data.errors) return res;
// Store stats data.
const repoNodes = res.data.data.user.repositories.nodes;
if (!stats) {
stats = res;
} else {
stats.data.data.user.repositories.nodes.push(...repoNodes);
}
// Disable multi page fetching on public Vercel instance due to rate limits.
const repoNodesWithStars = repoNodes.filter(
(node) => node.stargazers.totalCount !== 0,
);
hasNextPage =
process.env.FETCH_MULTI_PAGE_STARS === "true" &&
repoNodes.length === repoNodesWithStars.length &&
res.data.data.user.repositories.pageInfo.hasNextPage;
endCursor = res.data.data.user.repositories.pageInfo.endCursor;
}
return stats;
};
/**
* Fetch all the commits for all the repositories of a given username.
*
* @param {*} username GitHub username.
* @returns {Promise<number>} Total commits.
*
* @description Done like this because the GitHub API does not provide a way to fetch all the commits. See
* #92#issuecomment-661026467 and #211 for more information.
*/
const totalCommitsFetcher = async (username) => { const totalCommitsFetcher = async (username) => {
if (!githubUsernameRegex.test(username)) { if (!githubUsernameRegex.test(username)) {
logger.log("Invalid username"); logger.log("Invalid username");
@@ -100,92 +176,97 @@ const totalCommitsFetcher = async (username) => {
}; };
/** /**
* @param {string} username * Fetch stats for a given username.
* @param {boolean} count_private *
* @param {boolean} include_all_commits * @param {string} username GitHub username.
* @returns {Promise<import("./types").StatsData>} * @param {boolean} include_all_commits Include all commits.
* @returns {Promise<import("./types").StatsData>} Stats data.
*/ */
async function fetchStats( const fetchStats = async (
username, username,
count_private = false,
include_all_commits = false, include_all_commits = false,
exclude_repo = [], exclude_repo = [],
) { ) => {
if (!username) throw new MissingParamError(["username"]); if (!username) throw new MissingParamError(["username"]);
const stats = { const stats = {
name: "", name: "",
totalPRs: 0, totalPRs: 0,
totalReviews: 0,
totalCommits: 0, totalCommits: 0,
totalIssues: 0, totalIssues: 0,
totalStars: 0, totalStars: 0,
totalDiscussionsStarted: 0,
totalDiscussionsAnswered: 0,
contributedTo: 0, contributedTo: 0,
rank: { level: "C", score: 0 }, rank: { level: "C", percentile: 100 },
}; };
let res = await retryer(fetcher, { login: username }); let res = await statsFetcher(username);
// Catch GraphQL errors.
if (res.data.errors) { if (res.data.errors) {
logger.error(res.data.errors); logger.error(res.data.errors);
if (res.data.errors[0].type === "NOT_FOUND") {
throw new CustomError(
res.data.errors[0].message || "Could not fetch user.",
CustomError.USER_NOT_FOUND,
);
}
if (res.data.errors[0].message) {
throw new CustomError(
wrapTextMultiline(res.data.errors[0].message, 90, 1)[0],
res.statusText,
);
}
throw new CustomError( throw new CustomError(
res.data.errors[0].message || "Could not fetch user", "Something went wrong while trying to retrieve the stats data using the GraphQL API.",
CustomError.USER_NOT_FOUND, CustomError.GRAPHQL_ERROR,
); );
} }
const user = res.data.data.user; const user = res.data.data.user;
// populate repoToHide map for quick lookup
// while filtering out
let repoToHide = {};
if (exclude_repo) {
exclude_repo.forEach((repoName) => {
repoToHide[repoName] = true;
});
}
stats.name = user.name || user.login; stats.name = user.name || user.login;
stats.totalIssues = user.openIssues.totalCount + user.closedIssues.totalCount;
// normal commits // if include_all_commits, fetch all commits using the REST API.
stats.totalCommits = user.contributionsCollection.totalCommitContributions;
// if include_all_commits then just get that,
// since totalCommitsFetcher already sends totalCommits no need to +=
if (include_all_commits) { if (include_all_commits) {
stats.totalCommits = await totalCommitsFetcher(username); stats.totalCommits = await totalCommitsFetcher(username);
} } else {
stats.totalCommits = user.contributionsCollection.totalCommitContributions;
// if count_private then add private commits to totalCommits so far.
if (count_private) {
stats.totalCommits +=
user.contributionsCollection.restrictedContributionsCount;
} }
stats.totalPRs = user.pullRequests.totalCount; stats.totalPRs = user.pullRequests.totalCount;
stats.totalReviews =
user.contributionsCollection.totalPullRequestReviewContributions;
stats.totalIssues = user.openIssues.totalCount + user.closedIssues.totalCount;
stats.totalDiscussionsStarted = user.repositoryDiscussions.totalCount;
stats.totalDiscussionsAnswered = user.repositoryDiscussionComments.totalCount;
stats.contributedTo = user.repositoriesContributedTo.totalCount; stats.contributedTo = user.repositoriesContributedTo.totalCount;
// Retrieve stars while filtering out repositories to be hidden // Retrieve stars while filtering out repositories to be hidden.
let repoToHide = new Set(exclude_repo);
stats.totalStars = user.repositories.nodes stats.totalStars = user.repositories.nodes
.filter((data) => { .filter((data) => {
return !repoToHide[data.name]; return !repoToHide.has(data.name);
}) })
.reduce((prev, curr) => { .reduce((prev, curr) => {
return prev + curr.stargazers.totalCount; return prev + curr.stargazers.totalCount;
}, 0); }, 0);
stats.rank = calculateRank({ stats.rank = calculateRank({
totalCommits: stats.totalCommits, all_commits: include_all_commits,
totalRepos: user.repositories.totalCount, commits: stats.totalCommits,
followers: user.followers.totalCount,
contributions: stats.contributedTo,
stargazers: stats.totalStars,
prs: stats.totalPRs, prs: stats.totalPRs,
issues: stats.totalIssues, issues: stats.totalIssues,
repos: user.repositories.totalCount,
stars: stats.totalStars,
followers: user.followers.totalCount,
}); });
return stats; return stats;
} };
export { fetchStats }; export { fetchStats };
export default fetchStats; export default fetchStats;
+61 -12
View File
@@ -1,13 +1,19 @@
// @ts-check // @ts-check
import * as dotenv from "dotenv";
import { retryer } from "../common/retryer.js"; import { retryer } from "../common/retryer.js";
import { logger, MissingParamError, request } from "../common/utils.js"; import {
CustomError,
dotenv.config(); logger,
MissingParamError,
request,
wrapTextMultiline,
} from "../common/utils.js";
/** /**
* @param {import('Axios').AxiosRequestHeaders} variables * Top languages fetcher object.
* @param {string} token *
* @param {import('axios').AxiosRequestHeaders} variables Fetcher variables.
* @param {string} token GitHub token.
* @returns {Promise<import('../common/types').StatsFetcherResponse>} Languages fetcher response.
*/ */
const fetcher = (variables, token) => { const fetcher = (variables, token) => {
return request( return request(
@@ -42,11 +48,18 @@ const fetcher = (variables, token) => {
}; };
/** /**
* @param {string} username * Fetch top languages for a given username.
* @param {string[]} exclude_repo *
* @returns {Promise<import("./types").TopLangData>} * @param {string} username GitHub username.
* @param {string[]} exclude_repo List of repositories to exclude.
* @returns {Promise<import("./types").TopLangData>} Top languages data.
*/ */
async function fetchTopLanguages(username, exclude_repo = []) { const fetchTopLanguages = async (
username,
exclude_repo = [],
size_weight = 1,
count_weight = 0,
) => {
if (!username) throw new MissingParamError(["username"]); if (!username) throw new MissingParamError(["username"]);
const res = await retryer(fetcher, { login: username }); const res = await retryer(fetcher, { login: username });
@@ -56,6 +69,27 @@ async function fetchTopLanguages(username, exclude_repo = []) {
throw Error(res.data.errors[0].message || "Could not fetch user"); throw Error(res.data.errors[0].message || "Could not fetch user");
} }
// Catch GraphQL errors.
if (res.data.errors) {
logger.error(res.data.errors);
if (res.data.errors[0].type === "NOT_FOUND") {
throw new CustomError(
res.data.errors[0].message || "Could not fetch user.",
CustomError.USER_NOT_FOUND,
);
}
if (res.data.errors[0].message) {
throw new CustomError(
wrapTextMultiline(res.data.errors[0].message, 90, 1)[0],
res.statusText,
);
}
throw new CustomError(
"Something went while trying to retrieve the language data using the GraphQL API.",
CustomError.GRAPHQL_ERROR,
);
}
let repoNodes = res.data.data.user.repositories.nodes; let repoNodes = res.data.data.user.repositories.nodes;
let repoToHide = {}; let repoToHide = {};
@@ -72,6 +106,8 @@ async function fetchTopLanguages(username, exclude_repo = []) {
.sort((a, b) => b.size - a.size) .sort((a, b) => b.size - a.size)
.filter((name) => !repoToHide[name.name]); .filter((name) => !repoToHide[name.name]);
let repoCount = 0;
repoNodes = repoNodes repoNodes = repoNodes
.filter((node) => node.languages.edges.length > 0) .filter((node) => node.languages.edges.length > 0)
// flatten the list of language nodes // flatten the list of language nodes
@@ -82,9 +118,14 @@ async function fetchTopLanguages(username, exclude_repo = []) {
// if we already have the language in the accumulator // if we already have the language in the accumulator
// & the current language name is same as previous name // & the current language name is same as previous name
// add the size to the language size. // add the size to the language size and increase repoCount.
if (acc[prev.node.name] && prev.node.name === acc[prev.node.name].name) { if (acc[prev.node.name] && prev.node.name === acc[prev.node.name].name) {
langSize = prev.size + acc[prev.node.name].size; langSize = prev.size + acc[prev.node.name].size;
repoCount += 1;
} else {
// reset repoCount to 1
// language must exist in at least one repo to be detected
repoCount = 1;
} }
return { return {
...acc, ...acc,
@@ -92,10 +133,18 @@ async function fetchTopLanguages(username, exclude_repo = []) {
name: prev.node.name, name: prev.node.name,
color: prev.node.color, color: prev.node.color,
size: langSize, size: langSize,
count: repoCount,
}, },
}; };
}, {}); }, {});
Object.keys(repoNodes).forEach((name) => {
// comparison index calculation
repoNodes[name].size =
Math.pow(repoNodes[name].size, size_weight) *
Math.pow(repoNodes[name].count, count_weight);
});
const topLangs = Object.keys(repoNodes) const topLangs = Object.keys(repoNodes)
.sort((a, b) => repoNodes[b].size - repoNodes[a].size) .sort((a, b) => repoNodes[b].size - repoNodes[a].size)
.reduce((result, key) => { .reduce((result, key) => {
@@ -104,7 +153,7 @@ async function fetchTopLanguages(username, exclude_repo = []) {
}, {}); }, {});
return topLangs; return topLangs;
} };
export { fetchTopLanguages }; export { fetchTopLanguages };
export default fetchTopLanguages; export default fetchTopLanguages;
+4 -1
View File
@@ -18,11 +18,14 @@ export type RepositoryData = {
export type StatsData = { export type StatsData = {
name: string; name: string;
totalPRs: number; totalPRs: number;
totalReviews: number;
totalCommits: number; totalCommits: number;
totalIssues: number; totalIssues: number;
totalStars: number; totalStars: number;
totalDiscussionsStarted: number;
totalDiscussionsAnswered: number;
contributedTo: number; contributedTo: number;
rank: { level: string; score: number }; rank: { level: string; percentile: number };
}; };
export type Lang = { export type Lang = {
+11 -7
View File
@@ -1,25 +1,29 @@
import axios from "axios"; import axios from "axios";
import { MissingParamError } from "../common/utils.js"; import { CustomError, MissingParamError } from "../common/utils.js";
import { I18n } from "../common/I18n.js";
/** /**
* @param {{username: string, api_domain: string, range: string}} props * WakaTime data fetcher.
* @returns {Promise<WakaTimeData>} *
* @param {{username: string, api_domain: string }} props Fetcher props.
* @returns {Promise<WakaTimeData>} WakaTime data response.
*/ */
const fetchWakatimeStats = async ({ username, api_domain, range }) => { const fetchWakatimeStats = async ({ username, api_domain }) => {
if (!username) throw new MissingParamError(["username"]); if (!username) throw new MissingParamError(["username"]);
try { try {
const { data } = await axios.get( const { data } = await axios.get(
`https://${ `https://${
api_domain ? api_domain.replace(/\/$/gi, "") : "wakatime.com" api_domain ? api_domain.replace(/\/$/gi, "") : "wakatime.com"
}/api/v1/users/${username}/stats/${range || ""}?is_including_today=true`, }/api/v1/users/${username}/stats?is_including_today=true`,
); );
return data.data; return data.data;
} catch (err) { } catch (err) {
if (err.response.status < 200 || err.response.status > 299) { if (err.response.status < 200 || err.response.status > 299) {
throw new Error( throw new CustomError(
"Wakatime user not found, make sure you have a wakatime profile", `Could not resolve to a User with the login of '${username}'`,
"WAKATIME_USER_NOT_FOUND",
); );
} }
throw err; throw err;
+33 -13
View File
@@ -1,6 +1,9 @@
// @ts-check // @ts-check
/** /**
* @param {number} value * Calculates progress along the boundary of the circle i.e it's circumference.
*
* @param {number} value The rank value to calculate progress for.
* @returns {number} Progress value.
*/ */
const calculateCircleProgress = (value) => { const calculateCircleProgress = (value) => {
const radius = 40; const radius = 40;
@@ -13,9 +16,11 @@ const calculateCircleProgress = (value) => {
}; };
/** /**
* Retrieves the animation to display progress along the circumference of circle
* from the beginning to the given value in a clockwise direction.
* *
* @param {{progress: number}} param0 * @param {{progress: number}} progress The progress value to animate to.
* @returns * @returns {string} Progress animation css.
*/ */
const getProgressAnimation = ({ progress }) => { const getProgressAnimation = ({ progress }) => {
return ` return `
@@ -30,6 +35,11 @@ const getProgressAnimation = ({ progress }) => {
`; `;
}; };
/**
* Retrieves css animations for a card.
*
* @returns {string} Animation css.
*/
const getAnimations = () => { const getAnimations = () => {
return ` return `
/* Animations */ /* Animations */
@@ -53,18 +63,22 @@ const getAnimations = () => {
}; };
/** /**
* @param {{ * Retrieves CSS styles for a card.
* titleColor?: string | string[] *
* textColor?: string | string[] * @param {Object} colors The colors to use for the card.
* iconColor?: string | string[] * @param {string} colors.titleColor The title color.
* show_icons?: boolean; * @param {string} colors.textColor The text color.
* progress?: number; * @param {string} colors.iconColor The icon color.
* }} args * @param {string} colors.ringColor The ring color.
* @param {boolean} colors.show_icons Whether to show icons.
* @param {number} colors.progress The progress value to animate to.
* @returns {string} Card CSS styles.
*/ */
const getStyles = ({ const getStyles = ({
titleColor, titleColor,
textColor, textColor,
iconColor, iconColor,
ringColor,
show_icons, show_icons,
progress, progress,
}) => { }) => {
@@ -84,6 +98,12 @@ const getStyles = ({
font: 800 24px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${textColor}; font: 800 24px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${textColor};
animation: scaleInAnimation 0.3s ease-in-out forwards; animation: scaleInAnimation 0.3s ease-in-out forwards;
} }
.rank-percentile-header {
font-size: 14px;
}
.rank-percentile-text {
font-size: 16px;
}
.not_bold { font-weight: 400 } .not_bold { font-weight: 400 }
.bold { font-weight: 700 } .bold { font-weight: 700 }
@@ -93,13 +113,13 @@ const getStyles = ({
} }
.rank-circle-rim { .rank-circle-rim {
stroke: ${titleColor}; stroke: ${ringColor};
fill: none; fill: none;
stroke-width: 6; stroke-width: 6;
opacity: 0.2; opacity: 0.2;
} }
.rank-circle { .rank-circle {
stroke: ${titleColor}; stroke: ${ringColor};
stroke-dasharray: 250; stroke-dasharray: 250;
fill: none; fill: none;
stroke-width: 6; stroke-width: 6;
@@ -113,4 +133,4 @@ const getStyles = ({
`; `;
}; };
export { getStyles, getAnimations }; export { getAnimations, getStyles };
+3
View File
@@ -0,0 +1,3 @@
export * from "./common/index.js";
export * from "./cards/index.js";
export { getStyles, getAnimations } from "./getStyles.js";
+296 -39
View File
@@ -1,5 +1,14 @@
import { encodeHTML } from "./common/utils.js"; import { encodeHTML } from "./common/utils.js";
/**
* Retrieves stat card labels in the available locales.
*
* @param {string} name The name of the locale.
* @param {string} apostrophe Whether to use apostrophe or not.
* @returns {Object} The locales object.
*
* @see https://www.andiamo.co.uk/resources/iso-language-codes/ for language codes.
*/
const statCardLocales = ({ name, apostrophe }) => { const statCardLocales = ({ name, apostrophe }) => {
const encodedName = encodeHTML(name); const encodedName = encodeHTML(name);
return { return {
@@ -30,7 +39,7 @@ const statCardLocales = ({ name, apostrophe }) => {
sk: `GitHub štatistiky používateľa ${encodedName}`, sk: `GitHub štatistiky používateľa ${encodedName}`,
tr: `${encodedName} Hesabının GitHub Yıldızları`, tr: `${encodedName} Hesabının GitHub Yıldızları`,
pl: `Statystyki GitHub użytkownika ${encodedName}`, pl: `Statystyki GitHub użytkownika ${encodedName}`,
uz: `${encodedName}ning Github'dagi statistikasi`, uz: `${encodedName}ning GitHub'dagi statistikasi`,
vi: `Thống Kê GitHub ${encodedName}`, vi: `Thống Kê GitHub ${encodedName}`,
se: `GitHubstatistik för ${encodedName}`, se: `GitHubstatistik för ${encodedName}`,
}, },
@@ -60,7 +69,7 @@ const statCardLocales = ({ name, apostrophe }) => {
my: "Jumlah Bintang", my: "Jumlah Bintang",
sk: "Hviezdy", sk: "Hviezdy",
tr: "Toplam Yıldız", tr: "Toplam Yıldız",
pl: "Liczba Gwiazdek dostanych", pl: "Liczba otrzymanych gwiazdek",
uz: "Yulduzchalar", uz: "Yulduzchalar",
vi: "Tổng Số Sao", vi: "Tổng Số Sao",
se: "Antal intjänade stjärnor", se: "Antal intjänade stjärnor",
@@ -153,41 +162,131 @@ const statCardLocales = ({ name, apostrophe }) => {
my: "Jumlah Isu Dilaporkan", my: "Jumlah Isu Dilaporkan",
sk: "Všetky problémy", sk: "Všetky problémy",
tr: "Toplam Hata", tr: "Toplam Hata",
pl: "Wszystkie Issues", pl: "Wszystkie problemy",
uz: "'Issue'lar", uz: "'Issue'lar",
vi: "Tổng Số Vấn Đề", vi: "Tổng Số Vấn Đề",
se: "Total antal issues", se: "Total antal issues",
}, },
"statcard.contribs": { "statcard.contribs": {
ar: "ساهم في", ar: "ساهم في (العام الماضي)",
cn: "参与项目数", cn: "贡献于(去年)",
"zh-tw": "參與項目數", "zh-tw": "參與項目數 (去年)",
cs: "Přispěl k", cs: "Přispěl k (minulý rok)",
de: "Beigetragen zu", de: "Beigetragen zu (letztes Jahr)",
en: "Contributed to", en: "Contributed to (last year)",
bn: "অবদান রেখেছেন", bn: "অবদান (গত বছর)",
es: "Contribuciones en", es: "Contribuciones en (el año pasado)",
fr: "Contribué à", fr: "Contribué à (l'année dernière)",
hu: "Hozzájárulások", hu: "Hozzájárulások (tavaly)",
it: "Ha contribuito a", it: "Ha contribuito a (l'anno scorso)",
ja: "貢献したリポジトリ", ja: "貢献したリポジトリ (昨年)",
kr: "전체 기여", kr: "(작년) 기여",
nl: "Bijgedragen aan", nl: "Bijgedragen aan (vorig jaar)",
"pt-pt": "Contribuiu em", "pt-pt": "Contribuiu em (ano passado)",
"pt-br": "Contribuiu para", "pt-br": "Contribuiu para (ano passado)",
np: "कुल योगदानहरू", np: "कुल योगदानहरू (गत वर्ष)",
el: "Συνεισφέρθηκε σε", el: "Συνεισφέρθηκε σε (πέρυσι)",
ru: "Внёс вклад в", ru: "Внёс вклад в (за прошлый год)",
"uk-ua": "Вніс внесок у", "uk-ua": "Зробив внесок у (за минулий рік)",
id: "Berkontribusi ke", id: "Berkontribusi ke (tahun lalu)",
ml: "സമർപ്പിച്ചിരിക്കുന്നത്", ml: "സമർപ്പിച്ചിരിക്കുന്നത് (കഴിഞ്ഞ വർഷം)",
my: "Menyumbang kepada", my: "Menyumbang kepada (tahun lepas)",
sk: "Účasti", sk: "Účasti (minulý rok)",
tr: "Katkı Verildi", tr: "Katkı Verildi (geçen yıl)",
pl: "Kontrybucje", pl: "Kontrybucje (w zeszłym roku)",
uz: "Hissa qoʻshgan", uz: "Hissa qoʻshgan (o'tgan yili)",
vi: "Đã Đóng Góp", vi: "Đã Đóng Góp (năm ngoái)",
se: "Bidragit till", se: "Bidragit till (förra året)",
},
"statcard.reviews": {
ar: "تمت مراجعة إجمالي العلاقات العامة",
cn: "審查的 PR 總數",
"zh-tw": "审查的 PR 总数",
cs: "Celkový počet PR",
de: "Insgesamt überprüfte PRs",
en: "Total PRs reviewed",
bn: "সর্বমোট পুনরালোচনা করা PR",
es: "PR totales revisados",
fr: "Nombre total de PR examinés",
hu: "Összes ellenőrzött PR",
it: "PR totali esaminati",
ja: "レビューされた PR の総数",
kr: "검토된 총 PR",
nl: "Totaal beoordeelde PR's",
"pt-pt": "Total de PRs revistos",
"pt-br": "Total de PRs revisados",
np: "कुल पीआर समीक्षित",
el: "Σύνολο Αναθεωρημένων PR",
ru: "Всего pull request`ов проверено",
"uk-ua": "Всього pull request`iв перевірено",
id: "Total PR yang Direview",
my: "Jumlah PR Dikaji Semula",
sk: "Celkový počet PR",
tr: "İncelenen toplam PR",
pl: "Łącznie sprawdzonych PR",
uz: "Koʻrib chiqilgan PR-lar soni",
vi: "Tổng Số PR Đã Xem Xét",
se: "Totalt antal granskade PR",
},
"statcard.discussions-started": {
ar: "مجموع بدء المناقشات",
cn: "发起的讨论总数",
"zh-tw": "發起的討論總數",
cs: "Celkem zahájených diskusí",
de: "Gesamt gestartete Diskussionen",
en: "Total Discussions Started",
bn: "সর্বমোট আলোচনা শুরু",
es: "Discusiones totales iniciadas",
fr: "Nombre total de discussions lancées",
hu: "Összes megkezdett megbeszélés",
it: "Discussioni totali avviate",
ja: "開始されたディスカッションの総数",
kr: "시작된 토론 총 수",
nl: "Totaal gestarte discussies",
"pt-pt": "Total de Discussões Iniciadas",
"pt-br": "Total de Discussões Iniciadas",
np: "कुल चर्चा सुरु",
el: "Σύνολο Συζητήσεων που Ξεκίνησαν",
ru: "Всего начатых дискуссий",
"uk-ua": "Всього розпочатих дискусій",
id: "Total Diskusi Dimulai",
my: "Jumlah Perbincangan Bermula",
sk: "Celkový počet začatých diskusií",
tr: "Başlatılan Toplam Tartışma",
pl: "Łącznie rozpoczętych dyskusji",
uz: "Boshlangan muzokaralar soni",
vi: "Tổng Số Thảo Luận Bắt Đầu",
se: "Totalt antal diskussioner startade",
},
"statcard.discussions-answered": {
ar: "مجموع الردود على المناقشات",
cn: "回复的讨论总数",
"zh-tw": "回覆的討論總數",
cs: "Celkem zodpovězených diskusí",
de: "Gesamt beantwortete Diskussionen",
en: "Total Discussions Answered",
bn: "সর্বমোট আলোচনা উত্তর",
es: "Discusiones totales respondidas",
fr: "Nombre total de discussions répondues",
hu: "Összes megválaszolt megbeszélés",
it: "Discussioni totali risposte",
ja: "回答されたディスカッションの総数",
kr: "답변된 토론 총 수",
nl: "Totaal beantwoorde discussies",
"pt-pt": "Total de Discussões Respondidas",
"pt-br": "Total de Discussões Respondidas",
np: "कुल चर्चा उत्तर",
el: "Σύνολο Συζητήσεων που Απαντήθηκαν",
ru: "Всего отвеченных дискуссий",
"uk-ua": "Всього відповідей на дискусії",
id: "Total Diskusi Dibalas",
my: "Jumlah Perbincangan Dijawab",
sk: "Celkový počet zodpovedaných diskusií",
tr: "Toplam Cevaplanan Tartışma",
pl: "Łącznie odpowiedzianych dyskusji",
uz: "Javob berilgan muzokaralar soni",
vi: "Tổng Số Thảo Luận Đã Trả Lời",
se: "Totalt antal diskussioner besvarade",
}, },
}; };
}; };
@@ -276,7 +375,7 @@ const langCardLocales = {
np: "अधिक प्रयोग गरिएको भाषाहरू", np: "अधिक प्रयोग गरिएको भाषाहरू",
el: "Οι περισσότερο χρησιμοποιούμενες γλώσσες", el: "Οι περισσότερο χρησιμοποιούμενες γλώσσες",
ru: "Наиболее часто используемые языки", ru: "Наиболее часто используемые языки",
"uk-ua": "Найбільш часто використовувані мови", "uk-ua": "Найчастіше використовувані мови",
id: "Bahasa Yang Paling Banyak Digunakan", id: "Bahasa Yang Paling Banyak Digunakan",
ml: "കൂടുതൽ ഉപയോഗിച്ച ഭാഷകൾ", ml: "കൂടുതൽ ഉപയോഗിച്ച ഭാഷകൾ",
my: "Bahasa Paling Digunakan", my: "Bahasa Paling Digunakan",
@@ -286,6 +385,36 @@ const langCardLocales = {
vi: "Ngôn Ngữ Thường Sử Dụng", vi: "Ngôn Ngữ Thường Sử Dụng",
se: "Mest använda språken", se: "Mest använda språken",
}, },
"langcard.nodata": {
ar: "لا توجد بيانات لغات.",
cn: "沒有語言數據。",
"zh-tw": "沒有語言數據。",
cs: "Žádné jazykové údaje.",
de: "Keine Sprachdaten.",
bn: "কোন ভাষার ডেটা নেই।",
en: "No languages data.",
es: "Sin datos de idiomas.",
fr: "Aucune donnée sur les langues.",
hu: "Nincsenek nyelvi adatok.",
it: "Nessun dato sulle lingue.",
ja: "言語データがありません。",
kr: "언어 데이터가 없습니다.",
nl: "Ingen sprogdata.",
"pt-pt": "Sem dados de idiomas.",
"pt-br": "Sem dados de idiomas.",
np: "कुनै भाषा डाटा छैन।",
el: "Δεν υπάρχουν δεδομένα γλωσσών.",
ru: "Нет данных о языках.",
"uk-ua": "Немає даних про мови.",
id: "Tidak ada data bahasa.",
ml: "ഭാഷാ ഡാറ്റയില്ല.",
my: "Tiada data bahasa.",
sk: "Žiadne údaje o jazykoch.",
tr: "Dil verisi yok.",
pl: "Brak danych dotyczących języków.",
vi: "Không có dữ liệu ngôn ngữ.",
se: "Inga språkdata.",
},
}; };
const wakatimeCardLocales = { const wakatimeCardLocales = {
@@ -315,10 +444,132 @@ const wakatimeCardLocales = {
my: "Statistik Wakatime", my: "Statistik Wakatime",
sk: "Wakatime štatistika", sk: "Wakatime štatistika",
tr: "Waketime İstatistikler", tr: "Waketime İstatistikler",
pl: "statystyki Wakatime", pl: "Statystyki Wakatime",
vi: "Thống Kê Wakatime", vi: "Thống Kê Wakatime",
se: "Wakatime statistik", se: "Wakatime statistik",
}, },
"wakatimecard.lastyear": {
ar: "العام الماضي",
cn: "去年",
"zh-tw": "去年",
cs: "Minulý rok",
de: "Letztes Jahr",
en: "last year",
bn: "গত বছর",
es: "El año pasado",
fr: "L'année dernière",
hu: "Tavaly",
it: "L'anno scorso",
ja: "昨年",
kr: "작년",
nl: "Vorig jaar",
"pt-pt": "Ano passado",
"pt-br": "Ano passado",
np: "गत वर्ष",
el: "Πέρυσι",
ru: "За прошлый год",
"uk-ua": "За минулий рік",
id: "Tahun lalu",
ml: "കഴിഞ്ഞ വർഷം",
my: "Tahun lepas",
sk: "Minulý rok",
tr: "Geçen yıl",
pl: "W zeszłym roku",
vi: "Năm ngoái",
se: "Förra året",
},
"wakatimecard.last7days": {
ar: "آخر 7 أيام",
cn: "最近 7 天",
"zh-tw": "最近 7 天",
cs: "Posledních 7 dní",
de: "Letzte 7 Tage",
en: "last 7 days",
bn: "গত দিন",
es: "Últimos 7 días",
fr: "7 derniers jours",
hu: "Elmúlt 7 nap",
it: "Ultimi 7 giorni",
ja: "過去 7 日間",
kr: "지난 7 일",
nl: "Afgelopen 7 dagen",
"pt-pt": "Últimos 7 dias",
"pt-br": "Últimos 7 dias",
np: "गत ७ दिन",
el: "Τελευταίες 7 ημέρες",
ru: "Последние 7 дней",
"uk-ua": "Останні 7 днів",
id: "7 hari terakhir",
ml: "കഴിഞ്ഞ 7 ദിവസം",
my: "7 hari lepas",
sk: "Posledných 7 dní",
tr: "Son 7 gün",
pl: "Ostatnie 7 dni",
vi: "7 ngày qua",
se: "Senaste 7 dagarna",
},
"wakatimecard.notpublic": {
ar: "ملف المستخدم غير عام",
cn: "Wakatime 用户个人资料未公开",
"zh-tw": "Wakatime 使用者個人資料未公開",
cs: "Profil uživatele Wakatime není veřejný",
de: "Wakatime-Benutzerprofil nicht öffentlich",
en: "Wakatime user profile not public",
bn: "Wakatime ব্যবহারকারীর প্রোফাইল প্রকাশ্য নয়",
es: "Perfil de usuario de Wakatime no público",
fr: "Profil utilisateur Wakatime non public",
hu: "A Wakatime felhasználói profilja nem nyilvános",
it: "Profilo utente Wakatime non pubblico",
ja: "Wakatime ユーザープロファイルは公開されていません",
kr: "Wakatime 사용자 프로필이 공개되지 않았습니다",
nl: "Wakatime gebruikersprofiel niet openbaar",
"pt-pt": "Perfil de usuário Wakatime não público",
"pt-br": "Perfil de usuário Wakatime não público",
np: "Wakatime प्रयोगकर्ता प्रोफाइल सार्वजनिक छैन",
el: "Το προφίλ χρήστη Wakatime δεν είναι δημόσιο",
ru: "Профиль пользователя Wakatime не является общедоступным",
"uk-ua": "Профіль користувача Wakatime не є публічним",
id: "Profil pengguna Wakatime tidak publik",
ml: "Wakatime ഉപയോക്തൃ പ്രൊഫൈൽ പൊതുവായി പ്രസിദ്ധീകരിക്കപ്പെടാത്തതാണ്",
my: "Profil pengguna Wakatime tidak awam",
sk: "Profil používateľa Wakatime nie je verejný",
tr: "Wakatime kullanıcı profili herkese açık değil",
pl: "Profil użytkownika Wakatime nie jest publiczny",
vi: "Hồ sơ người dùng Wakatime không công khai",
se: "Wakatime användarprofil inte offentlig",
},
"wakatimecard.nocodedetails": {
ar: "المستخدم لا يشارك معلومات تفصيلية عن البرمجة",
cn: "用户不公开分享详细的代码统计信息",
"zh-tw": "使用者不公開分享詳細的程式碼統計資訊",
cs: "Uživatel nesdílí podrobné statistiky kódu",
de: "Benutzer teilt keine detaillierten Code-Statistiken",
en: "User doesn't publicly share detailed code statistics",
bn: "ব্যবহারকারী বিস্তারিত কোড পরিসংখ্যান প্রকাশ করেন না",
es: "El usuario no comparte públicamente estadísticas detalladas de código",
fr: "L'utilisateur ne partage pas publiquement de statistiques de code détaillées",
hu: "A felhasználó nem osztja meg nyilvánosan a részletes kódstatisztikákat",
it: "L'utente non condivide pubblicamente statistiche dettagliate sul codice",
ja: "ユーザーは詳細なコード統計を公開しません",
kr: "사용자는 자세한 코드 통계를 공개하지 않습니다",
nl: "Gebruiker deelt geen gedetailleerde code-statistieken",
"pt-pt":
"O utilizador não partilha publicamente estatísticas detalhadas de código",
"pt-br":
"O usuário não compartilha publicamente estatísticas detalhadas de código",
np: "प्रयोगकर्ता सार्वजनिक रूपमा विस्तृत कोड तथ्याङ्क साझा गर्दैन",
el: "Ο χρήστης δεν δημοσιεύει δημόσια λεπτομερείς στατιστικές κώδικα",
ru: "Пользователь не делится подробной статистикой кода",
"uk-ua": "Користувач не публікує детальну статистику коду",
id: "Pengguna tidak membagikan statistik kode terperinci secara publik",
ml: "ഉപയോക്താവ് പൊതുവെ വിശദീകരിച്ച കോഡ് സ്റ്റാറ്റിസ്റ്റിക്സ് പങ്കിടുന്നില്ല",
my: "Pengguna tidak berkongsi statistik kod terperinci secara awam",
sk: "Používateľ neposkytuje verejne podrobné štatistiky kódu",
tr: "Kullanıcı ayrıntılı kod istatistiklerini herkese açık olarak paylaşmıyor",
pl: "Użytkownik nie udostępnia publicznie szczegółowych statystyk kodu",
vi: "Người dùng không chia sẻ thống kê mã chi tiết công khai",
se: "Användaren delar inte offentligt detaljerad kodstatistik",
},
"wakatimecard.nocodingactivity": { "wakatimecard.nocodingactivity": {
ar: "لا يوجد نشاط برمجي لهذا الأسبوع", ar: "لا يوجد نشاط برمجي لهذا الأسبوع",
cn: "本周没有编程活动", cn: "本周没有编程活动",
@@ -354,15 +605,21 @@ const wakatimeCardLocales = {
const availableLocales = Object.keys(repoCardLocales["repocard.archived"]); const availableLocales = Object.keys(repoCardLocales["repocard.archived"]);
function isLocaleAvailable(locale) { /**
* Checks whether the locale is available or not.
*
* @param {string} locale The locale to check.
* @returns {boolean} Boolean specifying whether the locale is available or not.
*/
const isLocaleAvailable = (locale) => {
return availableLocales.includes(locale.toLowerCase()); return availableLocales.includes(locale.toLowerCase());
} };
export { export {
isLocaleAvailable,
availableLocales, availableLocales,
statCardLocales, isLocaleAvailable,
repoCardLocales,
langCardLocales, langCardLocales,
repoCardLocales,
statCardLocales,
wakatimeCardLocales, wakatimeCardLocales,
}; };
@@ -42,6 +42,12 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1
font: 800 24px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58; font: 800 24px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58;
animation: scaleInAnimation 0.3s ease-in-out forwards; animation: scaleInAnimation 0.3s ease-in-out forwards;
} }
.rank-percentile-header {
font-size: 14px;
}
.rank-percentile-text {
font-size: 16px;
}
.not_bold { font-weight: 400 } .not_bold { font-weight: 400 }
.bold { font-weight: 700 } .bold { font-weight: 700 }
@@ -51,13 +57,13 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1
} }
.rank-circle-rim { .rank-circle-rim {
stroke: #2f80ed; stroke: undefined;
fill: none; fill: none;
stroke-width: 6; stroke-width: 6;
opacity: 0.2; opacity: 0.2;
} }
.rank-circle { .rank-circle {
stroke: #2f80ed; stroke: undefined;
stroke-dasharray: 250; stroke-dasharray: 250;
fill: none; fill: none;
stroke-width: 6; stroke-width: 6;
@@ -69,7 +75,29 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1
} }
@keyframes slideInAnimation {
from {
width: 0;
}
to {
width: calc(100%-100px);
}
}
@keyframes growWidthAnimation {
from {
width: 0;
}
to {
width: 100%;
}
}
.lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58 } .lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58 }
#rect-mask rect{
animation: slideInAnimation 1s ease-in-out forwards;
}
.lang-progress{
animation: growWidthAnimation 0.6s ease-in-out forwards;
}
@@ -101,7 +129,7 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1
y="0" y="0"
class="header" class="header"
data-testid="header" data-testid="header"
>Wakatime Stats</text> >Wakatime Stats (last 7 days)</text>
</g> </g>
</g> </g>
@@ -122,7 +150,7 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1
data-testid="lang-progress" data-testid="lang-progress"
x="0" x="0"
y="0" y="0"
width="6.6495" width="415.61699999999996"
height="8" height="8"
fill="#858585" fill="#858585"
/> />
@@ -130,9 +158,195 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1
<rect <rect
mask="url(#rect-mask)" mask="url(#rect-mask)"
data-testid="lang-progress" data-testid="lang-progress"
x="6.6495" x="415.61699999999996"
y="0" y="0"
width="0.465" width="29.0625"
height="8"
fill="#3178c6"
/>
<g transform="translate(25, 25)">
<circle cx="5" cy="6" r="5" fill="#858585" />
<text data-testid="lang-name" x="15" y="10" class='lang-name'>
Other - 19 mins
</text>
</g>
<g transform="translate(230, 25)">
<circle cx="5" cy="6" r="5" fill="#3178c6" />
<text data-testid="lang-name" x="15" y="10" class='lang-name'>
TypeScript - 1 min
</text>
</g>
</svg>
</g>
</svg>
"
`;
exports[`Test Render Wakatime Card should render correctly with compact layout when langs_count is set 1`] = `
"
<svg
width="495"
height="115"
viewBox="0 0 495 115"
fill="none"
xmlns="http://www.w3.org/2000/svg"
role="img"
aria-labelledby="descId"
>
<title id="titleId"></title>
<desc id="descId"></desc>
<style>
.header {
font: 600 18px 'Segoe UI', Ubuntu, Sans-Serif;
fill: #2f80ed;
animation: fadeInAnimation 0.8s ease-in-out forwards;
}
@supports(-moz-appearance: auto) {
/* Selector detects Firefox */
.header { font-size: 15.5px; }
}
.stat {
font: 600 14px 'Segoe UI', Ubuntu, "Helvetica Neue", Sans-Serif; fill: #434d58;
}
@supports(-moz-appearance: auto) {
/* Selector detects Firefox */
.stat { font-size:12px; }
}
.stagger {
opacity: 0;
animation: fadeInAnimation 0.3s ease-in-out forwards;
}
.rank-text {
font: 800 24px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58;
animation: scaleInAnimation 0.3s ease-in-out forwards;
}
.rank-percentile-header {
font-size: 14px;
}
.rank-percentile-text {
font-size: 16px;
}
.not_bold { font-weight: 400 }
.bold { font-weight: 700 }
.icon {
fill: #4c71f2;
display: none;
}
.rank-circle-rim {
stroke: undefined;
fill: none;
stroke-width: 6;
opacity: 0.2;
}
.rank-circle {
stroke: undefined;
stroke-dasharray: 250;
fill: none;
stroke-width: 6;
stroke-linecap: round;
opacity: 0.8;
transform-origin: -10px 8px;
transform: rotate(-90deg);
animation: rankAnimation 1s forwards ease-in-out;
}
@keyframes slideInAnimation {
from {
width: 0;
}
to {
width: calc(100%-100px);
}
}
@keyframes growWidthAnimation {
from {
width: 0;
}
to {
width: 100%;
}
}
.lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58 }
#rect-mask rect{
animation: slideInAnimation 1s ease-in-out forwards;
}
.lang-progress{
animation: growWidthAnimation 0.6s ease-in-out forwards;
}
</style>
<rect
data-testid="card-bg"
x="0.5"
y="0.5"
rx="4.5"
height="99%"
stroke="#e4e2e2"
width="494"
fill="#fffefe"
stroke-opacity="1"
/>
<g
data-testid="card-title"
transform="translate(25, 35)"
>
<g transform="translate(0, 0)">
<text
x="0"
y="0"
class="header"
data-testid="header"
>Wakatime Stats (last 7 days)</text>
</g>
</g>
<g
data-testid="main-card-body"
transform="translate(0, 55)"
>
<svg x="0" y="0" width="100%">
<mask id="rect-mask">
<rect x="25" y="0" width="440" height="8" fill="white" rx="5" />
</mask>
<rect
mask="url(#rect-mask)"
data-testid="lang-progress"
x="0"
y="0"
width="436.4025"
height="8"
fill="#858585"
/>
<rect
mask="url(#rect-mask)"
data-testid="lang-progress"
x="436.4025"
y="0"
width="30.503999999999998"
height="8" height="8"
fill="#3178c6" fill="#3178c6"
/> />
+90 -41
View File
@@ -12,35 +12,47 @@ const stats = {
totalCommits: 200, totalCommits: 200,
totalIssues: 300, totalIssues: 300,
totalPRs: 400, totalPRs: 400,
contributedTo: 500, totalReviews: 50,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
contributedTo: 50,
rank: null, rank: null,
}; };
stats.rank = calculateRank({ stats.rank = calculateRank({
totalCommits: stats.totalCommits, all_commits: false,
totalRepos: 1, commits: stats.totalCommits,
followers: 0,
contributions: stats.contributedTo,
stargazers: stats.totalStars,
prs: stats.totalPRs, prs: stats.totalPRs,
issues: stats.totalIssues, issues: stats.totalIssues,
repos: 1,
stars: stats.totalStars,
followers: 0,
}); });
const data = { const data_stats = {
data: { data: {
user: { user: {
name: stats.name, name: stats.name,
repositoriesContributedTo: { totalCount: stats.contributedTo }, repositoriesContributedTo: { totalCount: stats.contributedTo },
contributionsCollection: { contributionsCollection: {
totalCommitContributions: stats.totalCommits, totalCommitContributions: stats.totalCommits,
restrictedContributionsCount: 100, totalPullRequestReviewContributions: stats.totalReviews,
}, },
pullRequests: { totalCount: stats.totalPRs }, pullRequests: { totalCount: stats.totalPRs },
openIssues: { totalCount: stats.totalIssues }, openIssues: { totalCount: stats.totalIssues },
closedIssues: { totalCount: 0 }, closedIssues: { totalCount: 0 },
followers: { totalCount: 0 }, followers: { totalCount: 0 },
repositoryDiscussions: { totalCount: stats.totalDiscussionsStarted },
repositoryDiscussionComments: {
totalCount: stats.totalDiscussionsAnswered,
},
repositories: { repositories: {
totalCount: 1, totalCount: 1,
nodes: [{ stargazers: { totalCount: 100 } }], nodes: [{ stargazers: { totalCount: 100 } }],
pageInfo: {
hasNextPage: false,
endCursor: "cursor",
},
}, },
}, },
}, },
@@ -70,7 +82,7 @@ const faker = (query, data) => {
setHeader: jest.fn(), setHeader: jest.fn(),
send: jest.fn(), send: jest.fn(),
}; };
mock.onPost("https://api.github.com/graphql").reply(200, data); mock.onPost("https://api.github.com/graphql").replyOnce(200, data);
return { req, res }; return { req, res };
}; };
@@ -81,7 +93,7 @@ afterEach(() => {
describe("Test /api/", () => { describe("Test /api/", () => {
it("should test the request", async () => { it("should test the request", async () => {
const { req, res } = faker({}, data); const { req, res } = faker({}, data_stats);
await api(req, res); await api(req, res);
@@ -116,7 +128,7 @@ describe("Test /api/", () => {
text_color: "fff", text_color: "fff",
bg_color: "fff", bg_color: "fff",
}, },
data, data_stats,
); );
await api(req, res); await api(req, res);
@@ -137,89 +149,126 @@ describe("Test /api/", () => {
}); });
it("should have proper cache", async () => { it("should have proper cache", async () => {
const { req, res } = faker({}, data); const { req, res } = faker({}, data_stats);
mock.onPost("https://api.github.com/graphql").reply(200, data);
await api(req, res); await api(req, res);
expect(res.setHeader.mock.calls).toEqual([ expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "image/svg+xml"], ["Content-Type", "image/svg+xml"],
["Cache-Control", `public, max-age=${CONSTANTS.FOUR_HOURS}`], [
"Cache-Control",
`max-age=${CONSTANTS.FOUR_HOURS / 2}, s-maxage=${
CONSTANTS.FOUR_HOURS
}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
],
]); ]);
}); });
it("should set proper cache", async () => { it("should set proper cache", async () => {
const { req, res } = faker({ cache_seconds: 15000 }, data); const { req, res } = faker({ cache_seconds: 15000 }, data_stats);
await api(req, res); await api(req, res);
expect(res.setHeader.mock.calls).toEqual([ expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "image/svg+xml"], ["Content-Type", "image/svg+xml"],
["Cache-Control", `public, max-age=${15000}`], [
"Cache-Control",
`max-age=7500, s-maxage=${15000}, stale-while-revalidate=${
CONSTANTS.ONE_DAY
}`,
],
]);
});
it("should not store cache when error", async () => {
const { req, res } = faker({}, error);
await api(req, res);
expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "image/svg+xml"],
["Cache-Control", `no-cache, no-store, must-revalidate`],
]); ]);
}); });
it("should set proper cache with clamped values", async () => { it("should set proper cache with clamped values", async () => {
{ {
let { req, res } = faker({ cache_seconds: 200000 }, data); let { req, res } = faker({ cache_seconds: 200000 }, data_stats);
await api(req, res); await api(req, res);
expect(res.setHeader.mock.calls).toEqual([ expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "image/svg+xml"], ["Content-Type", "image/svg+xml"],
["Cache-Control", `public, max-age=${CONSTANTS.ONE_DAY}`], [
"Cache-Control",
`max-age=${CONSTANTS.ONE_DAY / 2}, s-maxage=${
CONSTANTS.ONE_DAY
}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
],
]); ]);
} }
// note i'm using block scoped vars // note i'm using block scoped vars
{ {
let { req, res } = faker({ cache_seconds: 0 }, data); let { req, res } = faker({ cache_seconds: 0 }, data_stats);
await api(req, res); await api(req, res);
expect(res.setHeader.mock.calls).toEqual([ expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "image/svg+xml"], ["Content-Type", "image/svg+xml"],
["Cache-Control", `public, max-age=${CONSTANTS.FOUR_HOURS}`], [
"Cache-Control",
`max-age=${CONSTANTS.FOUR_HOURS / 2}, s-maxage=${
CONSTANTS.FOUR_HOURS
}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
],
]); ]);
} }
{ {
let { req, res } = faker({ cache_seconds: -10000 }, data); let { req, res } = faker({ cache_seconds: -10000 }, data_stats);
await api(req, res); await api(req, res);
expect(res.setHeader.mock.calls).toEqual([ expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "image/svg+xml"], ["Content-Type", "image/svg+xml"],
["Cache-Control", `public, max-age=${CONSTANTS.FOUR_HOURS}`], [
"Cache-Control",
`max-age=${CONSTANTS.FOUR_HOURS / 2}, s-maxage=${
CONSTANTS.FOUR_HOURS
}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
],
]); ]);
} }
}); });
it("should add private contributions", async () => { it("should allow changing ring_color", async () => {
const { req, res } = faker( const { req, res } = faker(
{ {
username: "anuraghazra", username: "anuraghazra",
count_private: true, hide: "issues,prs,contribs",
show_icons: true,
hide_border: true,
line_height: 100,
title_color: "fff",
ring_color: "0000ff",
icon_color: "fff",
text_color: "fff",
bg_color: "fff",
}, },
data, data_stats,
); );
await api(req, res); await api(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "image/svg+xml"); expect(res.setHeader).toBeCalledWith("Content-Type", "image/svg+xml");
expect(res.send).toBeCalledWith( expect(res.send).toBeCalledWith(
renderStatsCard( renderStatsCard(stats, {
{ hide: ["issues", "prs", "contribs"],
...stats, show_icons: true,
totalCommits: stats.totalCommits + 100, hide_border: true,
rank: calculateRank({ line_height: 100,
totalCommits: stats.totalCommits + 100, title_color: "fff",
totalRepos: 1, ring_color: "0000ff",
followers: 0, icon_color: "fff",
contributions: stats.contributedTo, text_color: "fff",
stargazers: stats.totalStars, bg_color: "fff",
prs: stats.totalPRs, }),
issues: stats.totalIssues,
}),
},
{},
),
); );
}); });
}); });
+93 -9
View File
@@ -2,17 +2,101 @@ import "@testing-library/jest-dom";
import { calculateRank } from "../src/calculateRank.js"; import { calculateRank } from "../src/calculateRank.js";
describe("Test calculateRank", () => { describe("Test calculateRank", () => {
it("should calculate rank correctly", () => { it("new user gets C rank", () => {
expect( expect(
calculateRank({ calculateRank({
totalCommits: 100, all_commits: false,
totalRepos: 5, commits: 0,
followers: 100, prs: 0,
contributions: 61, issues: 0,
stargazers: 400, repos: 0,
prs: 300, stars: 0,
issues: 200, followers: 0,
}), }),
).toStrictEqual({ level: "A+", score: 49.16605417270399 }); ).toStrictEqual({ level: "C", percentile: 100 });
});
it("beginner user gets B- rank", () => {
expect(
calculateRank({
all_commits: false,
commits: 125,
prs: 25,
issues: 10,
repos: 0,
stars: 25,
followers: 5,
}),
).toStrictEqual({ level: "B-", percentile: 69.333868386557 });
});
it("median user gets B+ rank", () => {
expect(
calculateRank({
all_commits: false,
commits: 250,
prs: 50,
issues: 25,
repos: 0,
stars: 50,
followers: 10,
}),
).toStrictEqual({ level: "B+", percentile: 50 });
});
it("average user gets B+ rank (include_all_commits)", () => {
expect(
calculateRank({
all_commits: true,
commits: 1000,
prs: 50,
issues: 25,
repos: 0,
stars: 50,
followers: 10,
}),
).toStrictEqual({ level: "B+", percentile: 50 });
});
it("advanced user gets A rank", () => {
expect(
calculateRank({
all_commits: false,
commits: 500,
prs: 100,
issues: 50,
repos: 0,
stars: 200,
followers: 40,
}),
).toStrictEqual({ level: "A", percentile: 22.72727272727273 });
});
it("expert user gets A+ rank", () => {
expect(
calculateRank({
all_commits: false,
commits: 1000,
prs: 200,
issues: 100,
repos: 0,
stars: 800,
followers: 160,
}),
).toStrictEqual({ level: "A+", percentile: 6.082887700534744 });
});
it("sindresorhus gets S rank", () => {
expect(
calculateRank({
all_commits: false,
commits: 1300,
prs: 1500,
issues: 4500,
repos: 0,
stars: 600000,
followers: 50000,
}),
).toStrictEqual({ level: "S", percentile: 0.49947889605312934 });
}); });
}); });
+40 -34
View File
@@ -11,27 +11,22 @@ import { renderStatsCard } from "../../src/cards/stats-card.js";
import { renderTopLanguages } from "../../src/cards/top-languages-card.js"; import { renderTopLanguages } from "../../src/cards/top-languages-card.js";
import { renderWakatimeCard } from "../../src/cards/wakatime-card.js"; import { renderWakatimeCard } from "../../src/cards/wakatime-card.js";
// Script variables const REPO = "curly-fiesta";
const REPO = "dummy-cra"; const USER = "catelinemnemosyne";
const USER = "grsdummy";
const STATS_DATA = { const STATS_DATA = {
name: "grsdummy", name: "Cateline Mnemosyne",
totalPRs: 2, totalPRs: 2,
totalCommits: 2, totalCommits: 8,
totalIssues: 1, totalIssues: 1,
totalStars: 1, totalStars: 1,
contributedTo: 2, contributedTo: 1,
rank: { rank: {
level: "A+", level: "C",
score: 51.01013099671447, percentile: 97.89377603631637,
}, },
}; };
const LANGS_DATA = { const LANGS_DATA = {
TypeScript: {
color: "#3178c6",
name: "TypeScript",
size: 2049,
},
HTML: { HTML: {
color: "#e34c26", color: "#e34c26",
name: "HTML", name: "HTML",
@@ -42,47 +37,51 @@ const LANGS_DATA = {
name: "CSS", name: "CSS",
size: 930, size: 930,
}, },
Python: { JavaScript: {
color: "#3572A5", color: "#f1e05a",
name: "Python", name: "JavaScript",
size: 671, size: 1912,
}, },
}; };
const WAKATIME_DATA = { const WAKATIME_DATA = {
human_readable_range: "last week", human_readable_range: "last week",
is_already_updating: false, is_already_updating: false,
is_coding_activity_visible: false, is_coding_activity_visible: true,
is_including_today: false, is_including_today: false,
is_other_usage_visible: false, is_other_usage_visible: true,
is_stuck: false, is_stuck: false,
is_up_to_date: false, is_up_to_date: false,
is_up_to_date_pending_future: false, is_up_to_date_pending_future: false,
percent_calculated: 0, percent_calculated: 0,
range: "last_7_days", range: "all_time",
status: "pending_update", status: "pending_update",
timeout: 15, timeout: 15,
username: "grsdummy", username: USER,
writes_only: false, writes_only: false,
}; };
const REPOSITORY_DATA = { const REPOSITORY_DATA = {
name: "dummy-cra", name: REPO,
nameWithOwner: "grsdummy/dummy-cra", nameWithOwner: `${USER}/cra-test`,
isPrivate: false, isPrivate: false,
isArchived: false, isArchived: false,
isTemplate: false, isTemplate: false,
stargazers: { stargazers: {
totalCount: 1, totalCount: 1,
}, },
description: "Dummy create react app.", description: "Simple cra test repo.",
primaryLanguage: { primaryLanguage: {
color: "#3178c6", color: "#f1e05a",
id: "MDg6TGFuZ3VhZ2UyODc=", id: "MDg6TGFuZ3VhZ2UxNDA=",
name: "TypeScript", name: "JavaScript",
}, },
forkCount: 0, forkCount: 0,
starCount: 1, starCount: 1,
}; };
const CACHE_BURST_STRING = `v=${new Date().getTime()}`;
describe("Fetch Cards", () => { describe("Fetch Cards", () => {
let VERCEL_PREVIEW_URL; let VERCEL_PREVIEW_URL;
@@ -104,19 +103,24 @@ describe("Fetch Cards", () => {
// Get the Vercel preview stats card response. // Get the Vercel preview stats card response.
const serverStatsSvg = await axios.get( const serverStatsSvg = await axios.get(
`${VERCEL_PREVIEW_URL}/api?username=${USER}`, `${VERCEL_PREVIEW_URL}/api?username=${USER}&${CACHE_BURST_STRING}`,
); );
// Check if stats card from deployment matches the stats card from local. // Check if stats card from deployment matches the stats card from local.
expect(serverStatsSvg.data).toEqual(localStatsCardSVG); expect(serverStatsSvg.data).toEqual(localStatsCardSVG);
}); }, 7000);
test("retrieve language card", async () => { test("retrieve language card", async () => {
expect(VERCEL_PREVIEW_URL).toBeDefined(); expect(VERCEL_PREVIEW_URL).toBeDefined();
// Check if the Vercel preview instance language card function is up and running. // Check if the Vercel preview instance language card function is up and running.
console.log(
`${VERCEL_PREVIEW_URL}/api/top-langs/?username=${USER}&${CACHE_BURST_STRING}`,
);
await expect( await expect(
axios.get(`${VERCEL_PREVIEW_URL}/api/top-langs/?username=${USER}`), axios.get(
`${VERCEL_PREVIEW_URL}/api/top-langs/?username=${USER}&${CACHE_BURST_STRING}`,
),
).resolves.not.toThrow(); ).resolves.not.toThrow();
// Get local language card. // Get local language card.
@@ -124,7 +128,7 @@ describe("Fetch Cards", () => {
// Get the Vercel preview language card response. // Get the Vercel preview language card response.
const severLanguageSVG = await axios.get( const severLanguageSVG = await axios.get(
`${VERCEL_PREVIEW_URL}/api/top-langs/?username=${USER}`, `${VERCEL_PREVIEW_URL}/api/top-langs/?username=${USER}&${CACHE_BURST_STRING}`,
); );
// Check if language card from deployment matches the local language card. // Check if language card from deployment matches the local language card.
@@ -144,7 +148,7 @@ describe("Fetch Cards", () => {
// Get the Vercel preview WakaTime card response. // Get the Vercel preview WakaTime card response.
const serverWakaTimeSvg = await axios.get( const serverWakaTimeSvg = await axios.get(
`${VERCEL_PREVIEW_URL}/api/wakatime?username=${USER}`, `${VERCEL_PREVIEW_URL}/api/wakatime?username=${USER}&${CACHE_BURST_STRING}`,
); );
// Check if WakaTime card from deployment matches the local WakaTime card. // Check if WakaTime card from deployment matches the local WakaTime card.
@@ -156,7 +160,9 @@ describe("Fetch Cards", () => {
// Check if the Vercel preview instance Repo function is up and running. // Check if the Vercel preview instance Repo function is up and running.
await expect( await expect(
axios.get(`${VERCEL_PREVIEW_URL}/api/pin/?username=${USER}&repo=${REPO}`), axios.get(
`${VERCEL_PREVIEW_URL}/api/pin/?username=${USER}&repo=${REPO}&${CACHE_BURST_STRING}`,
),
).resolves.not.toThrow(); ).resolves.not.toThrow();
// Get local repo card. // Get local repo card.
@@ -164,7 +170,7 @@ describe("Fetch Cards", () => {
// Get the Vercel preview repo card response. // Get the Vercel preview repo card response.
const serverRepoSvg = await axios.get( const serverRepoSvg = await axios.get(
`${VERCEL_PREVIEW_URL}/api/pin/?username=${USER}&repo=${REPO}`, `${VERCEL_PREVIEW_URL}/api/pin/?username=${USER}&repo=${REPO}&${CACHE_BURST_STRING}`,
); );
// Check if Repo card from deployment matches the local Repo card. // Check if Repo card from deployment matches the local Repo card.
+1
View File
@@ -23,6 +23,7 @@ const data_user = {
organization: null, organization: null,
}, },
}; };
const data_org = { const data_org = {
data: { data: {
user: null, user: null,
+202 -52
View File
@@ -4,28 +4,70 @@ import MockAdapter from "axios-mock-adapter";
import { calculateRank } from "../src/calculateRank.js"; import { calculateRank } from "../src/calculateRank.js";
import { fetchStats } from "../src/fetchers/stats-fetcher.js"; import { fetchStats } from "../src/fetchers/stats-fetcher.js";
const data = { // Test parameters.
const data_stats = {
data: { data: {
user: { user: {
name: "Anurag Hazra", name: "Anurag Hazra",
repositoriesContributedTo: { totalCount: 61 }, repositoriesContributedTo: { totalCount: 61 },
contributionsCollection: { contributionsCollection: {
totalCommitContributions: 100, totalCommitContributions: 100,
restrictedContributionsCount: 50, totalPullRequestReviewContributions: 50,
}, },
pullRequests: { totalCount: 300 }, pullRequests: { totalCount: 300 },
openIssues: { totalCount: 100 }, openIssues: { totalCount: 100 },
closedIssues: { totalCount: 100 }, closedIssues: { totalCount: 100 },
followers: { totalCount: 100 }, followers: { totalCount: 100 },
repositoryDiscussions: { totalCount: 10 },
repositoryDiscussionComments: { totalCount: 40 },
repositories: { repositories: {
totalCount: 5, totalCount: 5,
nodes: [ nodes: [
{ name: "test-repo-1", stargazers: { totalCount: 100 } }, { name: "test-repo-1", stargazers: { totalCount: 100 } },
{ name: "test-repo-2", stargazers: { totalCount: 100 } }, { name: "test-repo-2", stargazers: { totalCount: 100 } },
{ name: "test-repo-3", stargazers: { totalCount: 100 } }, { name: "test-repo-3", stargazers: { totalCount: 100 } },
],
pageInfo: {
hasNextPage: true,
endCursor: "cursor",
},
},
},
},
};
const data_repo = {
data: {
user: {
repositories: {
nodes: [
{ name: "test-repo-4", stargazers: { totalCount: 50 } }, { name: "test-repo-4", stargazers: { totalCount: 50 } },
{ name: "test-repo-5", stargazers: { totalCount: 50 } }, { name: "test-repo-5", stargazers: { totalCount: 50 } },
], ],
pageInfo: {
hasNextPage: false,
endCursor: "cursor",
},
},
},
},
};
const data_repo_zero_stars = {
data: {
user: {
repositories: {
nodes: [
{ name: "test-repo-1", stargazers: { totalCount: 100 } },
{ name: "test-repo-2", stargazers: { totalCount: 100 } },
{ name: "test-repo-3", stargazers: { totalCount: 100 } },
{ name: "test-repo-4", stargazers: { totalCount: 0 } },
{ name: "test-repo-5", stargazers: { totalCount: 0 } },
],
pageInfo: {
hasNextPage: true,
endCursor: "cursor",
},
}, },
}, },
}, },
@@ -44,23 +86,31 @@ const error = {
const mock = new MockAdapter(axios); const mock = new MockAdapter(axios);
beforeEach(() => {
process.env.FETCH_MULTI_PAGE_STARS = "false"; // Set to `false` to fetch only one page of stars.
mock.onPost("https://api.github.com/graphql").reply((cfg) => {
return [
200,
cfg.data.includes("contributionsCollection") ? data_stats : data_repo,
];
});
});
afterEach(() => { afterEach(() => {
mock.reset(); mock.reset();
}); });
describe("Test fetchStats", () => { describe("Test fetchStats", () => {
it("should fetch correct stats", async () => { it("should fetch correct stats", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data);
let stats = await fetchStats("anuraghazra"); let stats = await fetchStats("anuraghazra");
const rank = calculateRank({ const rank = calculateRank({
totalCommits: 100, all_commits: false,
totalRepos: 5, commits: 100,
followers: 100,
contributions: 61,
stargazers: 400,
prs: 300, prs: 300,
issues: 200, issues: 200,
repos: 5,
stars: 300,
followers: 100,
}); });
expect(stats).toStrictEqual({ expect(stats).toStrictEqual({
@@ -69,12 +119,49 @@ describe("Test fetchStats", () => {
totalCommits: 100, totalCommits: 100,
totalIssues: 200, totalIssues: 200,
totalPRs: 300, totalPRs: 300,
totalStars: 400, totalReviews: 50,
totalStars: 300,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank,
});
});
it("should stop fetching when there are repos with zero stars", async () => {
mock.reset();
mock
.onPost("https://api.github.com/graphql")
.replyOnce(200, data_stats)
.onPost("https://api.github.com/graphql")
.replyOnce(200, data_repo_zero_stars);
let stats = await fetchStats("anuraghazra");
const rank = calculateRank({
all_commits: false,
commits: 100,
prs: 300,
issues: 200,
repos: 5,
stars: 300,
followers: 100,
});
expect(stats).toStrictEqual({
contributedTo: 61,
name: "Anurag Hazra",
totalCommits: 100,
totalIssues: 200,
totalPRs: 300,
totalReviews: 50,
totalStars: 300,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank, rank,
}); });
}); });
it("should throw error", async () => { it("should throw error", async () => {
mock.reset();
mock.onPost("https://api.github.com/graphql").reply(200, error); mock.onPost("https://api.github.com/graphql").reply(200, error);
await expect(fetchStats("anuraghazra")).rejects.toThrow( await expect(fetchStats("anuraghazra")).rejects.toThrow(
@@ -82,83 +169,146 @@ describe("Test fetchStats", () => {
); );
}); });
it("should fetch and add private contributions", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data);
let stats = await fetchStats("anuraghazra", true);
const rank = calculateRank({
totalCommits: 150,
totalRepos: 5,
followers: 100,
contributions: 61,
stargazers: 400,
prs: 300,
issues: 200,
});
expect(stats).toStrictEqual({
contributedTo: 61,
name: "Anurag Hazra",
totalCommits: 150,
totalIssues: 200,
totalPRs: 300,
totalStars: 400,
rank,
});
});
it("should fetch total commits", async () => { it("should fetch total commits", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data);
mock mock
.onGet("https://api.github.com/search/commits?q=author:anuraghazra") .onGet("https://api.github.com/search/commits?q=author:anuraghazra")
.reply(200, { total_count: 1000 }); .reply(200, { total_count: 1000 });
let stats = await fetchStats("anuraghazra", true, true); let stats = await fetchStats("anuraghazra", true);
const rank = calculateRank({ const rank = calculateRank({
totalCommits: 1050, all_commits: true,
totalRepos: 5, commits: 1000,
followers: 100,
contributions: 61,
stargazers: 400,
prs: 300, prs: 300,
issues: 200, issues: 200,
repos: 5,
stars: 300,
followers: 100,
}); });
expect(stats).toStrictEqual({ expect(stats).toStrictEqual({
contributedTo: 61, contributedTo: 61,
name: "Anurag Hazra", name: "Anurag Hazra",
totalCommits: 1050, totalCommits: 1000,
totalIssues: 200, totalIssues: 200,
totalPRs: 300, totalPRs: 300,
totalStars: 400, totalReviews: 50,
totalStars: 300,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank, rank,
}); });
}); });
it("should exclude stars of the `test-repo-1` repository", async () => { it("should exclude stars of the `test-repo-1` repository", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data);
mock mock
.onGet("https://api.github.com/search/commits?q=author:anuraghazra") .onGet("https://api.github.com/search/commits?q=author:anuraghazra")
.reply(200, { total_count: 1000 }); .reply(200, { total_count: 1000 });
let stats = await fetchStats("anuraghazra", true, true, ["test-repo-1"]); let stats = await fetchStats("anuraghazra", true, ["test-repo-1"]);
const rank = calculateRank({ const rank = calculateRank({
totalCommits: 1050, all_commits: true,
totalRepos: 5, commits: 1000,
followers: 100,
contributions: 61,
stargazers: 300,
prs: 300, prs: 300,
issues: 200, issues: 200,
repos: 5,
stars: 200,
followers: 100,
}); });
expect(stats).toStrictEqual({ expect(stats).toStrictEqual({
contributedTo: 61, contributedTo: 61,
name: "Anurag Hazra", name: "Anurag Hazra",
totalCommits: 1050, totalCommits: 1000,
totalIssues: 200, totalIssues: 200,
totalPRs: 300, totalPRs: 300,
totalReviews: 50,
totalStars: 200,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank,
});
});
it("should fetch two pages of stars if 'FETCH_MULTI_PAGE_STARS' env variable is set to `true`", async () => {
process.env.FETCH_MULTI_PAGE_STARS = true;
let stats = await fetchStats("anuraghazra");
const rank = calculateRank({
all_commits: false,
commits: 100,
prs: 300,
issues: 200,
repos: 5,
stars: 400,
followers: 100,
});
expect(stats).toStrictEqual({
contributedTo: 61,
name: "Anurag Hazra",
totalCommits: 100,
totalIssues: 200,
totalPRs: 300,
totalReviews: 50,
totalStars: 400,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank,
});
});
it("should fetch one page of stars if 'FETCH_MULTI_PAGE_STARS' env variable is set to `false`", async () => {
process.env.FETCH_MULTI_PAGE_STARS = "false";
let stats = await fetchStats("anuraghazra");
const rank = calculateRank({
all_commits: false,
commits: 100,
prs: 300,
issues: 200,
repos: 5,
stars: 300,
followers: 100,
});
expect(stats).toStrictEqual({
contributedTo: 61,
name: "Anurag Hazra",
totalCommits: 100,
totalIssues: 200,
totalPRs: 300,
totalReviews: 50,
totalStars: 300, totalStars: 300,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank,
});
});
it("should fetch one page of stars if 'FETCH_MULTI_PAGE_STARS' env variable is not set", async () => {
process.env.FETCH_MULTI_PAGE_STARS = undefined;
let stats = await fetchStats("anuraghazra");
const rank = calculateRank({
all_commits: false,
commits: 100,
prs: 300,
issues: 200,
repos: 5,
stars: 300,
followers: 100,
});
expect(stats).toStrictEqual({
contributedTo: 61,
name: "Anurag Hazra",
totalCommits: 100,
totalIssues: 200,
totalPRs: 300,
totalReviews: 50,
totalStars: 300,
totalDiscussionsStarted: 10,
totalDiscussionsAnswered: 40,
rank, rank,
}); });
}); });
+48 -4
View File
@@ -60,20 +60,22 @@ const error = {
}; };
describe("FetchTopLanguages", () => { describe("FetchTopLanguages", () => {
it("should fetch correct language data", async () => { it("should fetch correct language data while using the new calculation", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data_langs); mock.onPost("https://api.github.com/graphql").reply(200, data_langs);
let repo = await fetchTopLanguages("anuraghazra"); let repo = await fetchTopLanguages("anuraghazra", [], 0.5, 0.5);
expect(repo).toStrictEqual({ expect(repo).toStrictEqual({
HTML: { HTML: {
color: "#0f0", color: "#0f0",
count: 2,
name: "HTML", name: "HTML",
size: 200, size: 20.000000000000004,
}, },
javascript: { javascript: {
color: "#0ff", color: "#0ff",
count: 2,
name: "javascript", name: "javascript",
size: 200, size: 20.000000000000004,
}, },
}); });
}); });
@@ -85,17 +87,59 @@ describe("FetchTopLanguages", () => {
expect(repo).toStrictEqual({ expect(repo).toStrictEqual({
HTML: { HTML: {
color: "#0f0", color: "#0f0",
count: 1,
name: "HTML", name: "HTML",
size: 100, size: 100,
}, },
javascript: { javascript: {
color: "#0ff", color: "#0ff",
count: 2,
name: "javascript", name: "javascript",
size: 200, size: 200,
}, },
}); });
}); });
it("should fetch correct language data while using the old calculation", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data_langs);
let repo = await fetchTopLanguages("anuraghazra", [], 1, 0);
expect(repo).toStrictEqual({
HTML: {
color: "#0f0",
count: 2,
name: "HTML",
size: 200,
},
javascript: {
color: "#0ff",
count: 2,
name: "javascript",
size: 200,
},
});
});
it("should rank languages by the number of repositories they appear in", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, data_langs);
let repo = await fetchTopLanguages("anuraghazra", [], 0, 1);
expect(repo).toStrictEqual({
HTML: {
color: "#0f0",
count: 2,
name: "HTML",
size: 2,
},
javascript: {
color: "#0ff",
count: 2,
name: "javascript",
size: 2,
},
});
});
it("should throw error", async () => { it("should throw error", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, error); mock.onPost("https://api.github.com/graphql").reply(200, error);
+1 -1
View File
@@ -105,7 +105,7 @@ describe("Wakatime fetcher", () => {
const username = "anuraghazra"; const username = "anuraghazra";
mock mock
.onGet( .onGet(
`https://wakatime.com/api/v1/users/${username}/stats/?is_including_today=true`, `https://wakatime.com/api/v1/users/${username}/stats?is_including_today=true`,
) )
.reply(200, wakaTimeData); .reply(200, wakaTimeData);
+244
View File
@@ -0,0 +1,244 @@
/**
* @file Tests for the status/pat-info cloud function.
*/
import dotenv from "dotenv";
dotenv.config();
import { jest } from "@jest/globals";
import axios from "axios";
import MockAdapter from "axios-mock-adapter";
import patInfo, { RATE_LIMIT_SECONDS } from "../api/status/pat-info.js";
const mock = new MockAdapter(axios);
const successData = {
data: {
rateLimit: {
remaining: 4986,
},
},
};
const faker = (query) => {
const req = {
query: { ...query },
};
const res = {
setHeader: jest.fn(),
send: jest.fn(),
};
return { req, res };
};
const rate_limit_error = {
errors: [
{
type: "RATE_LIMITED",
message: "API rate limit exceeded for user ID.",
},
],
data: {
rateLimit: {
resetAt: Date.now(),
},
},
};
const other_error = {
errors: [
{
type: "SOME_ERROR",
message: "This is a error",
},
],
};
const bad_credentials_error = {
message: "Bad credentials",
};
afterEach(() => {
mock.reset();
});
describe("Test /api/status/pat-info", () => {
beforeAll(() => {
// reset patenv first so that dotenv doesn't populate them with local envs
process.env = {};
process.env.PAT_1 = "testPAT1";
process.env.PAT_2 = "testPAT2";
process.env.PAT_3 = "testPAT3";
process.env.PAT_4 = "testPAT4";
});
it("should return only 'validPATs' if all PATs are valid", async () => {
mock
.onPost("https://api.github.com/graphql")
.replyOnce(200, rate_limit_error)
.onPost("https://api.github.com/graphql")
.reply(200, successData);
const { req, res } = faker({}, {});
await patInfo(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(
JSON.stringify(
{
validPATs: ["PAT_2", "PAT_3", "PAT_4"],
expiredPATs: [],
exhaustedPATs: ["PAT_1"],
suspendedPATs: [],
errorPATs: [],
details: {
PAT_1: {
status: "exhausted",
remaining: 0,
resetIn: "0 minutes",
},
PAT_2: {
status: "valid",
remaining: 4986,
},
PAT_3: {
status: "valid",
remaining: 4986,
},
PAT_4: {
status: "valid",
remaining: 4986,
},
},
},
null,
2,
),
);
});
it("should return `errorPATs` if a PAT causes an error to be thrown", async () => {
mock
.onPost("https://api.github.com/graphql")
.replyOnce(200, other_error)
.onPost("https://api.github.com/graphql")
.reply(200, successData);
const { req, res } = faker({}, {});
await patInfo(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(
JSON.stringify(
{
validPATs: ["PAT_2", "PAT_3", "PAT_4"],
expiredPATs: [],
exhaustedPATs: [],
suspendedPATs: [],
errorPATs: ["PAT_1"],
details: {
PAT_1: {
status: "error",
error: {
type: "SOME_ERROR",
message: "This is a error",
},
},
PAT_2: {
status: "valid",
remaining: 4986,
},
PAT_3: {
status: "valid",
remaining: 4986,
},
PAT_4: {
status: "valid",
remaining: 4986,
},
},
},
null,
2,
),
);
});
it("should return `expiredPaths` if a PAT returns a 'Bad credentials' error", async () => {
mock
.onPost("https://api.github.com/graphql")
.replyOnce(404, bad_credentials_error)
.onPost("https://api.github.com/graphql")
.reply(200, successData);
const { req, res } = faker({}, {});
await patInfo(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(
JSON.stringify(
{
validPATs: ["PAT_2", "PAT_3", "PAT_4"],
expiredPATs: ["PAT_1"],
exhaustedPATs: [],
suspendedPATs: [],
errorPATs: [],
details: {
PAT_1: {
status: "expired",
},
PAT_2: {
status: "valid",
remaining: 4986,
},
PAT_3: {
status: "valid",
remaining: 4986,
},
PAT_4: {
status: "valid",
remaining: 4986,
},
},
},
null,
2,
),
);
});
it("should throw an error if something goes wrong", async () => {
mock.onPost("https://api.github.com/graphql").networkError();
const { req, res } = faker({}, {});
await patInfo(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith("Something went wrong: Network Error");
});
it("should have proper cache when no error is thrown", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, successData);
const { req, res } = faker({}, {});
await patInfo(req, res);
expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "application/json"],
["Cache-Control", `max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`],
]);
});
it("should have proper cache when error is thrown", async () => {
mock.reset();
mock.onPost("https://api.github.com/graphql").networkError();
const { req, res } = faker({}, {});
await patInfo(req, res);
expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "application/json"],
["Cache-Control", "no-store"],
]);
});
});
+141 -20
View File
@@ -10,17 +10,20 @@ import "@testing-library/jest-dom";
import { themes } from "../themes/index.js"; import { themes } from "../themes/index.js";
describe("Test renderStatsCard", () => { const stats = {
const stats = { name: "Anurag Hazra",
name: "Anurag Hazra", totalStars: 100,
totalStars: 100, totalCommits: 200,
totalCommits: 200, totalIssues: 300,
totalIssues: 300, totalPRs: 400,
totalPRs: 400, totalReviews: 50,
contributedTo: 500, totalDiscussionsStarted: 10,
rank: { level: "A+", score: 40 }, totalDiscussionsAnswered: 50,
}; contributedTo: 500,
rank: { level: "A+", percentile: 40 },
};
describe("Test renderStatsCard", () => {
it("should render correctly", () => { it("should render correctly", () => {
document.body.innerHTML = renderStatsCard(stats); document.body.innerHTML = renderStatsCard(stats);
@@ -38,6 +41,15 @@ describe("Test renderStatsCard", () => {
expect(getByTestId(document.body, "contribs").textContent).toBe("500"); expect(getByTestId(document.body, "contribs").textContent).toBe("500");
expect(queryByTestId(document.body, "card-bg")).toBeInTheDocument(); expect(queryByTestId(document.body, "card-bg")).toBeInTheDocument();
expect(queryByTestId(document.body, "rank-circle")).toBeInTheDocument(); expect(queryByTestId(document.body, "rank-circle")).toBeInTheDocument();
// Default hidden stats
expect(queryByTestId(document.body, "reviews")).not.toBeInTheDocument();
expect(
queryByTestId(document.body, "discussions_started"),
).not.toBeInTheDocument();
expect(
queryByTestId(document.body, "discussions_answered"),
).not.toBeInTheDocument();
}); });
it("should have proper name apostrophe", () => { it("should have proper name apostrophe", () => {
@@ -68,6 +80,28 @@ describe("Test renderStatsCard", () => {
expect(queryByTestId(document.body, "issues")).toBeNull(); expect(queryByTestId(document.body, "issues")).toBeNull();
expect(queryByTestId(document.body, "prs")).toBeNull(); expect(queryByTestId(document.body, "prs")).toBeNull();
expect(queryByTestId(document.body, "contribs")).toBeNull(); expect(queryByTestId(document.body, "contribs")).toBeNull();
expect(queryByTestId(document.body, "reviews")).toBeNull();
expect(queryByTestId(document.body, "discussions_started")).toBeNull();
expect(queryByTestId(document.body, "discussions_answered")).toBeNull();
});
it("should show additional stats", () => {
document.body.innerHTML = renderStatsCard(stats, {
show: ["reviews", "discussions_started", "discussions_answered"],
});
expect(
document.body.getElementsByTagName("svg")[0].getAttribute("height"),
).toBe("270");
expect(queryByTestId(document.body, "stars")).toBeDefined();
expect(queryByTestId(document.body, "commits")).toBeDefined();
expect(queryByTestId(document.body, "issues")).toBeDefined();
expect(queryByTestId(document.body, "prs")).toBeDefined();
expect(queryByTestId(document.body, "contribs")).toBeDefined();
expect(queryByTestId(document.body, "reviews")).toBeDefined();
expect(queryByTestId(document.body, "discussions_started")).toBeDefined();
expect(queryByTestId(document.body, "discussions_answered")).toBeDefined();
}); });
it("should hide_rank", () => { it("should hide_rank", () => {
@@ -78,16 +112,17 @@ describe("Test renderStatsCard", () => {
it("should render with custom width set", () => { it("should render with custom width set", () => {
document.body.innerHTML = renderStatsCard(stats); document.body.innerHTML = renderStatsCard(stats);
expect(document.querySelector("svg")).toHaveAttribute("width", "495"); expect(document.querySelector("svg")).toHaveAttribute("width", "450");
document.body.innerHTML = renderStatsCard(stats, { card_width: 400 }); document.body.innerHTML = renderStatsCard(stats, { card_width: 500 });
expect(document.querySelector("svg")).toHaveAttribute("width", "400"); expect(document.querySelector("svg")).toHaveAttribute("width", "500");
}); });
it("should render with custom width set and limit minimum width", () => { it("should render with custom width set and limit minimum width", () => {
document.body.innerHTML = renderStatsCard(stats, { card_width: 1 }); document.body.innerHTML = renderStatsCard(stats, { card_width: 1 });
expect(document.querySelector("svg")).toHaveAttribute("width", "340"); expect(document.querySelector("svg")).toHaveAttribute("width", "420");
// Test default minimum card width without rank circle.
document.body.innerHTML = renderStatsCard(stats, { document.body.innerHTML = renderStatsCard(stats, {
card_width: 1, card_width: 1,
hide_rank: true, hide_rank: true,
@@ -97,6 +132,7 @@ describe("Test renderStatsCard", () => {
"305.81250000000006", "305.81250000000006",
); );
// Test minimum card width with rank and icons.
document.body.innerHTML = renderStatsCard(stats, { document.body.innerHTML = renderStatsCard(stats, {
card_width: 1, card_width: 1,
hide_rank: true, hide_rank: true,
@@ -104,22 +140,24 @@ describe("Test renderStatsCard", () => {
}); });
expect(document.querySelector("svg")).toHaveAttribute( expect(document.querySelector("svg")).toHaveAttribute(
"width", "width",
"305.81250000000006", "322.81250000000006",
); );
// Test minimum card width with icons but without rank.
document.body.innerHTML = renderStatsCard(stats, { document.body.innerHTML = renderStatsCard(stats, {
card_width: 1, card_width: 1,
hide_rank: false, hide_rank: false,
show_icons: true, show_icons: true,
}); });
expect(document.querySelector("svg")).toHaveAttribute("width", "356"); expect(document.querySelector("svg")).toHaveAttribute("width", "437");
// Test minimum card width without icons or rank.
document.body.innerHTML = renderStatsCard(stats, { document.body.innerHTML = renderStatsCard(stats, {
card_width: 1, card_width: 1,
hide_rank: false, hide_rank: false,
show_icons: false, show_icons: false,
}); });
expect(document.querySelector("svg")).toHaveAttribute("width", "340"); expect(document.querySelector("svg")).toHaveAttribute("width", "420");
}); });
it("should render default colors properly", () => { it("should render default colors properly", () => {
@@ -239,6 +277,39 @@ describe("Test renderStatsCard", () => {
); );
}); });
it("should render custom ring_color properly", () => {
const customColors = {
title_color: "5a0",
ring_color: "0000ff",
icon_color: "1b998b",
text_color: "9991",
bg_color: "252525",
};
document.body.innerHTML = renderStatsCard(stats, { ...customColors });
const styleTag = document.querySelector("style");
const stylesObject = cssToObject(styleTag.innerHTML);
const headerClassStyles = stylesObject[":host"][".header "];
const statClassStyles = stylesObject[":host"][".stat "];
const iconClassStyles = stylesObject[":host"][".icon "];
const rankCircleStyles = stylesObject[":host"][".rank-circle "];
const rankCircleRimStyles = stylesObject[":host"][".rank-circle-rim "];
expect(headerClassStyles.fill.trim()).toBe(`#${customColors.title_color}`);
expect(statClassStyles.fill.trim()).toBe(`#${customColors.text_color}`);
expect(iconClassStyles.fill.trim()).toBe(`#${customColors.icon_color}`);
expect(rankCircleStyles.stroke.trim()).toBe(`#${customColors.ring_color}`);
expect(rankCircleRimStyles.stroke.trim()).toBe(
`#${customColors.ring_color}`,
);
expect(queryByTestId(document.body, "card-bg")).toHaveAttribute(
"fill",
"#252525",
);
});
it("should render icons correctly", () => { it("should render icons correctly", () => {
document.body.innerHTML = renderStatsCard(stats, { document.body.innerHTML = renderStatsCard(stats, {
show_icons: true, show_icons: true,
@@ -279,7 +350,7 @@ describe("Test renderStatsCard", () => {
expect( expect(
document.body.getElementsByTagName("svg")[0].getAttribute("width"), document.body.getElementsByTagName("svg")[0].getAttribute("width"),
).toBe("270"); ).toBe("287");
}); });
it("should render translations", () => { it("should render translations", () => {
@@ -296,7 +367,7 @@ describe("Test renderStatsCard", () => {
document.querySelector( document.querySelector(
'g[transform="translate(0, 25)"]>.stagger>.stat.bold', 'g[transform="translate(0, 25)"]>.stagger>.stat.bold',
).textContent, ).textContent,
).toMatchInlineSnapshot(`"累计提交数(commit (2022):"`); ).toMatchInlineSnapshot(`"累计提交数(commit (2023):"`);
expect( expect(
document.querySelector( document.querySelector(
'g[transform="translate(0, 50)"]>.stagger>.stat.bold', 'g[transform="translate(0, 50)"]>.stagger>.stat.bold',
@@ -311,7 +382,7 @@ describe("Test renderStatsCard", () => {
document.querySelector( document.querySelector(
'g[transform="translate(0, 100)"]>.stagger>.stat.bold', 'g[transform="translate(0, 100)"]>.stagger>.stat.bold',
).textContent, ).textContent,
).toMatchInlineSnapshot(`"参与项目数:"`); ).toMatchInlineSnapshot(`"贡献于(去年):"`);
}); });
it("should render without rounding", () => { it("should render without rounding", () => {
@@ -320,4 +391,54 @@ describe("Test renderStatsCard", () => {
document.body.innerHTML = renderStatsCard(stats, {}); document.body.innerHTML = renderStatsCard(stats, {});
expect(document.querySelector("rect")).toHaveAttribute("rx", "4.5"); expect(document.querySelector("rect")).toHaveAttribute("rx", "4.5");
}); });
it("should shorten values", () => {
stats["totalCommits"] = 1999;
document.body.innerHTML = renderStatsCard(stats);
expect(getByTestId(document.body, "commits").textContent).toBe("2k");
document.body.innerHTML = renderStatsCard(stats, { number_format: "long" });
expect(getByTestId(document.body, "commits").textContent).toBe("1999");
});
it("should render default rank icon with level A+", () => {
document.body.innerHTML = renderStatsCard(stats, {
rank_icon: "default",
});
expect(queryByTestId(document.body, "level-rank-icon")).toBeDefined();
expect(
queryByTestId(document.body, "level-rank-icon").textContent.trim(),
).toBe("A+");
});
it("should render github rank icon", () => {
document.body.innerHTML = renderStatsCard(stats, {
rank_icon: "github",
});
expect(queryByTestId(document.body, "github-rank-icon")).toBeDefined();
});
it("should show the rank percentile", () => {
document.body.innerHTML = renderStatsCard(stats, {
rank_icon: "percentile",
});
expect(queryByTestId(document.body, "percentile-top-header")).toBeDefined();
expect(
queryByTestId(document.body, "percentile-top-header").textContent.trim(),
).toBe("Top");
expect(queryByTestId(document.body, "rank-percentile-text")).toBeDefined();
expect(
queryByTestId(document.body, "percentile-rank-value").textContent.trim(),
).toBe(stats.rank.percentile.toFixed(1) + "%");
});
it("should show the progress", () => {
document.body.innerHTML = renderStatsCard(stats, {
rank_icon: "progress",
});
expect(queryByTestId(document.body, "rank-progress-text")).toBeDefined();
expect(
queryByTestId(document.body, "progress-rank-icon").textContent.trim(),
).toBe((100 - stats.rank.percentile).toFixed(1) + "%");
});
}); });
+599 -24
View File
@@ -1,33 +1,357 @@
import { queryAllByTestId, queryByTestId } from "@testing-library/dom"; import { queryAllByTestId, queryByTestId } from "@testing-library/dom";
import { cssToObject } from "@uppercod/css-to-object"; import { cssToObject } from "@uppercod/css-to-object";
import { import {
MIN_CARD_WIDTH, getLongestLang,
degreesToRadians,
radiansToDegrees,
polarToCartesian,
cartesianToPolar,
getCircleLength,
calculateCompactLayoutHeight,
calculateNormalLayoutHeight,
calculateDonutLayoutHeight,
calculateDonutVerticalLayoutHeight,
calculatePieLayoutHeight,
donutCenterTranslation,
trimTopLanguages,
renderTopLanguages, renderTopLanguages,
MIN_CARD_WIDTH,
getDefaultLanguagesCountByLayout,
} from "../src/cards/top-languages-card.js"; } from "../src/cards/top-languages-card.js";
// adds special assertions like toHaveTextContent // adds special assertions like toHaveTextContent
import "@testing-library/jest-dom"; import "@testing-library/jest-dom";
import { themes } from "../themes/index.js"; import { themes } from "../themes/index.js";
describe("Test renderTopLanguages", () => { const langs = {
const langs = { HTML: {
HTML: { color: "#0f0",
color: "#0f0", name: "HTML",
name: "HTML", size: 200,
size: 200, },
}, javascript: {
javascript: { color: "#0ff",
color: "#0ff", name: "javascript",
name: "javascript", size: 200,
size: 200, },
}, css: {
css: { color: "#ff0",
color: "#ff0", name: "css",
name: "css", size: 100,
size: 100, },
}, };
};
/**
* Retrieve number array from SVG path definition string.
*
* @param {string} d SVG path definition string.
* @return {number[]} Resulting numbers array.
*/
const getNumbersFromSvgPathDefinitionAttribute = (d) => {
return d
.split(" ")
.filter((x) => !isNaN(x))
.map((x) => parseFloat(x));
};
/**
* Retrieve the language percentage from the donut chart SVG.
*
* @param {string} d The SVG path element.
* @param {number} centerX The center X coordinate of the donut chart.
* @param {number} centerY The center Y coordinate of the donut chart.
* @returns {number} The percentage of the language.
*/
const langPercentFromDonutLayoutSvg = (d, centerX, centerY) => {
const dTmp = getNumbersFromSvgPathDefinitionAttribute(d);
const endAngle =
cartesianToPolar(centerX, centerY, dTmp[0], dTmp[1]).angleInDegrees + 90;
let startAngle =
cartesianToPolar(centerX, centerY, dTmp[7], dTmp[8]).angleInDegrees + 90;
if (startAngle > endAngle) startAngle -= 360;
return (endAngle - startAngle) / 3.6;
};
/**
* Calculate language percentage for donut vertical chart SVG.
*
* @param {number} partLength Length of current chart part..
* @param {number} totalCircleLength Total length of circle.
* @return {number} Chart part percentage.
*/
const langPercentFromDonutVerticalLayoutSvg = (
partLength,
totalCircleLength,
) => {
return (partLength / totalCircleLength) * 100;
};
/**
* Retrieve the language percentage from the pie chart SVG.
*
* @param {string} d The SVG path element.
* @param {number} centerX The center X coordinate of the pie chart.
* @param {number} centerY The center Y coordinate of the pie chart.
* @returns {number} The percentage of the language.
*/
const langPercentFromPieLayoutSvg = (d, centerX, centerY) => {
const dTmp = getNumbersFromSvgPathDefinitionAttribute(d);
const startAngle = cartesianToPolar(
centerX,
centerY,
dTmp[2],
dTmp[3],
).angleInDegrees;
let endAngle = cartesianToPolar(
centerX,
centerY,
dTmp[9],
dTmp[10],
).angleInDegrees;
return ((endAngle - startAngle) / 360) * 100;
};
describe("Test renderTopLanguages helper functions", () => {
it("getLongestLang", () => {
const langArray = Object.values(langs);
expect(getLongestLang(langArray)).toBe(langs.javascript);
});
it("degreesToRadians", () => {
expect(degreesToRadians(0)).toBe(0);
expect(degreesToRadians(90)).toBe(Math.PI / 2);
expect(degreesToRadians(180)).toBe(Math.PI);
expect(degreesToRadians(270)).toBe((3 * Math.PI) / 2);
expect(degreesToRadians(360)).toBe(2 * Math.PI);
});
it("radiansToDegrees", () => {
expect(radiansToDegrees(0)).toBe(0);
expect(radiansToDegrees(Math.PI / 2)).toBe(90);
expect(radiansToDegrees(Math.PI)).toBe(180);
expect(radiansToDegrees((3 * Math.PI) / 2)).toBe(270);
expect(radiansToDegrees(2 * Math.PI)).toBe(360);
});
it("polarToCartesian", () => {
expect(polarToCartesian(100, 100, 60, 0)).toStrictEqual({ x: 160, y: 100 });
expect(polarToCartesian(100, 100, 60, 45)).toStrictEqual({
x: 142.42640687119285,
y: 142.42640687119285,
});
expect(polarToCartesian(100, 100, 60, 90)).toStrictEqual({
x: 100,
y: 160,
});
expect(polarToCartesian(100, 100, 60, 135)).toStrictEqual({
x: 57.573593128807154,
y: 142.42640687119285,
});
expect(polarToCartesian(100, 100, 60, 180)).toStrictEqual({
x: 40,
y: 100.00000000000001,
});
expect(polarToCartesian(100, 100, 60, 225)).toStrictEqual({
x: 57.57359312880714,
y: 57.573593128807154,
});
expect(polarToCartesian(100, 100, 60, 270)).toStrictEqual({
x: 99.99999999999999,
y: 40,
});
expect(polarToCartesian(100, 100, 60, 315)).toStrictEqual({
x: 142.42640687119285,
y: 57.57359312880714,
});
expect(polarToCartesian(100, 100, 60, 360)).toStrictEqual({
x: 160,
y: 99.99999999999999,
});
});
it("cartesianToPolar", () => {
expect(cartesianToPolar(100, 100, 160, 100)).toStrictEqual({
radius: 60,
angleInDegrees: 0,
});
expect(
cartesianToPolar(100, 100, 142.42640687119285, 142.42640687119285),
).toStrictEqual({ radius: 60.00000000000001, angleInDegrees: 45 });
expect(cartesianToPolar(100, 100, 100, 160)).toStrictEqual({
radius: 60,
angleInDegrees: 90,
});
expect(
cartesianToPolar(100, 100, 57.573593128807154, 142.42640687119285),
).toStrictEqual({ radius: 60, angleInDegrees: 135 });
expect(cartesianToPolar(100, 100, 40, 100.00000000000001)).toStrictEqual({
radius: 60,
angleInDegrees: 180,
});
expect(
cartesianToPolar(100, 100, 57.57359312880714, 57.573593128807154),
).toStrictEqual({ radius: 60, angleInDegrees: 225 });
expect(cartesianToPolar(100, 100, 99.99999999999999, 40)).toStrictEqual({
radius: 60,
angleInDegrees: 270,
});
expect(
cartesianToPolar(100, 100, 142.42640687119285, 57.57359312880714),
).toStrictEqual({ radius: 60.00000000000001, angleInDegrees: 315 });
expect(cartesianToPolar(100, 100, 160, 99.99999999999999)).toStrictEqual({
radius: 60,
angleInDegrees: 360,
});
});
it("calculateCompactLayoutHeight", () => {
expect(calculateCompactLayoutHeight(0)).toBe(90);
expect(calculateCompactLayoutHeight(1)).toBe(115);
expect(calculateCompactLayoutHeight(2)).toBe(115);
expect(calculateCompactLayoutHeight(3)).toBe(140);
expect(calculateCompactLayoutHeight(4)).toBe(140);
expect(calculateCompactLayoutHeight(5)).toBe(165);
expect(calculateCompactLayoutHeight(6)).toBe(165);
expect(calculateCompactLayoutHeight(7)).toBe(190);
expect(calculateCompactLayoutHeight(8)).toBe(190);
expect(calculateCompactLayoutHeight(9)).toBe(215);
expect(calculateCompactLayoutHeight(10)).toBe(215);
});
it("calculateNormalLayoutHeight", () => {
expect(calculateNormalLayoutHeight(0)).toBe(85);
expect(calculateNormalLayoutHeight(1)).toBe(125);
expect(calculateNormalLayoutHeight(2)).toBe(165);
expect(calculateNormalLayoutHeight(3)).toBe(205);
expect(calculateNormalLayoutHeight(4)).toBe(245);
expect(calculateNormalLayoutHeight(5)).toBe(285);
expect(calculateNormalLayoutHeight(6)).toBe(325);
expect(calculateNormalLayoutHeight(7)).toBe(365);
expect(calculateNormalLayoutHeight(8)).toBe(405);
expect(calculateNormalLayoutHeight(9)).toBe(445);
expect(calculateNormalLayoutHeight(10)).toBe(485);
});
it("calculateDonutLayoutHeight", () => {
expect(calculateDonutLayoutHeight(0)).toBe(215);
expect(calculateDonutLayoutHeight(1)).toBe(215);
expect(calculateDonutLayoutHeight(2)).toBe(215);
expect(calculateDonutLayoutHeight(3)).toBe(215);
expect(calculateDonutLayoutHeight(4)).toBe(215);
expect(calculateDonutLayoutHeight(5)).toBe(215);
expect(calculateDonutLayoutHeight(6)).toBe(247);
expect(calculateDonutLayoutHeight(7)).toBe(279);
expect(calculateDonutLayoutHeight(8)).toBe(311);
expect(calculateDonutLayoutHeight(9)).toBe(343);
expect(calculateDonutLayoutHeight(10)).toBe(375);
});
it("calculateDonutVerticalLayoutHeight", () => {
expect(calculateDonutVerticalLayoutHeight(0)).toBe(300);
expect(calculateDonutVerticalLayoutHeight(1)).toBe(325);
expect(calculateDonutVerticalLayoutHeight(2)).toBe(325);
expect(calculateDonutVerticalLayoutHeight(3)).toBe(350);
expect(calculateDonutVerticalLayoutHeight(4)).toBe(350);
expect(calculateDonutVerticalLayoutHeight(5)).toBe(375);
expect(calculateDonutVerticalLayoutHeight(6)).toBe(375);
expect(calculateDonutVerticalLayoutHeight(7)).toBe(400);
expect(calculateDonutVerticalLayoutHeight(8)).toBe(400);
expect(calculateDonutVerticalLayoutHeight(9)).toBe(425);
expect(calculateDonutVerticalLayoutHeight(10)).toBe(425);
});
it("calculatePieLayoutHeight", () => {
expect(calculatePieLayoutHeight(0)).toBe(300);
expect(calculatePieLayoutHeight(1)).toBe(325);
expect(calculatePieLayoutHeight(2)).toBe(325);
expect(calculatePieLayoutHeight(3)).toBe(350);
expect(calculatePieLayoutHeight(4)).toBe(350);
expect(calculatePieLayoutHeight(5)).toBe(375);
expect(calculatePieLayoutHeight(6)).toBe(375);
expect(calculatePieLayoutHeight(7)).toBe(400);
expect(calculatePieLayoutHeight(8)).toBe(400);
expect(calculatePieLayoutHeight(9)).toBe(425);
expect(calculatePieLayoutHeight(10)).toBe(425);
});
it("donutCenterTranslation", () => {
expect(donutCenterTranslation(0)).toBe(-45);
expect(donutCenterTranslation(1)).toBe(-45);
expect(donutCenterTranslation(2)).toBe(-45);
expect(donutCenterTranslation(3)).toBe(-45);
expect(donutCenterTranslation(4)).toBe(-45);
expect(donutCenterTranslation(5)).toBe(-45);
expect(donutCenterTranslation(6)).toBe(-29);
expect(donutCenterTranslation(7)).toBe(-13);
expect(donutCenterTranslation(8)).toBe(3);
expect(donutCenterTranslation(9)).toBe(19);
expect(donutCenterTranslation(10)).toBe(35);
});
it("getCircleLength", () => {
expect(getCircleLength(20)).toBeCloseTo(125.663);
expect(getCircleLength(30)).toBeCloseTo(188.495);
expect(getCircleLength(40)).toBeCloseTo(251.327);
expect(getCircleLength(50)).toBeCloseTo(314.159);
expect(getCircleLength(60)).toBeCloseTo(376.991);
expect(getCircleLength(70)).toBeCloseTo(439.822);
expect(getCircleLength(80)).toBeCloseTo(502.654);
expect(getCircleLength(90)).toBeCloseTo(565.486);
expect(getCircleLength(100)).toBeCloseTo(628.318);
});
it("trimTopLanguages", () => {
expect(trimTopLanguages([])).toStrictEqual({
langs: [],
totalLanguageSize: 0,
});
expect(trimTopLanguages([langs.javascript])).toStrictEqual({
langs: [langs.javascript],
totalLanguageSize: 200,
});
expect(trimTopLanguages([langs.javascript, langs.HTML], 5)).toStrictEqual({
langs: [langs.javascript, langs.HTML],
totalLanguageSize: 400,
});
expect(trimTopLanguages(langs, 5)).toStrictEqual({
langs: Object.values(langs),
totalLanguageSize: 500,
});
expect(trimTopLanguages(langs, 2)).toStrictEqual({
langs: Object.values(langs).slice(0, 2),
totalLanguageSize: 400,
});
expect(trimTopLanguages(langs, 5, ["javascript"])).toStrictEqual({
langs: [langs.HTML, langs.css],
totalLanguageSize: 300,
});
});
it("getDefaultLanguagesCountByLayout", () => {
expect(
getDefaultLanguagesCountByLayout({ layout: "normal" }),
).toStrictEqual(5);
expect(getDefaultLanguagesCountByLayout({})).toStrictEqual(5);
expect(
getDefaultLanguagesCountByLayout({ layout: "compact" }),
).toStrictEqual(6);
expect(
getDefaultLanguagesCountByLayout({ hide_progress: true }),
).toStrictEqual(6);
expect(getDefaultLanguagesCountByLayout({ layout: "donut" })).toStrictEqual(
5,
);
expect(
getDefaultLanguagesCountByLayout({ layout: "donut-vertical" }),
).toStrictEqual(6);
expect(getDefaultLanguagesCountByLayout({ layout: "pie" })).toStrictEqual(
6,
);
});
});
describe("Test renderTopLanguages", () => {
it("should render correctly", () => { it("should render correctly", () => {
document.body.innerHTML = renderTopLanguages(langs); document.body.innerHTML = renderTopLanguages(langs);
@@ -216,7 +540,7 @@ describe("Test renderTopLanguages", () => {
); );
expect(queryAllByTestId(document.body, "lang-progress")[0]).toHaveAttribute( expect(queryAllByTestId(document.body, "lang-progress")[0]).toHaveAttribute(
"width", "width",
"120", "100",
); );
expect(queryAllByTestId(document.body, "lang-name")[1]).toHaveTextContent( expect(queryAllByTestId(document.body, "lang-name")[1]).toHaveTextContent(
@@ -224,7 +548,7 @@ describe("Test renderTopLanguages", () => {
); );
expect(queryAllByTestId(document.body, "lang-progress")[1]).toHaveAttribute( expect(queryAllByTestId(document.body, "lang-progress")[1]).toHaveAttribute(
"width", "width",
"120", "100",
); );
expect(queryAllByTestId(document.body, "lang-name")[2]).toHaveTextContent( expect(queryAllByTestId(document.body, "lang-name")[2]).toHaveTextContent(
@@ -232,7 +556,251 @@ describe("Test renderTopLanguages", () => {
); );
expect(queryAllByTestId(document.body, "lang-progress")[2]).toHaveAttribute( expect(queryAllByTestId(document.body, "lang-progress")[2]).toHaveAttribute(
"width", "width",
"60", "50",
);
});
it("should render with layout donut", () => {
document.body.innerHTML = renderTopLanguages(langs, { layout: "donut" });
expect(queryByTestId(document.body, "header")).toHaveTextContent(
"Most Used Languages",
);
expect(queryAllByTestId(document.body, "lang-name")[0]).toHaveTextContent(
"HTML 40.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[0]).toHaveAttribute(
"size",
"40",
);
const d = getNumbersFromSvgPathDefinitionAttribute(
queryAllByTestId(document.body, "lang-donut")[0].getAttribute("d"),
);
const center = { x: d[7], y: d[7] };
const HTMLLangPercent = langPercentFromDonutLayoutSvg(
queryAllByTestId(document.body, "lang-donut")[0].getAttribute("d"),
center.x,
center.y,
);
expect(HTMLLangPercent).toBeCloseTo(40);
expect(queryAllByTestId(document.body, "lang-name")[1]).toHaveTextContent(
"javascript 40.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[1]).toHaveAttribute(
"size",
"40",
);
const javascriptLangPercent = langPercentFromDonutLayoutSvg(
queryAllByTestId(document.body, "lang-donut")[1].getAttribute("d"),
center.x,
center.y,
);
expect(javascriptLangPercent).toBeCloseTo(40);
expect(queryAllByTestId(document.body, "lang-name")[2]).toHaveTextContent(
"css 20.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[2]).toHaveAttribute(
"size",
"20",
);
const cssLangPercent = langPercentFromDonutLayoutSvg(
queryAllByTestId(document.body, "lang-donut")[2].getAttribute("d"),
center.x,
center.y,
);
expect(cssLangPercent).toBeCloseTo(20);
expect(HTMLLangPercent + javascriptLangPercent + cssLangPercent).toBe(100);
// Should render full donut (circle) if one language is 100%.
document.body.innerHTML = renderTopLanguages(
{ HTML: langs.HTML },
{ layout: "donut" },
);
expect(queryAllByTestId(document.body, "lang-name")[0]).toHaveTextContent(
"HTML 100.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[0]).toHaveAttribute(
"size",
"100",
);
expect(queryAllByTestId(document.body, "lang-donut")).toHaveLength(1);
expect(queryAllByTestId(document.body, "lang-donut")[0].tagName).toBe(
"circle",
);
});
it("should render with layout donut vertical", () => {
document.body.innerHTML = renderTopLanguages(langs, {
layout: "donut-vertical",
});
expect(queryByTestId(document.body, "header")).toHaveTextContent(
"Most Used Languages",
);
expect(queryAllByTestId(document.body, "lang-name")[0]).toHaveTextContent(
"HTML 40.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[0]).toHaveAttribute(
"size",
"40",
);
const totalCircleLength = queryAllByTestId(
document.body,
"lang-donut",
)[0].getAttribute("stroke-dasharray");
const HTMLLangPercent = langPercentFromDonutVerticalLayoutSvg(
queryAllByTestId(document.body, "lang-donut")[1].getAttribute(
"stroke-dashoffset",
) -
queryAllByTestId(document.body, "lang-donut")[0].getAttribute(
"stroke-dashoffset",
),
totalCircleLength,
);
expect(HTMLLangPercent).toBeCloseTo(40);
expect(queryAllByTestId(document.body, "lang-name")[1]).toHaveTextContent(
"javascript 40.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[1]).toHaveAttribute(
"size",
"40",
);
const javascriptLangPercent = langPercentFromDonutVerticalLayoutSvg(
queryAllByTestId(document.body, "lang-donut")[2].getAttribute(
"stroke-dashoffset",
) -
queryAllByTestId(document.body, "lang-donut")[1].getAttribute(
"stroke-dashoffset",
),
totalCircleLength,
);
expect(javascriptLangPercent).toBeCloseTo(40);
expect(queryAllByTestId(document.body, "lang-name")[2]).toHaveTextContent(
"css 20.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[2]).toHaveAttribute(
"size",
"20",
);
const cssLangPercent = langPercentFromDonutVerticalLayoutSvg(
totalCircleLength -
queryAllByTestId(document.body, "lang-donut")[2].getAttribute(
"stroke-dashoffset",
),
totalCircleLength,
);
expect(cssLangPercent).toBeCloseTo(20);
expect(HTMLLangPercent + javascriptLangPercent + cssLangPercent).toBe(100);
});
it("should render with layout donut vertical full donut circle of one language is 100%", () => {
document.body.innerHTML = renderTopLanguages(
{ HTML: langs.HTML },
{ layout: "donut-vertical" },
);
expect(queryAllByTestId(document.body, "lang-name")[0]).toHaveTextContent(
"HTML 100.00%",
);
expect(queryAllByTestId(document.body, "lang-donut")[0]).toHaveAttribute(
"size",
"100",
);
const totalCircleLength = queryAllByTestId(
document.body,
"lang-donut",
)[0].getAttribute("stroke-dasharray");
const HTMLLangPercent = langPercentFromDonutVerticalLayoutSvg(
totalCircleLength -
queryAllByTestId(document.body, "lang-donut")[0].getAttribute(
"stroke-dashoffset",
),
totalCircleLength,
);
expect(HTMLLangPercent).toBeCloseTo(100);
});
it("should render with layout pie", () => {
document.body.innerHTML = renderTopLanguages(langs, { layout: "pie" });
expect(queryByTestId(document.body, "header")).toHaveTextContent(
"Most Used Languages",
);
expect(queryAllByTestId(document.body, "lang-name")[0]).toHaveTextContent(
"HTML 40.00%",
);
expect(queryAllByTestId(document.body, "lang-pie")[0]).toHaveAttribute(
"size",
"40",
);
const d = getNumbersFromSvgPathDefinitionAttribute(
queryAllByTestId(document.body, "lang-pie")[0].getAttribute("d"),
);
const center = { x: d[0], y: d[1] };
const HTMLLangPercent = langPercentFromPieLayoutSvg(
queryAllByTestId(document.body, "lang-pie")[0].getAttribute("d"),
center.x,
center.y,
);
expect(HTMLLangPercent).toBeCloseTo(40);
expect(queryAllByTestId(document.body, "lang-name")[1]).toHaveTextContent(
"javascript 40.00%",
);
expect(queryAllByTestId(document.body, "lang-pie")[1]).toHaveAttribute(
"size",
"40",
);
const javascriptLangPercent = langPercentFromPieLayoutSvg(
queryAllByTestId(document.body, "lang-pie")[1].getAttribute("d"),
center.x,
center.y,
);
expect(javascriptLangPercent).toBeCloseTo(40);
expect(queryAllByTestId(document.body, "lang-name")[2]).toHaveTextContent(
"css 20.00%",
);
expect(queryAllByTestId(document.body, "lang-pie")[2]).toHaveAttribute(
"size",
"20",
);
const cssLangPercent = langPercentFromPieLayoutSvg(
queryAllByTestId(document.body, "lang-pie")[2].getAttribute("d"),
center.x,
center.y,
);
expect(cssLangPercent).toBeCloseTo(20);
expect(HTMLLangPercent + javascriptLangPercent + cssLangPercent).toBe(100);
// Should render full pie (circle) if one language is 100%.
document.body.innerHTML = renderTopLanguages(
{ HTML: langs.HTML },
{ layout: "pie" },
);
expect(queryAllByTestId(document.body, "lang-name")[0]).toHaveTextContent(
"HTML 100.00%",
);
expect(queryAllByTestId(document.body, "lang-pie")[0]).toHaveAttribute(
"size",
"100",
);
expect(queryAllByTestId(document.body, "lang-pie")).toHaveLength(1);
expect(queryAllByTestId(document.body, "lang-pie")[0].tagName).toBe(
"circle",
); );
}); });
@@ -250,7 +818,7 @@ describe("Test renderTopLanguages", () => {
expect(document.querySelector("rect")).toHaveAttribute("rx", "4.5"); expect(document.querySelector("rect")).toHaveAttribute("rx", "4.5");
}); });
it("should render langs with specified langs_count", async () => { it("should render langs with specified langs_count", () => {
const options = { const options = {
langs_count: 1, langs_count: 1,
}; };
@@ -260,7 +828,7 @@ describe("Test renderTopLanguages", () => {
); );
}); });
it("should render langs with specified langs_count even when hide is set", async () => { it("should render langs with specified langs_count even when hide is set", () => {
const options = { const options = {
hide: ["HTML"], hide: ["HTML"],
langs_count: 2, langs_count: 2,
@@ -270,4 +838,11 @@ describe("Test renderTopLanguages", () => {
options.langs_count, options.langs_count,
); );
}); });
it('should show "No languages data." message instead of empty card when nothing to show', () => {
document.body.innerHTML = renderTopLanguages({});
expect(document.querySelector(".stat").textContent).toBe(
"No languages data.",
);
});
}); });
+26 -2
View File
@@ -16,6 +16,15 @@ describe("Test Render Wakatime Card", () => {
expect(card).toMatchSnapshot(); expect(card).toMatchSnapshot();
}); });
it("should render correctly with compact layout when langs_count is set", () => {
const card = renderWakatimeCard(wakaTimeData.data, {
layout: "compact",
langs_count: 2,
});
expect(card).toMatchSnapshot();
});
it("should hide languages when hide is passed", () => { it("should hide languages when hide is passed", () => {
document.body.innerHTML = renderWakatimeCard(wakaTimeData.data, { document.body.innerHTML = renderWakatimeCard(wakaTimeData.data, {
hide: ["YAML", "Other"], hide: ["YAML", "Other"],
@@ -34,7 +43,7 @@ describe("Test Render Wakatime Card", () => {
expect( expect(
document.querySelector('g[transform="translate(0, 0)"]>text.stat.bold') document.querySelector('g[transform="translate(0, 0)"]>text.stat.bold')
.textContent, .textContent,
).toBe("本周没有编程活动"); ).toBe("Wakatime 用户个人资料未公开");
}); });
it("should render without rounding", () => { it("should render without rounding", () => {
@@ -46,7 +55,7 @@ describe("Test Render Wakatime Card", () => {
expect(document.querySelector("rect")).toHaveAttribute("rx", "4.5"); expect(document.querySelector("rect")).toHaveAttribute("rx", "4.5");
}); });
it('should show "no coding activitiy this week" message when there hasn not been activity', () => { it('should show "no coding activity this week" message when there has not been activity', () => {
document.body.innerHTML = renderWakatimeCard( document.body.innerHTML = renderWakatimeCard(
{ {
...wakaTimeData.data, ...wakaTimeData.data,
@@ -58,4 +67,19 @@ describe("Test Render Wakatime Card", () => {
"No coding activity this week", "No coding activity this week",
); );
}); });
it('should show "no coding activity this week" message when using compact layout and there has not been activity', () => {
document.body.innerHTML = renderWakatimeCard(
{
...wakaTimeData.data,
languages: undefined,
},
{
layout: "compact",
},
);
expect(document.querySelector(".stat").textContent).toBe(
"No coding activity this week",
);
});
}); });
+194
View File
@@ -0,0 +1,194 @@
/**
* @file Tests for the status/up cloud function.
*/
import { jest } from "@jest/globals";
import axios from "axios";
import MockAdapter from "axios-mock-adapter";
import up, { RATE_LIMIT_SECONDS } from "../api/status/up.js";
const mock = new MockAdapter(axios);
const successData = {
rateLimit: {
remaining: 4986,
},
};
const faker = (query) => {
const req = {
query: { ...query },
};
const res = {
setHeader: jest.fn(),
send: jest.fn(),
};
return { req, res };
};
const rate_limit_error = {
errors: [
{
type: "RATE_LIMITED",
},
],
};
const bad_credentials_error = {
message: "Bad credentials",
};
const shields_up = {
schemaVersion: 1,
label: "Public Instance",
isError: true,
message: "up",
color: "brightgreen",
};
const shields_down = {
schemaVersion: 1,
label: "Public Instance",
isError: true,
message: "down",
color: "red",
};
afterEach(() => {
mock.reset();
});
describe("Test /api/status/up", () => {
it("should return `true` if request was successful", async () => {
mock.onPost("https://api.github.com/graphql").replyOnce(200, successData);
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(true);
});
it("should return `false` if all PATs are rate limited", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, rate_limit_error);
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(false);
});
it("should return JSON `true` if request was successful and type='json'", async () => {
mock.onPost("https://api.github.com/graphql").replyOnce(200, successData);
const { req, res } = faker({ type: "json" }, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith({ up: true });
});
it("should return JSON `false` if all PATs are rate limited and type='json'", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, rate_limit_error);
const { req, res } = faker({ type: "json" }, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith({ up: false });
});
it("should return UP shields.io config if request was successful and type='shields'", async () => {
mock.onPost("https://api.github.com/graphql").replyOnce(200, successData);
const { req, res } = faker({ type: "shields" }, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(shields_up);
});
it("should return DOWN shields.io config if all PATs are rate limited and type='shields'", async () => {
mock.onPost("https://api.github.com/graphql").reply(200, rate_limit_error);
const { req, res } = faker({ type: "shields" }, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(shields_down);
});
it("should return `true` if the first PAT is rate limited but the second PATs works", async () => {
mock
.onPost("https://api.github.com/graphql")
.replyOnce(200, rate_limit_error)
.onPost("https://api.github.com/graphql")
.replyOnce(200, successData);
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(true);
});
it("should return `true` if the first PAT has 'Bad credentials' but the second PAT works", async () => {
mock
.onPost("https://api.github.com/graphql")
.replyOnce(404, bad_credentials_error)
.onPost("https://api.github.com/graphql")
.replyOnce(200, successData);
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(true);
});
it("should return `false` if all pats have 'Bad credentials'", async () => {
mock
.onPost("https://api.github.com/graphql")
.reply(404, bad_credentials_error);
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(false);
});
it("should throw an error if the request fails", async () => {
mock.onPost("https://api.github.com/graphql").networkError();
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "application/json");
expect(res.send).toBeCalledWith(false);
});
it("should have proper cache when no error is thrown", async () => {
mock.onPost("https://api.github.com/graphql").replyOnce(200, successData);
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "application/json"],
["Cache-Control", `max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`],
]);
});
it("should have proper cache when error is thrown", async () => {
mock.onPost("https://api.github.com/graphql").networkError();
const { req, res } = faker({}, {});
await up(req, res);
expect(res.setHeader.mock.calls).toEqual([
["Content-Type", "application/json"],
["Cache-Control", "no-store"],
]);
});
});
+22 -1
View File
@@ -123,7 +123,7 @@ describe("Test /api/top-langs", () => {
); );
}); });
it("should render error card on error", async () => { it("should render error card on user data fetch error", async () => {
const req = { const req = {
query: { query: {
username: "anuraghazra", username: "anuraghazra",
@@ -140,4 +140,25 @@ describe("Test /api/top-langs", () => {
expect(res.setHeader).toBeCalledWith("Content-Type", "image/svg+xml"); expect(res.setHeader).toBeCalledWith("Content-Type", "image/svg+xml");
expect(res.send).toBeCalledWith(renderError(error.errors[0].message)); expect(res.send).toBeCalledWith(renderError(error.errors[0].message));
}); });
it("should render error card on incorrect layout input", async () => {
const req = {
query: {
username: "anuraghazra",
layout: ["pie"],
},
};
const res = {
setHeader: jest.fn(),
send: jest.fn(),
};
mock.onPost("https://api.github.com/graphql").reply(200, data_langs);
await topLangs(req, res);
expect(res.setHeader).toBeCalledWith("Content-Type", "image/svg+xml");
expect(res.send).toBeCalledWith(
renderError("Something went wrong", "Incorrect layout input"),
);
});
}); });
+41
View File
@@ -4,6 +4,7 @@ import {
encodeHTML, encodeHTML,
getCardColors, getCardColors,
kFormatter, kFormatter,
parseBoolean,
renderError, renderError,
wrapTextMultiline, wrapTextMultiline,
} from "../src/common/utils.js"; } from "../src/common/utils.js";
@@ -19,6 +20,23 @@ describe("Test utils.js", () => {
expect(kFormatter(9900000)).toBe("9900k"); expect(kFormatter(9900000)).toBe("9900k");
}); });
it("should test parseBoolean", () => {
expect(parseBoolean(true)).toBe(true);
expect(parseBoolean(false)).toBe(false);
expect(parseBoolean("true")).toBe(true);
expect(parseBoolean("false")).toBe(false);
expect(parseBoolean("True")).toBe(true);
expect(parseBoolean("False")).toBe(false);
expect(parseBoolean("TRUE")).toBe(true);
expect(parseBoolean("FALSE")).toBe(false);
expect(parseBoolean("1")).toBe(undefined);
expect(parseBoolean("0")).toBe(undefined);
expect(parseBoolean("")).toBe(undefined);
expect(parseBoolean(undefined)).toBe(undefined);
});
it("should test encodeHTML", () => { it("should test encodeHTML", () => {
expect(encodeHTML(`<html>hello world<,.#4^&^@%!))`)).toBe( expect(encodeHTML(`<html>hello world<,.#4^&^@%!))`)).toBe(
"&#60;html&#62;hello world&#60;,.#4^&#38;^@%!))", "&#60;html&#62;hello world&#60;,.#4^&#38;^@%!))",
@@ -48,6 +66,7 @@ describe("Test utils.js", () => {
let colors = getCardColors({ let colors = getCardColors({
title_color: "f00", title_color: "f00",
text_color: "0f0", text_color: "0f0",
ring_color: "0000ff",
icon_color: "00f", icon_color: "00f",
bg_color: "fff", bg_color: "fff",
border_color: "fff", border_color: "fff",
@@ -57,6 +76,7 @@ describe("Test utils.js", () => {
titleColor: "#f00", titleColor: "#f00",
textColor: "#0f0", textColor: "#0f0",
iconColor: "#00f", iconColor: "#00f",
ringColor: "#0000ff",
bgColor: "#fff", bgColor: "#fff",
borderColor: "#fff", borderColor: "#fff",
}); });
@@ -75,6 +95,7 @@ describe("Test utils.js", () => {
titleColor: "#2f80ed", titleColor: "#2f80ed",
textColor: "#0f0", textColor: "#0f0",
iconColor: "#00f", iconColor: "#00f",
ringColor: "#2f80ed",
bgColor: "#fff", bgColor: "#fff",
borderColor: "#e4e2e2", borderColor: "#e4e2e2",
}); });
@@ -87,11 +108,31 @@ describe("Test utils.js", () => {
expect(colors).toStrictEqual({ expect(colors).toStrictEqual({
titleColor: "#fff", titleColor: "#fff",
textColor: "#9f9f9f", textColor: "#9f9f9f",
ringColor: "#fff",
iconColor: "#79ff97", iconColor: "#79ff97",
bgColor: "#151515", bgColor: "#151515",
borderColor: "#e4e2e2", borderColor: "#e4e2e2",
}); });
}); });
it("getCardColors: should return ring color equal to title color if not ring color is defined", () => {
let colors = getCardColors({
title_color: "f00",
text_color: "0f0",
icon_color: "00f",
bg_color: "fff",
border_color: "fff",
theme: "dark",
});
expect(colors).toStrictEqual({
titleColor: "#f00",
textColor: "#0f0",
iconColor: "#00f",
ringColor: "#f00",
bgColor: "#fff",
borderColor: "#fff",
});
});
}); });
describe("wrapTextMultiline", () => { describe("wrapTextMultiline", () => {
+34 -10
View File
@@ -16,7 +16,8 @@ Use `?theme=THEME_NAME` parameter like so :-
| | | | | | | |
| :--: | :--: | :--: | | :--: | :--: | :--: |
| `default` ![default][default] | `transparent` ![transparent][transparent] | `dark` ![dark][dark] | | `default` ![default][default] | `transparent` ![transparent][transparent] | `shadow_red` ![shadow_red][shadow_red] |
| `shadow_green` ![shadow_green][shadow_green] | `shadow_blue` ![shadow_blue][shadow_blue] | `dark` ![dark][dark] |
| `radical` ![radical][radical] | `merko` ![merko][merko] | `gruvbox` ![gruvbox][gruvbox] | | `radical` ![radical][radical] | `merko` ![merko][merko] | `gruvbox` ![gruvbox][gruvbox] |
| `gruvbox_light` ![gruvbox_light][gruvbox_light] | `tokyonight` ![tokyonight][tokyonight] | `onedark` ![onedark][onedark] | | `gruvbox_light` ![gruvbox_light][gruvbox_light] | `tokyonight` ![tokyonight][tokyonight] | `onedark` ![onedark][onedark] |
| `cobalt` ![cobalt][cobalt] | `synthwave` ![synthwave][synthwave] | `highcontrast` ![highcontrast][highcontrast] | | `cobalt` ![cobalt][cobalt] | `synthwave` ![synthwave][synthwave] | `highcontrast` ![highcontrast][highcontrast] |
@@ -32,10 +33,12 @@ Use `?theme=THEME_NAME` parameter like so :-
| `jolly` ![jolly][jolly] | `maroongold` ![maroongold][maroongold] | `yeblu` ![yeblu][yeblu] | | `jolly` ![jolly][jolly] | `maroongold` ![maroongold][maroongold] | `yeblu` ![yeblu][yeblu] |
| `blueberry` ![blueberry][blueberry] | `slateorange` ![slateorange][slateorange] | `kacho_ga` ![kacho_ga][kacho_ga] | | `blueberry` ![blueberry][blueberry] | `slateorange` ![slateorange][slateorange] | `kacho_ga` ![kacho_ga][kacho_ga] |
| `outrun` ![outrun][outrun] | `ocean_dark` ![ocean_dark][ocean_dark] | `city_lights` ![city_lights][city_lights] | | `outrun` ![outrun][outrun] | `ocean_dark` ![ocean_dark][ocean_dark] | `city_lights` ![city_lights][city_lights] |
| `github_dark` ![github_dark][github_dark] | `discord_old_blurple` ![discord_old_blurple][discord_old_blurple] | `aura_dark` ![aura_dark][aura_dark] | | `github_dark` ![github_dark][github_dark] | `github_dark_dimmed` ![github_dark_dimmed][github_dark_dimmed] | `discord_old_blurple` ![discord_old_blurple][discord_old_blurple] |
| `panda` ![panda][panda] | `noctis_minimus` ![noctis_minimus][noctis_minimus] | `cobalt2` ![cobalt2][cobalt2] | | `aura_dark` ![aura_dark][aura_dark] | `panda` ![panda][panda] | `noctis_minimus` ![noctis_minimus][noctis_minimus] |
| `swift` ![swift][swift] | `aura` ![aura][aura] | `apprentice` ![apprentice][apprentice] | | `cobalt2` ![cobalt2][cobalt2] | `swift` ![swift][swift] | `aura` ![aura][aura] |
| `moltack` ![moltack][moltack] | `codeSTACKr` ![codeSTACKr][codeSTACKr] | `rose_pine` ![rose_pine][rose_pine] | | `apprentice` ![apprentice][apprentice] | `moltack` ![moltack][moltack] | `codeSTACKr` ![codeSTACKr][codeSTACKr] |
| `rose_pine` ![rose_pine][rose_pine] | `date_night` ![date_night][date_night] | `one_dark_pro` ![one_dark_pro][one_dark_pro] |
| `rose` ![rose][rose] | `holi` ![holi][holi] | `neon` ![neon][neon] |
| [Add your theme][add-theme] | | | | [Add your theme][add-theme] | | |
## Repo Card ## Repo Card
@@ -44,7 +47,8 @@ Use `?theme=THEME_NAME` parameter like so :-
| | | | | | | |
| :--: | :--: | :--: | | :--: | :--: | :--: |
| `default_repocard` ![default_repocard][default_repocard_repo] | `transparent` ![transparent][transparent_repo] | `dark` ![dark][dark_repo] | | `default_repocard` ![default_repocard][default_repocard_repo] | `transparent` ![transparent][transparent_repo] | `shadow_red` ![shadow_red][shadow_red_repo] |
| `shadow_green` ![shadow_green][shadow_green_repo] | `shadow_blue` ![shadow_blue][shadow_blue_repo] | `dark` ![dark][dark_repo] |
| `radical` ![radical][radical_repo] | `merko` ![merko][merko_repo] | `gruvbox` ![gruvbox][gruvbox_repo] | | `radical` ![radical][radical_repo] | `merko` ![merko][merko_repo] | `gruvbox` ![gruvbox][gruvbox_repo] |
| `gruvbox_light` ![gruvbox_light][gruvbox_light_repo] | `tokyonight` ![tokyonight][tokyonight_repo] | `onedark` ![onedark][onedark_repo] | | `gruvbox_light` ![gruvbox_light][gruvbox_light_repo] | `tokyonight` ![tokyonight][tokyonight_repo] | `onedark` ![onedark][onedark_repo] |
| `cobalt` ![cobalt][cobalt_repo] | `synthwave` ![synthwave][synthwave_repo] | `highcontrast` ![highcontrast][highcontrast_repo] | | `cobalt` ![cobalt][cobalt_repo] | `synthwave` ![synthwave][synthwave_repo] | `highcontrast` ![highcontrast][highcontrast_repo] |
@@ -60,16 +64,21 @@ Use `?theme=THEME_NAME` parameter like so :-
| `jolly` ![jolly][jolly_repo] | `maroongold` ![maroongold][maroongold_repo] | `yeblu` ![yeblu][yeblu_repo] | | `jolly` ![jolly][jolly_repo] | `maroongold` ![maroongold][maroongold_repo] | `yeblu` ![yeblu][yeblu_repo] |
| `blueberry` ![blueberry][blueberry_repo] | `slateorange` ![slateorange][slateorange_repo] | `kacho_ga` ![kacho_ga][kacho_ga_repo] | | `blueberry` ![blueberry][blueberry_repo] | `slateorange` ![slateorange][slateorange_repo] | `kacho_ga` ![kacho_ga][kacho_ga_repo] |
| `outrun` ![outrun][outrun_repo] | `ocean_dark` ![ocean_dark][ocean_dark_repo] | `city_lights` ![city_lights][city_lights_repo] | | `outrun` ![outrun][outrun_repo] | `ocean_dark` ![ocean_dark][ocean_dark_repo] | `city_lights` ![city_lights][city_lights_repo] |
| `github_dark` ![github_dark][github_dark_repo] | `discord_old_blurple` ![discord_old_blurple][discord_old_blurple_repo] | `aura_dark` ![aura_dark][aura_dark_repo] | | `github_dark` ![github_dark][github_dark_repo] | `github_dark_dimmed` ![github_dark_dimmed][github_dark_dimmed_repo] | `discord_old_blurple` ![discord_old_blurple][discord_old_blurple_repo] |
| `panda` ![panda][panda_repo] | `noctis_minimus` ![noctis_minimus][noctis_minimus_repo] | `cobalt2` ![cobalt2][cobalt2_repo] | | `aura_dark` ![aura_dark][aura_dark_repo] | `panda` ![panda][panda_repo] | `noctis_minimus` ![noctis_minimus][noctis_minimus_repo] |
| `swift` ![swift][swift_repo] | `aura` ![aura][aura_repo] | `apprentice` ![apprentice][apprentice_repo] | | `cobalt2` ![cobalt2][cobalt2_repo] | `swift` ![swift][swift_repo] | `aura` ![aura][aura_repo] |
| `moltack` ![moltack][moltack_repo] | `codeSTACKr` ![codeSTACKr][codeSTACKr_repo] | `rose_pine` ![rose_pine][rose_pine_repo] | | `apprentice` ![apprentice][apprentice_repo] | `moltack` ![moltack][moltack_repo] | `codeSTACKr` ![codeSTACKr][codeSTACKr_repo] |
| `rose_pine` ![rose_pine][rose_pine_repo] | `date_night` ![date_night][date_night_repo] | `one_dark_pro` ![one_dark_pro][one_dark_pro_repo] |
| `rose` ![rose][rose_repo] | `holi` ![holi][holi_repo] | `neon` ![neon][neon_repo] |
| [Add your theme][add-theme] | | | | [Add your theme][add-theme] | | |
[default]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=default [default]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=default
[default_repocard]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=default_repocard [default_repocard]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=default_repocard
[transparent]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=transparent [transparent]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=transparent
[shadow_red]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=shadow_red
[shadow_green]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=shadow_green
[shadow_blue]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=shadow_blue
[dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=dark [dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=dark
[radical]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=radical [radical]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=radical
[merko]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=merko [merko]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=merko
@@ -117,6 +126,7 @@ Use `?theme=THEME_NAME` parameter like so :-
[ocean_dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=ocean_dark [ocean_dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=ocean_dark
[city_lights]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=city_lights [city_lights]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=city_lights
[github_dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=github_dark [github_dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=github_dark
[github_dark_dimmed]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=github_dark_dimmed
[discord_old_blurple]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=discord_old_blurple [discord_old_blurple]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=discord_old_blurple
[aura_dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=aura_dark [aura_dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=aura_dark
[panda]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=panda [panda]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=panda
@@ -128,11 +138,19 @@ Use `?theme=THEME_NAME` parameter like so :-
[moltack]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=moltack [moltack]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=moltack
[codeSTACKr]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=codeSTACKr [codeSTACKr]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=codeSTACKr
[rose_pine]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=rose_pine [rose_pine]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=rose_pine
[date_night]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=date_night
[one_dark_pro]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=one_dark_pro
[rose]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=rose
[holi]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=holi
[neon]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=neon
[default_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default [default_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default
[default_repocard_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default_repocard [default_repocard_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default_repocard
[transparent_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=transparent [transparent_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=transparent
[shadow_red_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=shadow_red
[shadow_green_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=shadow_green
[shadow_blue_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=shadow_blue
[dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dark [dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dark
[radical_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=radical [radical_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=radical
[merko_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=merko [merko_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=merko
@@ -180,6 +198,7 @@ Use `?theme=THEME_NAME` parameter like so :-
[ocean_dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=ocean_dark [ocean_dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=ocean_dark
[city_lights_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=city_lights [city_lights_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=city_lights
[github_dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=github_dark [github_dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=github_dark
[github_dark_dimmed_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=github_dark_dimmed
[discord_old_blurple_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=discord_old_blurple [discord_old_blurple_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=discord_old_blurple
[aura_dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=aura_dark [aura_dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=aura_dark
[panda_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=panda [panda_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=panda
@@ -191,6 +210,11 @@ Use `?theme=THEME_NAME` parameter like so :-
[moltack_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=moltack [moltack_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=moltack
[codeSTACKr_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=codeSTACKr [codeSTACKr_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=codeSTACKr
[rose_pine_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=rose_pine [rose_pine_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=rose_pine
[date_night_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=date_night
[one_dark_pro_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=one_dark_pro
[rose_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=rose
[holi_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=holi
[neon_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=neon
[add-theme]: https://github.com/anuraghazra/github-readme-stats/edit/master/themes/index.js [add-theme]: https://github.com/anuraghazra/github-readme-stats/edit/master/themes/index.js
+63
View File
@@ -18,6 +18,27 @@ export const themes = {
text_color: "417E87", text_color: "417E87",
bg_color: "ffffff00", bg_color: "ffffff00",
}, },
shadow_red: {
title_color: "9A0000",
text_color: "444",
icon_color: "4F0000",
border_color: "4F0000",
bg_color: "ffffff00",
},
shadow_green: {
title_color: "007A00",
text_color: "444",
icon_color: "003D00",
border_color: "003D00",
bg_color: "ffffff00",
},
shadow_blue: {
title_color: "00779A",
text_color: "444",
icon_color: "004450",
border_color: "004490",
bg_color: "ffffff00",
},
dark: { dark: {
title_color: "fff", title_color: "fff",
icon_color: "79ff97", icon_color: "79ff97",
@@ -300,6 +321,13 @@ export const themes = {
text_color: "C3D1D9", text_color: "C3D1D9",
bg_color: "0D1117", bg_color: "0D1117",
}, },
github_dark_dimmed: {
title_color: "539bf5",
icon_color: "539bf5",
text_color: "ADBAC7",
bg_color: "24292F",
border_color: "373E47",
},
discord_old_blurple: { discord_old_blurple: {
title_color: "7289DA", title_color: "7289DA",
icon_color: "7289DA", icon_color: "7289DA",
@@ -367,6 +395,41 @@ export const themes = {
text_color: "e0def4", text_color: "e0def4",
bg_color: "191724", bg_color: "191724",
}, },
date_night: {
title_color: "DA7885",
text_color: "E1B2A2",
icon_color: "BB8470",
border_color: "170F0C",
bg_color: "170F0C",
},
one_dark_pro: {
title_color: "61AFEF",
text_color: "E5C06E",
icon_color: "C678DD",
border_color: "3B4048",
bg_color: "23272E",
},
rose: {
title_color: "8d192b",
text_color: "862931",
icon_color: "B71F36",
border_color: "e9d8d4",
bg_color: "e9d8d4",
},
holi: {
title_color: "5FABEE",
text_color: "D6E7FF",
icon_color: "5FABEE",
border_color: "85A4C0",
bg_color: "030314",
},
neon: {
title_color: "00EAD3",
text_color: "FF449F",
icon_color: "00EAD3",
border_color: "ffffff",
bg_color: "000000",
},
}; };
export default themes; export default themes;
+1 -1
View File
@@ -2,7 +2,7 @@
"functions": { "functions": {
"api/*.js": { "api/*.js": {
"memory": 128, "memory": 128,
"maxDuration": 30 "maxDuration": 10
} }
}, },
"redirects": [ "redirects": [