@beuluis/hook-cli

hook-cli

A small hook cli

· Report Bug · Request Feature ·

About The Project

A small hook cli that can be used with for example husky.

Disclaimer

I know that most of this stuff is already solved by some awesome tools. So this is really just a CLI playground for me.

Installation

npm i -D @beuluis/hook-cli

Usage

Run commands. For example using the hooks in .husky

```bash
npx hook-cli [command] [...]
```

Commands

checkForVulnerabilities

Runs a package audit and collects the results

Option	Description	Type	default
-m, --package-manager	The package manager you want to use. Keep in mind that both package managers report differently	yarn, npm	npm
-l, --audit-level	The severity of the vulnerabilities what the script will report	info, low, moderate, high, critical	critical
-n, --no-fail	If true only prints warning messages and do not exit with not zero code	boolean	false
-p, --prod	If true only run audit for prod dependencies and skip dev ones	boolean	false

Example usage

npx hook-cli checkForVulnerabilities

npx hook-cli checkForVulnerabilities --package-manager yarn

npx hook-cli checkForVulnerabilities --audit-level low

npx hook-cli checkForVulnerabilities --no-fail

npx hook-clicheckForVulnerabilities --prod

npx hook-cli checkForVulnerabilities -l high -m yarn -n -p

updateReminder

Prints a list of packages that have updates

Option	Description	Type	default
-m, --package-manager	The package manager you want to use. Keep in mind that both package managers report differently	yarn, npm	npm
-f, --fail	If true it will exit with a non zero in case of updates	boolean	false

Example usage

npx hook-cli updateReminder

npx hook-cli updateReminder - yarn

npx hook-cli updateReminder -f

npx hook-cli updateReminder - yarn -f

Useful

• Print help page for command

npx hook-cli [command] --help

• Test command during development (Exit codes get not correctly forwarded)

npm run hook-cli -- [command]

• Test command during development with correct exi code

npx ts-node src/index.ts [command]

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Luis Beu - [e-mail]