GRS as an npm module!

[Zo-Bro-23]

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[bot]]

@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.

[ofek]

Is this almost ready?

[neverbot]

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]

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.