A tool to document your package.json scripts

Related tags

Learning resource npm npm-package npm-scripts npmjs npx npm-cli
Overview

why

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

Usage

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:

npm install why --save-dev
You might also like...

This tool allows you to test your chains.json file to see if your chains are available, syncing, or in sync.

Chains Tester This tool allows you to test your chains.json file to see if your chains are available, syncing, or in sync. This is an open source tool

Nov 4, 2022

Json-parser - A parser for json-objects without dependencies

Json Parser This is a experimental tool that I create for educational purposes, it's based in the jq works With this tool you can parse json-like stri

Jan 3, 2022

Pretty-print-json - 🦋 Pretty-print JSON data into HTML to indent and colorize (written in TypeScript)

Pretty-print-json - 🦋 Pretty-print JSON data into HTML to indent and colorize (written in TypeScript)

pretty-print-json Pretty-print JSON data into HTML to indent and colorize (written in TypeScript) 1) Try It Out Interactive online tool to format JSON

Dec 30, 2022

JSON Struct is a vocabulary that allows you to annotate and validate JSON documents.

JSON-Struct JSON Struct is a vocabulary that allows you to annotate and validate JSON documents. Examples Basic This is a simple example of vocabulary

May 8, 2022

Prisma 2+ generator to emit a JSON file that can be run with json-server

Prisma 2+ generator to emit a JSON file that can be run with json-server

Prisma JSON Server Generator A Prisma generator that automates creating a JSON file that can be run as a server from your Prisma schema. Explore the o

Jan 7, 2023

✏️ A small jQuery extension to turn a static HTML table into an editable one. For quickly populating a small table with JSON data, letting the user modify it with validation, and then getting JSON data back out.

jquery-editable-table A small jQuery extension to turn an HTML table editable for fast data entry and validation Demo 👉 https://jsfiddle.net/torrobin

Jul 31, 2022

Add aliasing support to Vite from tsconfig.json or jsconfig.json files

Config to Alias Config to Alias adds aliasing support to Astro, JavaScript, TypeScript, and CSS files. Usage Install Config to Alias. npm install @ast

Mar 17, 2023

Find stale dependencies in the package.json file(s).

staledeps Find stale dependencies in the package.json file(s). Installation npm install -g staledeps Or simply using npx, the package runner bundled

Dec 15, 2022

A NodeJS Replit API package wrapped around GraphQL, returning JSON data for easy use.

repl-api.js A NodeJS Replit API package wrapped around GraphQL, returning JSON data for easy use. Contents: About Quickstart Pre-installation Installa

May 20, 2022
Comments
  • Add autocompletion

    Add autocompletion

    Would be nice to have autocompletion that will enable users to quickly find the desired script documentation.

    npx why s + TAB, should autocomplete to all s options (ex:npx why start)

    enhancement help wanted 
    opened by strdr4605 0
Releases(v0.6.2)

  • v0.6.2(Mar 29, 2022)

    What's Changed

    Other Changes

    • fix: use backticks for default description by @strdr4605 in https://github.com/strdr4605/why/pull/16

    Full Changelog: https://github.com/strdr4605/why/compare/v0.6.1...v0.6.2

    Source code(tar.gz)
    Source code(zip)

  • v0.6.1(Mar 26, 2022)

    What's Changed

    Other Changes

    • fix: remove preinstall script by @strdr4605 in https://github.com/strdr4605/why/pull/14

    Full Changelog: https://github.com/strdr4605/why/compare/v0.6.0...v0.6.1

    Source code(tar.gz)
    Source code(zip)

  • v0.6.0(Mar 26, 2022)

    What's Changed

    Exciting New Features 🎉

    • feat: notify devs about npx why by @strdr4605 in https://github.com/strdr4605/why/pull/13

    Full Changelog: https://github.com/strdr4605/why/compare/v0.5.1...v0.6.0

    Source code(tar.gz)
    Source code(zip)

  • v0.5.1(Mar 26, 2022)

    What's Changed

    Other Changes

    • Fix/undefined desc by @strdr4605 in https://github.com/strdr4605/why/pull/12

    Full Changelog: https://github.com/strdr4605/why/compare/v0.5.0...v0.5.1

    Source code(tar.gz)
    Source code(zip)

  • v0.5.0(Mar 25, 2022)

    What's Changed

    Exciting New Features 🎉

    • feat: add support from \n by @strdr4605 in https://github.com/strdr4605/why/pull/7
      • use \\n in package-why.json

    Other Changes

    • ci(github): add workflow for github release by @strdr4605 in https://github.com/strdr4605/why/pull/8

    Full Changelog: https://github.com/strdr4605/why/compare/v0.4.0...v0.5.0

    Source code(tar.gz)
    Source code(zip)

  • v0.4.0(Mar 23, 2022)

  • v0.3.0(Mar 23, 2022)

