简体中文

github-lang-box

Fork of lang-stats-box with some customizations:

• Updated dependencies, Rewritten in TypeScript
• Published to npm, Added binary for use with npx or pnpx
• Use /user/repos endpoint to fetch all repos of the user (including private repos)
• Custom description, exclude languages and repositories!

Note: Due to the use of /user/repos endpoint, the Fine-grained access tokens must have the metadata:read permission.

Setup

Prep work

1. Create a new public GitHub Gist (https://gist.github.com/)
2. Create an access token with the gist and metadata:read scopes and copy it.(https://github.com/settings/tokens?type=beta)

Project setup

1. Copy this workflow file to your repo's .github/workflows directory.
2. Go to the repo Settings > Secrets
3. Add the following environment variables:
   • GH_TOKEN: The GitHub access token generated above.
   • GIST_ID: The ID portion from your gist url: https://gist.github.com/Aveek-Saha/ 8335e85451541072dd25fda601129f7d.
   • GH_USERNAME: Your GitHub account username.
   • EXCLUDE: A comma-separated list of languages you want to exclude from the gist. Eg: Jupyter Notebook, CSS, TeX, PHP
   • EXCLUDE_REPO: A comma-separated list of repositories you want to exclude from the gist. Eg: username/repo1, username/repo2
   • DESCRIPTION: A custom description for the gist.

Use as a CLI

Add environment variables to the .env file or export them in the shell, then run:

npx github-lang-box@2
# or
# pnpx github-lang-box@2

Additionally, you can use these commands in your GitHub Actions with a Node.js runtime. Please take a look at the this workflow file.

Options

• --dry: Dry run, only fetch the data and print the output.

Credits

This code was inspired by @matchai's bird-box.

This is a fork of @Aveek-Saha's lang-stats-box.