Skip to content

Latest commit

 

History

History
173 lines (121 loc) · 4.39 KB

README.md

File metadata and controls

173 lines (121 loc) · 4.39 KB
Raw

thanc

Thanks to @julietjul for thanc's logo

thanc: a smarty way to thank the authors of NPM packages by starring their repos on Github ❤️

With thanc you'll thank every dependency and sub-dependency (literally the whole dependencies tree) of a given project provided with a package.json (or better a package-lock.json) manifest. So yes, it works also with yarn 😺

This is what thanc looks like:

start

and then, after too many repos:

end

Inspired by:

🤔 Why thanc and not just thank?!?

Basically, because the thank (and also thanks) package already exists on NPM registry.

Thanc (or thancian) is the ancient english word to say thank, so that's why :bowtie:

🛠 Installation

thanc can be installed locally, globally or used with npx.

With NPX

If you've NPM 5.2+, then you can go ahead with npx:

$ npx thanc --me

Install locally

$ npm i -D thanc

Then, under the scripts section of your package.json:

"thanc": "thanc ."

And then:

$ npm run thanc

Install globally

$ npm i -g thanc

Then:

$ thanc

⚙ Usage

Thanking current folder:

$ thanc

Thanking an online Github repo:

$ thanc https://github.com/wilk/thanc

Thanking a specific folder:

$ thanc myProject

Thanking the thanc project:

$ thanc --me

Thanking without seeing the repos list but a progress bar instead:

$ thanc --quite .

Explicit credentials

Basic Auth

$ thanc -u <your_github_username> -p <your_github_password> .

User Token

Explicit:

$ thanc -t <your_github_token> .

Via GITHUB_TOKEN env var:

$ export GITHUB_TOKEN=<your_github_token>; thanc .

🔒 Authentication Types Supported

thanc supports two types of authentication:

  • Basic: it requires your Github username and password
  • Token: it requires one of your Github user token (just create a new token here with public_repo permission)

📖 Help

thanc has several options you can check through --help:

$ thanc --help

  Usage: thanc [options] <project_path>


  Options:

    -V, --version              output the version number
    --me                       thank thanc package and all of its dependencies
    -u, --username <username>  your Github username
    -p, --password <password>  your Github password
    -t, --token <password>     your Github token
    -q, --quite                Show only the progress bar instead of the repos list
    -h, --help                 output usage information

🔑 Build Verification

thanc is published as a transpiled lib and so, for each new tag, a new build is performed, generating the dist.js file.

To verify if dist.js is exactly the transpiled version of thanc, a md5 checksum has been provided (and always up-to-date) inside the package.json (checksums):

$ md5sum dist.js

The result must be equal to checksums listed inside the package.json.

The build verification process can be done as follows:

$ git clone https://github.com/wilk/thanc
$ cd thanc
$ npm i
$ npm run build
# replace md5sum with your favourite md5 program
$ md5sum dist.js

✋ Limitations

Github APIs have some limitations:

  1. rate limiting: each user can perform 5000 requests per hour, so if you're using thanc intensively, you may encounter the rate limit error. Don't panic, take a coffee with a friend, and then start back starring repos 💪
  2. abuse rate limit: Github prevents making lots of rapidly requests for a single user (they want to guarantee the quality of service) so thanc stars chunks of 35 repos at a time.

💥 Known Issues

Some repos cannot be starred, due to:

  • missing repository property on package.json manifest
  • missing package on NPM registry (thanc relies on that)
  • missing repository on Github (thanc uses NPM registry info)

Sometimes, some repos can be starred twice because they might have a very similar url but different, pointing to the same github repo