Feature: Add gist card #3064

qwerty541 · 2023-08-11T04:42:21Z

This pull request adds new endpoint https://github-readme-stats-2p1ibrtpu-github-readme-stats-team.vercel.app/api/gist?id=1e0f4ebcc7c35bdee2cae9ccf6fec6ec which generates gist cards. Some examples provided below. What do you think @rickstaa @francois-rozet @anuraghazra @VydrOz?

Preview deployed there:

https://github-readme-stats-2p1ibrtpu-github-readme-stats-team.vercel.app/

TODOS:

docs
tests
refactoring

vercel · 2023-08-11T04:42:25Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
github-readme-stats	✅ Ready (Inspect)	Visit Preview	Aug 13, 2023 10:41pm

codecov · 2023-08-11T04:43:22Z

Codecov Report

Patch coverage: 98.95% and project coverage change: +0.06% 🎉

Comparison is base (135176f) 97.62% compared to head (2ccd9a4) 97.69%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3064      +/-   ##
==========================================
+ Coverage   97.62%   97.69%   +0.06%     
==========================================
  Files          24       26       +2     
  Lines        5343     5630     +287     
  Branches      466      487      +21     
==========================================
+ Hits         5216     5500     +284     
- Misses        125      128       +3     
  Partials        2        2

Files Changed	Coverage Δ
src/fetchers/gist-fetcher.js	`97.16% <97.16%> (ø)`
src/cards/gist-card.js	`100.00% <100.00%> (ø)`
src/common/icons.js	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

VydrOz · 2023-08-11T09:55:45Z

This pull request adds new endpoint http://localhost:3000/api/gist?username=rickstaa&id=1e0f4ebcc7c35bdee2cae9ccf6fec6ec which generates gist cards. Some examples provided below. What do you think?

Perfect. I suppose we can use the same themes as the other cards.

qwerty541

This pull request adds new endpoint http://localhost:3000/api/gist?username=rickstaa&id=1e0f4ebcc7c35bdee2cae9ccf6fec6ec which generates gist cards. Some examples provided below. What do you think?

Perfect. I suppose we can use the same themes as the other cards.

Right, this card supports all themes like the rest. I've updated the pull request description and added some examples. You can check other themes using this preview deploy of this branch: https://github-readme-stats-ksyzpjxl9-github-readme-stats-team.vercel.app/

rickstaa

See my comments. I think using the GraphQL endpoint would make more sense. What do you think?

rickstaa · 2023-08-12T07:28:10Z

src/fetchers/gist-fetcher.js

