{"id":15007633,"url":"https://github.com/planable/why","last_synced_at":"2025-10-30T11:31:50.934Z","repository":{"id":40264299,"uuid":"472698460","full_name":"Planable/why","owner":"Planable","description":"A tool to document your package.json scripts","archived":false,"fork":false,"pushed_at":"2022-05-17T12:11:46.000Z","size":275,"stargazers_count":28,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-08T06:34:26.338Z","etag":null,"topics":["npm","npm-cli","npm-package","npm-scripts","npmjs","npx"],"latest_commit_sha":null,"homepage":"https://npm.im/why","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Planable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-22T09:36:48.000Z","updated_at":"2024-08-07T00:47:54.000Z","dependencies_parsed_at":"2022-07-22T08:22:18.135Z","dependency_job_id":null,"html_url":"https://github.com/Planable/why","commit_stats":null,"previous_names":["strdr4605/why","strdr4605/why-run"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planable%2Fwhy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planable%2Fwhy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planable%2Fwhy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planable%2Fwhy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Planable","download_url":"https://codeload.github.com/Planable/why/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238960585,"owners_count":19559303,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["npm","npm-cli","npm-package","npm-scripts","npmjs","npx"],"created_at":"2024-09-24T19:12:49.468Z","updated_at":"2025-10-30T11:31:45.437Z","avatar_url":"https://github.com/Planable.png","language":"JavaScript","readme":"# why\n\n![version](https://badgen.net/npm/v/why)\n![npm downloads](https://badgen.net/npm/dm/why)\n![dependents](https://badgen.net/npm/dependents/why)\n![publish](https://badgen.net/packagephobia/publish/why)\n[![Hits-of-Code](https://hitsofcode.com/github/strdr4605/why?branch=master)](https://hitsofcode.com/github/strdr4605/why/view?branch=master)\n\nA tool to document your package.json scripts\n\n## Why why?\n\nAs your project grows you add more scripts to package.json.  \nWhen 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.  \nThere is no good solution to comment npm scripts from your package.json.  \nThis is why `npx why` exists!\n\n## Demo\n\n![npx why demo](https://raw.githubusercontent.com/strdr4605/why/master/support/assets/demo.gif)\n\n## Usage\n\n```bash\nnpx why --init # will create a package-why.json file where you can write docs for your scripts\nnpx why test # will display docs for 'npm run test' command\n```\n\nFor better experience install the package as devDependencies:\n\n```bash\nnpm install why --save-dev\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplanable%2Fwhy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplanable%2Fwhy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplanable%2Fwhy/lists"}