mikaelbr / cli-usage Goto Github PK

Easily show the usage of your CLI tool from a Markdown string or file

JavaScript 100.00%

cli-usage's Introduction

cli-usage

Easily show the usage of your CLI tool from a Markdown string or file. You can just plug cli-usage in without thinking about paramters, or you can handle that your self using the .get API end-point.

Install

npm install cli-usage

Usage

Most basic usage, just plug in:

var usage = require('cli-usage');
usage();
//=> If help-flag is passed, print usage
//=> and exit with code 0.

This will listen for -h, -help or --help passed into your CLI and try to locate a usage.md file from the directory of the file. If help is passed and the usage.md file found, the usage will be printed and the application will exit with code 0.

You can also pass in a filename or a string.

var usage = require('cli-usage');
usage('./some/path/to/usage.md');

var usage = require('cli-usage');
usage('# Simple usage');

Get compiled usage

Instead of cli-usage doing all the work, you can also just retrieve the compiled usage text and handle it your self.

Example

var usage = require('cli-usage');

console.log(usage.get('# some custom markdown from string'));

console.log(usage.get('./usage.md'));

cli-usage's People

Contributors

Stargazers

Watchers

Forkers

turbo87 cpojer aaronabramov matildasmeds sectsect gfx apoco

cli-usage's Issues

Security vulnerability in dependent version of marked

There was a new security vulnerability found in marked, and a fix was put in version 0.6.2.

Could you please update to 0.6.2 and push a new release? Thanks!

marked-terminal version 3.2.0 is not yet posted to npm?

npm ERR! code ETARGET
npm ERR! notarget No matching version found for marked-terminal@^3.2.0
npm ERR! notarget In most cases you or one of your dependencies are requesting
npm ERR! notarget a package version that doesn't exist.
npm ERR! notarget
npm ERR! notarget It was specified as a dependency of 'cli-usage'
npm ERR! notarget

[email protected] throwing 'undefined is not a function'

Between marked 0.3.3 and 0.3.5, mversion -h started throwing an error:

$ mversion -h
/usr/local/lib/node_modules/mversion/node_modules/cli-usage/node_modules/marked/lib/marked.js:1226
    throw e;
          ^
TypeError: undefined is not a function
Please report this to https://github.com/chjj/marked.
    at InlineLexer.output (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/node_modules/marked/lib/marked.js:685:28)
    at Parser.tok (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/node_modules/marked/lib/marked.js:985:21)
    at Parser.parse (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/node_modules/marked/lib/marked.js:935:17)
    at Function.Parser.parse (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/node_modules/marked/lib/marked.js:922:17)
    at marked (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/node_modules/marked/lib/marked.js:1218:19)
    at fromFile (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/index.js:45:10)
    at get (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/index.js:30:12)
    at module.exports (/usr/local/lib/node_modules/mversion/node_modules/cli-usage/index.js:22:15)
    at Object.<anonymous> (/usr/local/lib/node_modules/mversion/bin/cli.js:9:1)
    at Module._compile (module.js:460:26)

Manually rolling back marked to 0.3.3 solves the problem. Sorry, I'm kind of lazy to dig any deeper =)

Installation of cli-usage failing on dependency marked-terminal

Error:

npm ERR! node v4.2.1
npm ERR! npm  v2.15.9
npm ERR! code ETARGET

npm ERR! notarget No compatible version found: marked-terminal@'>=1.6.2 <2.0.0'
npm ERR! notarget Valid install targets:
npm ERR! notarget ["0.1.0","1.0.0","1.1.0","1.1.1","1.1.2","1.1.3","1.2.0","1.3.0","1.4.0","1.5.0","1.6.0","1.6.1"]

Dependency update needed to fix vulnerability

Dependency of marked should be updated in package.json

old version listed is [email protected]

new version which fixes vulnerability is [email protected]

Update Dependency Package

Thanks for useful package.

I got the following warning on GitHub.

⚠️ We found potential security vulnerabilities in your dependencies.
Some of the dependencies defined in your package-lock.json have known security vulnerabilities and should be updated.

I think that it is necessary to update the "marked" package.

@via markedjs/marked#997

consider migrating from marked

it's no longer maintained. some options are:

not a big deal. only came here because i keep getting this message in my npm logs which i want to remove:

npm WARN prefer global [email protected] should be installed with -g