https://github.com/planable/why

A tool to document your package.json scripts
https://github.com/planable/why

npm npm-cli npm-package npm-scripts npmjs npx

Last synced: 25 days ago
JSON representation

A tool to document your package.json scripts

• Host: GitHub
• URL: https://github.com/planable/why
• Owner: Planable
• License: mit
• Created: 2022-03-22T09:36:48.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-05-17T12:11:46.000Z (over 2 years ago)
• Last Synced: 2024-10-12T08:03:47.052Z (25 days ago)
• Topics: npm, npm-cli, npm-package, npm-scripts, npmjs, npx
• Language: JavaScript
• Homepage: https://npm.im/why
• Size: 269 KB
• Stars: 28
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# why

![version](https://badgen.net/npm/v/why)

![npm downloads](https://badgen.net/npm/dm/why)

![dependents](https://badgen.net/npm/dependents/why)

![publish](https://badgen.net/packagephobia/publish/why)

[![Hits-of-Code](https://hitsofcode.com/github/strdr4605/why?branch=master)](https://hitsofcode.com/github/strdr4605/why/view?branch=master)

A tool to document your package.json scripts

## Why why?

As your project grows you add more scripts to package.json.  

When a new member joins the project (or maybe you come back after a break) it's hard to understand from the script itself, what it is doing and **why** it was created.  

There is no good solution to comment npm scripts from your package.json.  

This is why `npx why` exists!

## Demo

![npx why demo](https://raw.githubusercontent.com/strdr4605/why/master/support/assets/demo.gif)

## Usage

```bash

npx why --init # will create a package-why.json file where you can write docs for your scripts

npx why test # will display docs for 'npm run test' command

```

For better experience install the package as devDependencies:

```bash

npm install why --save-dev

```