# package-scripts-help

> generate help menus for your custom package.json scripts

Latest version **0.0.6** (published 2022-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install package-scripts-help
pnpm add package-scripts-help
yarn add package-scripts-help
bun add package-scripts-help
```

Provides the command `package-scripts-help`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2022-03-10 |
| First published | 2022-03-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 10.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andrew Pynch |
| Maintainers | andrew-pynch |

## Links

- npm: https://www.npmjs.com/package/package-scripts-help
- Repository: https://github.com/andrew-pynch/option-help
- Homepage: https://github.com/andrew-pynch/option-help#readme
- Issues: https://github.com/andrew-pynch/option-help/issues
- npm.io page: https://npm.io/package/package-scripts-help

## Dependencies (10)

- [f](https://npm.io/package/f.md) ^1.4.0
- [jest](https://npm.io/package/jest.md) ^27.5.1
- [chalk](https://npm.io/package/chalk.md) ^5.0.1
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [ts-node](https://npm.io/package/ts-node.md) ^10.7.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.0
- [typescript](https://npm.io/package/typescript.md) ^4.6.2
- [nanospinner](https://npm.io/package/nanospinner.md) ^1.0.0
- [chalk-animation](https://npm.io/package/chalk-animation.md) ^1.6.0
- [gradient-string](https://npm.io/package/gradient-string.md) ^2.0.0

## Recent versions

- 0.0.6 (latest) — 2022-03-10
- 0.0.3 — 2022-03-09
- 0.0.2 — 2022-03-09
- 0.0.1 — 2022-03-09

## README

# package-scripts-help

[![npm version](https://badge.fury.io/js/package-scripts-help.svg)](https://badge.fury.io/js/package-scripts-help)
[![Publish](https://github.com/Andrew-Pynch/option-help/actions/workflows/publish.yml/badge.svg)](https://github.com/Andrew-Pynch/option-help/actions/workflows/publish.yml)

## The problem

Some of the scripts in my package.json files in various projects were growing complex, and large.

## The solution

Created this package to

1. Generate a help.json file from the contents of the scripts of a package.json file.
2. Generate cli help options from the help.json file.

# How to use

Visual Mode

```bash
cd /path/to/package.json
npx package-scripts-help@latest
# use your arrow keys and press enter to select the option you want
```

With Command Line Args

```bash
cd /path/to/package.json
npx package-scripts-help@latest --{flag}
```

## Valid Command Line Flags

Generate help file from package.json scripts.

```bash
--ghf
-ghf
--generate-help-file
-generate-help-file
```

Display help options from help.json file.

```bash
--dho
-dho
--display-help-options
-display-help-options
```

Display help options for this tool.

```bash
--h
-h
--help
-help
```

---
_Source: https://npm.io/package/package-scripts-help · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._