A command set help you to take care of your GitHub/NPM accounts
It is really tedious to initialise an NPM package step by step. You have to:
- Create a repository on GitHub.com;
- Create a local copy by cloning (or
git remote add ...
); - Initialise as an NPM package via
npm init
; - Input "git repository" info by hand;
- Input same "author" info again and again (unless you are used to change identities when developping different packages);
- Scarffold README.md, CHANGELOG.md to make your package seem formal;
- Scarffold unit test framework;
- ...
Now, ching will help you to complete all previous tasks IN A FEW SECONDS!
Up to now, ching is a just a set of commands without any APIs exposed.
Before starting, please get the following ready:
- You should have registered on npmjs.com.
- You should have registered on GitHub, and have created a personal access token with "repo" scope actived.
On running, you may be asked for following informations about your GitHub/NPM accounts:
- your GitHub personal access token *
- your e-mail address
- your name
- your homepage url
Rest asured that secret information (marked with asterisk) will only saved locally and be used deliberately. Others may be published along with README.md / package.json etc.
# Create an empty directory firstly.
mkdir example && cd example
# Run "ching init" command interactively.
ching init
APIs are not available yet.
This command interactively leads you to,
- create remote repository on GitHub.com
- make current directory initialized to be a Git repository and bound to the remote one
- create/edit package.json
- create scaffording for the package
Similiar to ching init, this command will help you to create remote repository on GitHub.com and bound it to local Git repository.
Remove remote repostiroy on GitHub.com.
This command interactively leads you to,
- delete remote repository on GitHub.com, create a new one and simultaneously re-bound local repository to it
- change the name of current NPM package
This command removes all local-saved information about your GitHub/NPM accounts.
Display owner of NPM / GitHub accounts used by ching.
ching is my name, my favor and my fate.