Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srph/npm-scripts-info
Display the description of your npm scripts
https://github.com/srph/npm-scripts-info
build-tool npm
Last synced: 3 days ago
JSON representation
Display the description of your npm scripts
- Host: GitHub
- URL: https://github.com/srph/npm-scripts-info
- Owner: srph
- Created: 2016-02-20T11:22:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-29T19:47:03.000Z (almost 2 years ago)
- Last Synced: 2024-12-13T01:11:53.991Z (10 days ago)
- Topics: build-tool, npm
- Language: JavaScript
- Homepage:
- Size: 158 KB
- Stars: 92
- Watchers: 3
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# npm-scripts-info [](https://www.npmjs.com/package/npm-scripts-info) [](https://travis-ci.org/srph/npm-scripts-info)
Display the description of your npm scripts.
## Installation
This module is installed via npm:
```sh
npm install npm-scripts-info --save
```
## Usage
### Using the `scripts-info` property
Add the descriptions (`scripts-info`) to your `package.json`. Afterwards, add `npm-scripts-info` to your scripts.
```json
{
"name": "my-project",
"scripts": {
"info": "npm-scripts-info"
},
"scripts-info": {
"info": "Displays information about the scripts.",
"watch:build": "Compiles the scripts and watches for changes.",
"start": "Kickstarts the application."
}
}
```
Finally, run `npm run info`.
### Usings scripts prefixed with `?`
For modules with dozens of scripts it might be a better option to store the descriptions near the commands. `npm-scripts-info` allows to store the scripts descriptions in the `scripts` property. In order to add a script description, just prefix its name with `?`.
```json
{
"name": "my-project",
"scripts": {
"?info": "Display information about the scripts.",
"info": "npm-scripts-info",
"?watch:build": "Watch codebase, trigger build when source code changes",
"watch:build": "webpack --watch",
"?start": "echo Kickstarts the application.",
"start": "node index"
}
}
```
Have you noticed the `echo` command in the `start` description? Hence the descriptions are inside the script property, they can be called using `npm run`. By adding the `echo` command to the description properties you can make valid scripts from them. Therefore, running `npm run ?start` will print the description of the `start` script. And the great thing is, `npm-scripts-info` is smart enough to fetch the description from the `echo` command!
**NOTE:** The prefixed commands will be looked up for descriptions only if the `package.json` doesn't have a `scripts-info` property.
## Custom Reporters
You can customize the output by specifying a reporter.
```bash
npm-scripts-info -r=my-reporter
```
You can check the [default reporter](lib/reporter.js) to get the gist of how it works. It's very simple.
**Note**: If you're publishing your own reporter, please prefix it with `npm-scripts-info` (e.g., `npm-scripts-info-my-reporter`) for searchability.
## Using the JavaScript API
You can fetch the scripts descriptions from a `package.json` in JavaScript.
```js
'use strict';
var getScriptsInfo = require('npm-scripts-info');
var readPkgUp = require('read-pkg-up');
readPkgUp()
.then(function(result) {
var scriptsInfo = getScriptsInfo(result.pkg);
console.log(scriptsInfo);
//> { md: 'Update the markdown files',
// info: 'Display information about the scripts',
// test: 'Run the tests' }
});
```
## Default Descriptions
Some of the npm scripts are standardized. `npm-scripts-info` provides default descriptions for them, if no custom description specified in `scripts-info`.
- **info** - Display information about the scripts
- **start** - Kickstart the application
- **test** - Run the tests
- **build** - Build the package
- **watch** - Watch codebase, trigger build when source code changes
- **cover** - Execute test coverage
## Preview
## License
ISC © [Kier Borromeo](http://srph.github.io)
## Dependencies [](https://david-dm.org/srph/npm-scripts-info/master)
- [chalk](https://github.com/chalk/chalk): Terminal string styling done right. Much color.
- [meow](https://github.com/sindresorhus/meow): CLI app helper
- [unquote](https://github.com/lakenen/node-unquote): Remove wrapping quotes from a string.
## Dev Dependencies [](https://david-dm.org/srph/npm-scripts-info/master#info=devDependencies)
- [chai](https://github.com/chaijs/chai): BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
- [mocha](https://github.com/mochajs/mocha): simple, flexible, fun test framework
- [mock-fs](https://github.com/tschaub/mock-fs): A configurable mock file system. You know, for testing.
- [mos](https://github.com/zkochan/mos): A pluggable module that injects content into your markdown files via hidden JavaScript snippets
- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up): Read the closest package.json file
- [rewire](https://github.com/jhnns/rewire): Easy dependency injection for node.js unit testing
- [sinon](https://github.com/cjohansen/Sinon.JS): JavaScript test spies, stubs and mocks.