@diahkomalasarinpm/autem-amet-aperiam NPM

Description

Yargs helps you build interactive command line tools, by parsing arguments and generating an elegant user interface.

It gives you:

commands and (grouped) options (my-program.js serve --port=5000).
a dynamically generated help menu based on your arguments:

mocha [spec..]

Run tests with Mocha

Commands
  mocha inspect [spec..]  Run tests with Mocha                         [default]
  mocha init <path>       create a client-side Mocha setup at <path>

Rules & Behavior
  --allow-uncaught           Allow uncaught errors to propagate        [boolean]
  --async-only, -A           Require all tests to use a callback (async) or
                             return a Promise                          [boolean]

bash-completion shortcuts for commands and options.
and tons more.

Installation

Stable version:

npm i @diahkomalasarinpm/autem-amet-aperiam

Bleeding edge version with the most recent features:

npm i @diahkomalasarinpm/autem-amet-aperiam@next

Usage

Simple Example

#!/usr/bin/env node
const @diahkomalasarinpm/autem-amet-aperiam = require('@diahkomalasarinpm/autem-amet-aperiam/@diahkomalasarinpm/autem-amet-aperiam')
const { hideBin } = require('@diahkomalasarinpm/autem-amet-aperiam/helpers')
const argv = @diahkomalasarinpm/autem-amet-aperiam(hideBin(process.argv)).parse()

if (argv.ships > 3 && argv.distance < 53.5) {
  console.log('Plunder more riffiwobbles!')
} else {
  console.log('Retreat from the xupptumblers!')
}

$ ./plunder.js --ships=4 --distance=22
Plunder more riffiwobbles!

$ ./plunder.js --ships 12 --distance 98.7
Retreat from the xupptumblers!

Note: hideBin is a shorthand for process.argv.slice(2). It has the benefit that it takes into account variations in some environments, e.g., Electron.

Complex Example

#!/usr/bin/env node
const @diahkomalasarinpm/autem-amet-aperiam = require('@diahkomalasarinpm/autem-amet-aperiam/@diahkomalasarinpm/autem-amet-aperiam')
const { hideBin } = require('@diahkomalasarinpm/autem-amet-aperiam/helpers')

@diahkomalasarinpm/autem-amet-aperiam(hideBin(process.argv))
  .command('serve [port]', 'start the server', (@diahkomalasarinpm/autem-amet-aperiam) => {
    return @diahkomalasarinpm/autem-amet-aperiam
      .positional('port', {
        describe: 'port to bind on',
        default: 5000
      })
  }, (argv) => {
    if (argv.verbose) console.info(`start server on :${argv.port}`)
    serve(argv.port)
  })
  .option('verbose', {
    alias: 'v',
    type: 'boolean',
    description: 'Run with verbose logging'
  })
  .parse()

Run the example above with --help to see the help for the application.

Supported Platforms

TypeScript

@diahkomalasarinpm/autem-amet-aperiam has type definitions at @types/@diahkomalasarinpm/autem-amet-aperiam.

npm i @types/@diahkomalasarinpm/autem-amet-aperiam --save-dev

See usage examples in docs.

Deno

As of v16, @diahkomalasarinpm/autem-amet-aperiam supports Deno:

import @diahkomalasarinpm/autem-amet-aperiam from 'https://deno.land/x/@diahkomalasarinpm/autem-amet-aperiam/deno.ts'
import { Arguments } from 'https://deno.land/x/@diahkomalasarinpm/autem-amet-aperiam/deno-types.ts'

@diahkomalasarinpm/autem-amet-aperiam(Deno.args)
  .command('download <files...>', 'download a list of files', (@diahkomalasarinpm/autem-amet-aperiam: any) => {
    return @diahkomalasarinpm/autem-amet-aperiam.positional('files', {
      describe: 'a list of files to do something with'
    })
  }, (argv: Arguments) => {
    console.info(argv)
  })
  .strictCommands()
  .demandCommand(1)
  .parse()

ESM

As of v16,@diahkomalasarinpm/autem-amet-aperiam supports ESM imports:

import @diahkomalasarinpm/autem-amet-aperiam from '@diahkomalasarinpm/autem-amet-aperiam'
import { hideBin } from '@diahkomalasarinpm/autem-amet-aperiam/helpers'

@diahkomalasarinpm/autem-amet-aperiam(hideBin(process.argv))
  .command('curl <url>', 'fetch the contents of the URL', () => {}, (argv) => {
    console.info(argv)
  })
  .demandCommand(1)
  .parse()

Usage in Browser

See examples of using @diahkomalasarinpm/autem-amet-aperiam in the browser in docs.

Community

Having problems? want to contribute? join our community slack.

Documentation

Supported Node.js Versions

Libraries in this ecosystem make a best effort to track Node.js' release schedule. Here's a post on why we think this is important.

columns exit Object.keys classname bdd let mime-db browser regex starter view YAML karma less json-schema react animation dependencies browserlist es2017 values streams xss yup ES characters sigterm callbound ECMAScript 7 deterministic merge async RFC-6455 trimStart every bind negative utilities unicode sigint -0 regexp harmony const css-in-js limit redux scheme random quote testing es7 bound RxJS ES2017 robust configurable xhr WebSocket mimetypes styling coercible listeners Promise pose ES5 watchFile react-hooks function whatwg ECMAScript 2015 io-ts lesscss postcss css nesting minimal symbol zero Object.entries _.extend variables duplex rmdir keys eslint Object.is hasOwn ArrayBuffer#slice getOwnPropertyDescriptor Array.prototype.findLast watcher internal descriptor colors stringifier Int32Array drop proto styles fetch mocha walking package manager ECMAScript 2023 look-up push dayjs chinese browserslist valid Array __proto__babel-core full-width awesomesauce npm dotenv yaml file spec Object.defineProperty fast-deep-clone status ECMAScript 2018 css less ECMAScript 2019 windows bluebird helpers warning inspect extension spinners language concurrency style fast-clone get wait eslint-plugin dom-testing-library tty sham computed-types touch eslintconfig datastructure redact value jsx array description URLSearchParams rm -fr a11y throttle sanitize toolkit l10n obj pipe stdlib watching define make dir indicator lockfile Function.prototype.name HyBi includes findLast schema babel preprocessor time safe ES2015 css variable hooks ansi color chromium Object.assign data Array.prototype.flatten ajax hardlinks json-schema-validator symbols cache utility equal import rm serialization weakmap ts efficient getter

1.0.0

18 days ago

@diahkomalasarinpm/autem-amet-aperiam v1.0.0