GRS as an npm module! #2473

Zo-Bro-23 · 2023-01-26T12:50:11Z

The path towards #2179; releases GRS as an NPM module.

Note: Currently the NPM module only supports ESM, meaning that CJS users who try to do require() will get an error. We should consider using babel to automatically convert ESM to CJS before releasing to NPM.

Things are currently working on my end, and I've published a test package @zo-bro-23/github-readme-stats-test. This is only a draft though, and let's work on more features (such as automatic releases with GH Actions) and fix issues with the current code.

vercel · 2023-01-26T12:50:14Z

@Zo-Bro-23 is attempting to deploy a commit to the github readme stats Team on Vercel.

A member of the Team first needs to authorize it.

Zo-Bro-23 · 2023-01-26T12:50:38Z

.husky/pre-commit

@@ -1,5 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"

-npm test
 npx lint-staged


Kept showing errors when I tried commiting. @rickstaa any idea why that is?

I'm not sure what causes the error. You need to update the tests a bit to let them work with your pull request. You can debug these tests with the https://github.com/jest-community/vscode-jest plugin. Sadly, I don't have time to look at it for the next three months 😅.

This line should stay since we want the tests to run when people try to commit. 🤔

Zo-Bro-23 · 2023-01-26T12:51:29Z

api/pin.js

-    if (!cache_seconds && (isBothOver1K || isBothUnder1)) {
-      cacheSeconds = CONSTANTS.FOUR_HOURS;
-    }
-
    res.setHeader(


This doesn't seem to be very effective as the default cache is anyways FOUR_HOURS. Let me know if I should add it back.

This doesn't seem to be very effective as the default cache is anyways FOUR_HOURS. Let me know if I should add it back.

Think this should be EIGHT_HOURS now that we increased the default to FOUR_HOURS.

Zo-Bro-23 · 2023-01-26T12:52:07Z

package.json

-  "name": "github-readme-stats",
-  "version": "1.0.0",
+  "name": "@zo-bro-23/github-readme-stats-test",
+  "version": "1.0.5",
  "description": "Dynamically generate stats for your GitHub readme",


This is only temporary. I will change it to the actual package name before merging.

Zo-Bro-23 · 2023-01-26T12:52:19Z

src/common/blacklist.js

+  "technote-space",
+  "sw-yx",
+  "blacklistedUser", // For testing purposes
+];


Is this a problem? Makes testing easier.

It should not be a problem.

Zo-Bro-23 · 2023-01-26T12:54:10Z

src/generators/stats.js

+
+  if (blacklist.includes(username)) {
+    return renderError("Something went wrong");
+  }


Maybe we should change this to a throw instead of a return. That way, users can choose to show the error card or not. Currently, if I use the NPM package, this is what my code will look like:

import express from "express"; import { generateStatsCard } from "@zo-bro-23/github-readme-stats-test"; const app = express(); app.get("/", (req, res) => { res.setHeader("Content-Type", "image/svg+xml"); generateStatsCard({ username: "Zo-Bro-23" }).then((card) => { res.send(card); }); }); app.listen(8000);

The .then() gets fired for errors too, and even if I added a .catch(), it would never get fired. Separating errors and successful responses might be the best way to move forward.

It makes sense when people use this as an NPM package. 👍🏻 I think @anuraghazra added it this way to fix some renovate problems. 🤔

Zo-Bro-23 · 2023-01-26T12:55:03Z

src/index.js

 export * from "./cards/index.js";
-export { getStyles, getAnimations } from "./getStyles.js";
+export * from "./generators/index.js";


Any reason why you're exporting these? These should be internal functions, and not exported. Keeping these as is bloats up the NPM package when I use import *, since everything from the CONSTANTS to the utils functions gets loaded in.

I wanted to allow other developers to use these functions when they implement new cards. You are right however if the npm package is setup the right way people can just use the Card class. 👍🏻

ofek · 2023-05-06T13:45:11Z

Is this almost ready?

neverbot · 2023-09-06T09:20:14Z

Hi!

I think this is blocking #2537 which is blocking #2603, which is a top bug and I think is making the stats unusable for a lot of people (in my case, 9 out of 10 times they do not appear).

Is there something we can do?

rickstaa · 2023-09-12T07:37:13Z

The path towards #2179; releases GRS as an NPM module.

Note: Currently the NPM module only supports ESM, meaning that CJS users who try to do require() will get an error. We should consider using babel to automatically convert ESM to CJS before releasing to NPM.

Things are currently working on my end, and I've published a test package @zo-bro-23/github-readme-stats-test. This is only a draft though, and let's work on more features (such as automatic releases with GH Actions) and fix issues with the current code.

Pending Tasks:

Decide whether to support CJS modules: In my view, supporting this legacy feature may not be necessary, considering there hasn't been an npm package utilizing it in the past. We could opt to support ESM modules exclusively. I'd like to hear the opinions of @Zo-Bro-23, @anuraghazra, and @qwerty541 on this matter.
Pull Request Review: One of us, including other collaborators, should review this pull request. Additional eyes on the code can help expedite the merge process. 👍🏻
Create GRS npm Organization and Package Release: It's essential that @anuraghazra establishes the GRS npm organization and proceeds with the package release.

@Zo-Bro-23, please feel free to add any other tasks that may have been overlooked.

Zo-Bro-23 added 2 commits January 26, 2023 12:45

Initial commit

df67324

Commit

976fbf6

Zo-Bro-23 commented Jan 26, 2023

View reviewed changes

Zo-Bro-23 mentioned this pull request Feb 9, 2023

Create GRS action #2179

Open

3 tasks

This was referenced Feb 23, 2023

GRS Action 🎉🎉 #2537

Open

Top languages sorted by repositories or commits #2545

Closed

Zo-Bro-23 mentioned this pull request Feb 28, 2023

Support for GitLab #1563

Closed

rickstaa mentioned this pull request Jul 2, 2023

Export common modules as npm package #2152

Open

rickstaa mentioned this pull request Aug 17, 2023

HuggingFace Card? #3000

Closed

rickstaa mentioned this pull request Sep 3, 2023

Show all time contributed to #2282

Open

2 tasks

rickstaa mentioned this pull request Sep 11, 2023

How to solve "Maximum retries exceeded" #2415

Closed

rickstaa mentioned this pull request Oct 12, 2023

Add card generation website #1761

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GRS as an npm module! #2473

GRS as an npm module! #2473

Zo-Bro-23 commented Jan 26, 2023

vercel bot commented Jan 26, 2023

Zo-Bro-23 Jan 26, 2023

rickstaa Jan 28, 2023

rickstaa Jan 29, 2023

Zo-Bro-23 Jan 26, 2023

rickstaa Jan 28, 2023

Zo-Bro-23 Jan 26, 2023

Zo-Bro-23 Jan 26, 2023

rickstaa Jan 28, 2023 •

edited

Zo-Bro-23 Jan 26, 2023

rickstaa Jan 28, 2023

Zo-Bro-23 Jan 26, 2023

rickstaa Jan 28, 2023

ofek commented May 6, 2023

neverbot commented Sep 6, 2023

rickstaa commented Sep 12, 2023 •

edited

GRS as an npm module! #2473

Are you sure you want to change the base?

GRS as an npm module! #2473

Conversation

Zo-Bro-23 commented Jan 26, 2023

vercel bot commented Jan 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rickstaa Jan 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ofek commented May 6, 2023

neverbot commented Sep 6, 2023

rickstaa commented Sep 12, 2023 • edited

rickstaa Jan 28, 2023 •

edited

rickstaa commented Sep 12, 2023 •

edited