Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andr-ll/npsh
Node.js package scripts helper
https://github.com/andr-ll/npsh
ci helpers-library javascript nodejs scripts
Last synced: about 1 month ago
JSON representation
Node.js package scripts helper
- Host: GitHub
- URL: https://github.com/andr-ll/npsh
- Owner: andr-ll
- License: mit
- Created: 2022-12-30T15:20:29.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T05:56:19.000Z (5 months ago)
- Last Synced: 2024-10-16T20:05:27.824Z (3 months ago)
- Topics: ci, helpers-library, javascript, nodejs, scripts
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/npsh
- Size: 1.73 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# npsh
[![NPM][npm-img]][npm-url]
[![Coverage][coverage-img]][coverage-url]
[![License][license-pic]][license-url]
[![Downloads][npm-downloads]][npm-url]
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
```bash
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:
```json
"svc": "npsh svc github_user_name project_name branch_name"
```
And a real example which will be checking PR/branch version against master branch:
```json
"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.
```json
"hooks": "npsh hooks"
```
Then simply run following command to add commit hooks:
```bash
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.
```json
"build:bin": "npsh bin"
```
After execution this script will create a default `./bin/index.js` file
at your project directory:
```js
#!/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:
```json
"build:bin": "npsh bin 'myFunc()'"
```
After execution `./bin/index.js` will have following content:
```js
#!/urs/bin/env node
require('../lib').myFunc();
```
[npm-img]: https://img.shields.io/npm/v/npsh.svg?logo=npm
[npm-url]: https://www.npmjs.com/package/npsh
[npm-downloads]: https://img.shields.io/npm/dt/npsh?logo=Hack%20The%20Box&logoColor=green&label=downloads
[coverage-img]: https://img.shields.io/coverallsCoverage/github/andr-ii/npsh?label=coverage&logo=jest
[coverage-url]: https://coveralls.io/github/andr-ii/npsh?branch=master
[license-pic]: https://img.shields.io/github/license/andr-ii/npsh?color=blue&label=%C2%A9%20license
[license-url]: https://github.com/andr-ii/npsh/blob/master/LICENSE