@linterhub/usage-parser

Simple parser for usage page in CLI

Table of Contents

• Background
• Install
• Usage
• Contribute
• License

Background

There are a lot of CLI with different usage doc, distributed in different ways. This repository contains a proposal to unified format for arguments of various CLI. Under the hood, the main idea is pretty similar to docopt approach.

More details in doс or at the catalog page

Install

npm install @linterhub/usage-parser

GitHub

All releases and the source code are available for download at GitHub Releases.

Usage

Parse help doc and output result to console:

JavaScript

const usageParser = require('@linterhub/usage-parser');

const usage = new UsageParser('Help doc from CLI');
console.log(usage.parse());

import UsageParser from '@linterhub/usage-parser';

const usage = new UsageParser('Help doc from CLI');
console.log(usage.parse());

CLI

Usage: bin [options] <binary>

Parse help page specifying binary as argument or content as option

Options:
  -V, --version      output the version number
  -d, --docs <docs>  The help page content (pass without <binary> argument)
  -f, --file <file>  Path to a file with CLI docs
  -h, --help         output usage information

Examples:
  $ usage-parser mocha   // Parser runs help command for `mocha` and parse output
  $ usage-parser eslint  // Parser runs help command for `eslint` and parse output
  $ usage-parser --file "usage-file.txt"
  $ usage-parser --docs "usage text"

Contribute

You may contribute in several ways like requesting new features, adding tests, fixing bugs, improving documentation or examples. Please check our contributing guidelines.

License

MIT