andr-ll / npsh

Node.js package scripts helper

npsh

Node.js package scripts helper.

Includes commonly used scripts for CI, so they can be added from one npm package instead of being copied among different repos.

Installation

npm install npsh

Usage

Semantic version check

To check semantic version of your project create a "svc" script at the package.json file.

Here is an example with placeholders:

"svc": "npsh svc github_user_name project_name branch_name"

And a real example which will be checking PR/branch version against master branch:

"svc": "npsh svc andr-ii nuti master"

Commit hooks

For adding pre-commit and commit-msg hooks to your project create a "hooks" script at the package.json file.

"hooks": "npsh hooks"

Then simply run following command to add commit hooks:

npm run hooks

By default pre-commit hook includes:

• npm i --package-lock-only
• npm run format
• npm run lint
• npm run types
• npm run spell
• npm run svc
• git add .

So make sure these scripts are present at the package.json.

bin builder

b If your project has an executable ./bin/index.js file and you would like to avoid to have it in the development (TypeScript for example) project - npsh bin can be used. It generates ./bin/index.js executable file which requires your lib module by default.

Create a "build:bin" script at the package.json file.

"build:bin": "npsh bin"

After execution this script will create a default ./bin/index.js file at your project directory:

#!/urs/bin/env node

require('../lib');

If your lib module exports a function - it can be executed after require('../lib'). Change "build:bin" script as following:

"build:bin": "npsh bin 'myFunc()'"

After execution ./bin/index.js will have following content:

#!/urs/bin/env node

require('../lib').myFunc();

npsh's Issues

refactor: move files to lib directory