Owner
Dragoș Străinu
Building @cofeed-19, Front-end Engineer @planable, Hackathoner. Previously @amzn and @goparrot.
Dragoș Străinu
GitHub https://npm.im/why
Package fetcher is a bot messenger which gather npm packages by uploading either a json file (package.json) or a picture representing package.json. To continue...

package-fetcher Ce projet contient un boilerplate pour un bot messenger et l'executable Windows ngrok qui va permettre de créer un tunnel https pour c

AILI Fida Aliotti Christino 2 Mar 29, 2022
JSON Visio is data visualization tool for your json data which seamlessly illustrates your data on graphs without having to restructure anything, paste directly or import file.

JSON Visio is data visualization tool for your json data which seamlessly illustrates your data on graphs without having to restructure anything, paste directly or import file.

Aykut Saraç 20.6k Jan 4, 2023
JCS (JSON Canonicalization Scheme), JSON digests, and JSON Merkle hashes

JSON Hash This package contains the following JSON utilties for Deno: digest.ts provides cryptographic hash digests of JSON trees. It guarantee that d

Hong Minhee (洪 民憙) 13 Sep 2, 2022
Multi-platform node package bundle to a package.json.

dmpc Multi-platform node package bundle to a package.json. install ### npm mode npm i -g @kingsword/dmpc ### yarn mode yarn global add @kingsword/dmp

Kingsword 2 Oct 16, 2022
Random Fractals stash of Observable Data Tools 🛠️ and Notebooks 📚 in ES Modules .js, .nb.json, .ojs, .omd, .html and .qmd document formats for Data Previews

Random Fractals stash of Observable Data Tools ??️ and Notebooks ?? in ES Modules .js, .nb.json, .ojs, .omd, .html and .qmd document formats for Data Previews in a browser and in VSCode IDE with Observable JS extension, Quarto extension, and new Quarto publishing tools.

Taras Novak 14 Nov 25, 2022
A command-line tool to manage Deno scripts installed via deno install

??️ nublar nublar is a command-line tool to manage your scripts installed via deno install. ??️ Installation deno install --allow-read --allow-write -

Shun Ueda 16 Dec 26, 2022
Digispark Overmaster : free IDE TOOL allows to create and edit Digispark Scripts by the drag and drop technique,with cool GUI and easy to use it

Digispark_Overmaster Digispark Overmaster : free IDE TOOL allows to create and edit Digispark Scripts by the drag and drop technique,with cool GUI and

Yehia Elborma 5 Nov 14, 2022
Types generator will help user to create TS types from JSON. Just paste your single object JSON the Types generator will auto-generate the interfaces for you. You can give a name for the root object

Types generator Types generator is a utility tool that will help User to create TS Interfaces from JSON. All you have to do is paste your single objec

Vineeth.TR 16 Dec 6, 2022
Detect npm packages by author name in your package-lock.json or yarn.lock.

detect-package-by-author Detect npm packages by author name in your package-lock.json or yarn.lock. Install Install with npm: # Not Yet Publish # npm

azu 2 Jan 11, 2022
LazyLoad is a lightweight, flexible script that speeds up your website by deferring the loading of your below-the-fold images, backgrounds, videos, iframes and scripts to when they will enter the viewport. Written in plain "vanilla" JavaScript, it leverages IntersectionObserver, supports responsive images and enables native lazy loading.

LazyLoad is a lightweight (2.4 kB) and flexible script that speeds up your web application by deferring the loading of your below-the-fold images, vid

Andrea Verlicchi 7.1k Jan 2, 2023