+  const response = (
+    await axios({
+      method: "get",
+      url: `https://api.github.com/gists/${id}`,


I think we can get all information from the GraphQL API:

{ viewer { gist(name: "fb514518d708593b9a218eb61381e400") { name owner { login } stargazerCount forks { totalCount } files{ language { name } size } } } }

This way, we don't need to add the parseHTML library.

Yes, you're right, this way is better since we send only one request instead of two and we don't need additional library for HTML parsing. I have updated the code.

rickstaa · 2023-08-12T07:30:29Z

src/fetchers/gist-fetcher.js

+      response.files[Object.keys(response.files)[0]].filename
+    }`,
+    description: response.description,
+    language: response.files[Object.keys(response.files)[0]].language,


I understand why you use the language of the first file but a gist can have multiple files. Maybe we can use the language of the file that has the biggest size?

I wrote little function for calculating primary language by files size.

https://github.com/anuraghazra/github-readme-stats/pull/3064/files#diff-85d91b5e80c17d5aa6499442fb72b2f5cc1a263e176ccba2187f106163584603R85-R103

Tell me what do you think

Amazing! I checked your code, and I think it is very well-coded 👍🏻. I guess for consistency; it would be nice:

If we add a snapshot test (see https://github.com/anuraghazra/github-readme-stats/blob/master/tests/fetchTopLanguages.test.js, for example).

Apart from that, I think this pull request can be merged 🚀!

rickstaa

Check the comments above 👍🏻. Apart from that, good to go!

rickstaa · 2023-08-13T10:42:28Z

tests/renderGistCard.test.js

@@ -0,0 +1,79 @@
+import { renderGistCard } from "../src/cards/gist-card";
+import { describe, expect, it } from "@jest/globals";


Maybe we can add a snapshot test for consistency with the other cards (see https://github.com/anuraghazra/github-readme-stats/blob/master/tests/fetchTopLanguages.test.js for an example for example) 🤔?

I planned to cover new gist card code with tests completely. As you can see i have some todos at the bottom of pull request description and writing tests still actual. Currently i wrote all basic tests including rendering, fetching data and e2e. They works. We can merge this pull request now and increase tests converage to 100% step by step later. Or we can wait for full converage. On your chice, i have converted this pull requests from draft into ready to merge. Feel free to merge.

…card

rickstaa · 2023-08-14T09:28:32Z

@qwerty541, thanks for implementing this. Merged into main!

qwerty541 · 2023-08-14T10:10:37Z

@qwerty541, thanks for implementing this. Merged into main!

Awesome!

@VydrOz Thank you for great idea suggestion and feedback!

@rickstaa Thank you for fast review and useful code improvements suggestions!

It was pleasure for me to implement this together with you.

* Feature: Add gist card * dev * dev * dev * dev * dev * dev * e2e * e2e test timeout

Feature: Add gist card

ad57cbd

qwerty541 requested a review from rickstaa August 11, 2023 04:42

qwerty541 marked this pull request as draft August 11, 2023 04:42

github-actions bot added the dependencies Pull requests that update a dependency file label Aug 11, 2023

qwerty541 linked an issue Aug 11, 2023 that may be closed by this pull request

[Feature] Card for GitHub Gist #3047

Closed

dev

3bdc691

vercel bot deployed to Preview August 11, 2023 16:52 View deployment

qwerty541 commented Aug 11, 2023

View reviewed changes

dev

5f461b4

github-actions bot added the documentation Improvements or additions to documentation. label Aug 11, 2023

vercel bot deployed to Preview August 11, 2023 17:24 View deployment

dev

5b3d460

vercel bot deployed to Preview August 11, 2023 17:26 View deployment

dev

4770b1c

vercel bot deployed to Preview August 11, 2023 18:08 View deployment

qwerty541 added enhancement New feature or request. new-card New card proposal. javascript Pull requests that update Javascript code feature labels Aug 11, 2023

rickstaa requested changes Aug 12, 2023

View reviewed changes

github-actions bot added the ⭐ top pull request Top pull request. label Aug 13, 2023

github-actions bot mentioned this pull request Aug 13, 2023

Top Issues Dashboard #1935

Open

dev

c606152

github-actions bot removed the dependencies Pull requests that update a dependency file label Aug 13, 2023

vercel bot deployed to Preview August 13, 2023 07:29 View deployment

rickstaa self-requested a review August 13, 2023 10:41

rickstaa approved these changes Aug 13, 2023

View reviewed changes

dev

c693a2d

vercel bot deployed to Preview August 13, 2023 22:19 View deployment

e2e

10d1bad

vercel bot deployed to Preview August 13, 2023 22:31 View deployment

e2e test timeout

e25b033

vercel bot deployed to Preview August 13, 2023 22:33 View deployment

qwerty541 marked this pull request as ready for review August 13, 2023 22:37

Merge remote-tracking branch 'upstream/master' into feature_add_gist_…

2ccd9a4

…card

vercel bot deployed to Preview August 13, 2023 22:41 View deployment

qwerty541 added the gist-card label Aug 13, 2023

rickstaa approved these changes Aug 14, 2023

View reviewed changes

rickstaa merged commit fe901dd into master Aug 14, 2023
6 checks passed

rickstaa deleted the feature_add_gist_card branch August 14, 2023 09:28

devantler pushed a commit to devantler/github-readme-stats that referenced this pull request Sep 24, 2023

Feature: Add gist card (anuraghazra#3064)

5377150

* Feature: Add gist card * dev * dev * dev * dev * dev * dev * e2e * e2e test timeout

commit-lint bot mentioned this pull request Nov 7, 2023

[pull] master from anuraghazra:master Crushoverride007/readme-stats#2

Open

ABA2396 pushed a commit to ABA2396/github-readme-stats that referenced this pull request Dec 22, 2023

Feature: Add gist card (anuraghazra#3064)

0977885

* Feature: Add gist card * dev * dev * dev * dev * dev * dev * e2e * e2e test timeout

ABA2396 pushed a commit to ABA2396/github-readme-stats that referenced this pull request Dec 22, 2023

Feature: Add gist card (anuraghazra#3064)

743b30e

* Feature: Add gist card * dev * dev * dev * dev * dev * dev * e2e * e2e test timeout

setdebarr pushed a commit to setdebarr/github-readme-stats that referenced this pull request Jan 12, 2024

Feature: Add gist card (anuraghazra#3064)

53faf0c

* Feature: Add gist card * dev * dev * dev * dev * dev * dev * e2e * e2e test timeout

jacobbexten pushed a commit to jacobbexten/github-readme-stats that referenced this pull request Nov 6, 2024

Feature: Add gist card (anuraghazra#3064)

cf23702

* Feature: Add gist card * dev * dev * dev * dev * dev * dev * e2e * e2e test timeout

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Add gist card #3064

Feature: Add gist card #3064

qwerty541 commented Aug 11, 2023 •

edited

Loading

vercel bot commented Aug 11, 2023 •

edited

Loading

codecov bot commented Aug 11, 2023 •

edited

Loading

VydrOz commented Aug 11, 2023

qwerty541 left a comment

rickstaa left a comment

rickstaa Aug 12, 2023

qwerty541 Aug 13, 2023

rickstaa Aug 12, 2023

qwerty541 Aug 13, 2023

rickstaa Aug 13, 2023 •

edited

Loading

rickstaa left a comment

rickstaa Aug 13, 2023 •

edited

Loading

qwerty541 Aug 13, 2023

rickstaa commented Aug 14, 2023

qwerty541 commented Aug 14, 2023

		@@ -0,0 +1,79 @@
		import { renderGistCard } from "../src/cards/gist-card";
		import { describe, expect, it } from "@jest/globals";

Feature: Add gist card #3064

Feature: Add gist card #3064

Conversation

qwerty541 commented Aug 11, 2023 • edited Loading

vercel bot commented Aug 11, 2023 • edited Loading

codecov bot commented Aug 11, 2023 • edited Loading

Codecov Report

VydrOz commented Aug 11, 2023

qwerty541 left a comment

Choose a reason for hiding this comment

rickstaa left a comment

Choose a reason for hiding this comment

rickstaa Aug 12, 2023

Choose a reason for hiding this comment

qwerty541 Aug 13, 2023

Choose a reason for hiding this comment

rickstaa Aug 12, 2023

Choose a reason for hiding this comment

qwerty541 Aug 13, 2023

Choose a reason for hiding this comment

rickstaa Aug 13, 2023 • edited Loading

Choose a reason for hiding this comment

rickstaa left a comment

Choose a reason for hiding this comment

rickstaa Aug 13, 2023 • edited Loading

Choose a reason for hiding this comment

qwerty541 Aug 13, 2023

Choose a reason for hiding this comment

rickstaa commented Aug 14, 2023

qwerty541 commented Aug 14, 2023

qwerty541 commented Aug 11, 2023 •

edited

Loading

vercel bot commented Aug 11, 2023 •

edited

Loading

codecov bot commented Aug 11, 2023 •

edited

Loading

rickstaa Aug 13, 2023 •

edited

Loading

rickstaa Aug 13, 2023 •

edited

Loading