https://github.com/wilk/thanc
⭐ Thanc: a smarty way to thank NPM packages authors by starring their repos
https://github.com/wilk/thanc
github nodejs npm star thank thankfulness
Last synced: about 2 months ago
JSON representation
⭐ Thanc: a smarty way to thank NPM packages authors by starring their repos
- Host: GitHub
- URL: https://github.com/wilk/thanc
- Owner: wilk
- License: mit
- Created: 2017-12-23T02:58:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-08T08:26:14.000Z (over 7 years ago)
- Last Synced: 2025-03-26T18:43:36.689Z (3 months ago)
- Topics: github, nodejs, npm, star, thank, thankfulness
- Language: JavaScript
- Homepage:
- Size: 5 MB
- Stars: 38
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
*Thanks to [@julietjul](https://twitter.com/julietjul) for thanc's logo*
thanc: a smarty way to thank the authors of NPM packages by starring their repos on Github :heart:
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:
and then, after too many repos:
Inspired by:
- https://github.com/zwilias/elm-thanks
- https://github.com/symfony/thanks
## 🤔 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](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b):
```bash
$ npx thanc --me
```
### Install locally
```bash
$ npm i -D thanc
```
Then, under the scripts section of your `package.json`:
```bash
"thanc": "thanc ."
```
And then:
```bash
$ npm run thanc
```
### Install globally
```bash
$ npm i -g thanc
```
Then:
```bash
$ thanc
```
## ⚙ Usage
Thanking current folder:
```bash
$ thanc
```
Thanking an online Github repo:
```bash
$ thanc https://github.com/wilk/thanc
```
Thanking a specific folder:
```bash
$ thanc myProject
```
Thanking the `thanc` project:
```bash
$ thanc --me
```
Thanking without seeing the repos list but a progress bar instead:
```bash
$ thanc --quite .
```
### Explicit credentials
**Basic Auth**
```bash
$ thanc -u -p .
```
**User Token**
Explicit:
```bash
$ thanc -t .
```
Via `GITHUB_TOKEN` env var:
```bash
$ export 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](https://github.com/settings/tokens/new)** here with `public_repo` permission)
## 📖 Help
thanc has several options you can check through `--help`:
```bash
$ thanc --help
Usage: thanc [options]
Options:
-V, --version output the version number
--me thank thanc package and all of its dependencies
-u, --username your Github username
-p, --password your Github password
-t, --token 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`):
```bash
$ md5sum dist.js
```
The result must be equal to checksums listed inside the `package.json`.
The build verification process can be done as follows:
```bash
$ 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](https://developer.github.com/v3/#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 :muscle:
2. [abuse rate limit](https://developer.github.com/v3/#abuse-rate-limits): 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