Package Exports

cli-argument-helper
cli-argument-helper/boolean/getBoolean
cli-argument-helper/boolean/getBoolean.js
cli-argument-helper/index.js
cli-argument-helper/number
cli-argument-helper/number/index.js
cli-argument-helper/string
cli-argument-helper/string/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cli-argument-helper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cli-argument-helper

Functions to help you deal with parameters in your command-line application.

Installation

npm i cli-argument-helper

Usage

import getArgumentAssignment from "cli-argument-helper/getArgumentAssignment";
import { getString } from "cli-argument-helper/string";
import {
  getInteger,
  getHexadecimal,
  getOctal,
  getBinary,
  getFloat,
  getBigInt,
} from "cli-argument-helper/number";
import getBoolean from "cli-argument-helper/boolean/getBoolean";

const args = [
  "--a",
  "1",
  "--b",
  "2",
  "--user-id",
  "3",
  "--c",
  "X",
  "--d=0xFF",
  "--e=0o77",
  "--f=0b101",
  "--g=3.14",
  "--h=0x1FFFFFFFFFFFFF",
  "--i=false",
  "--j=true",
  "--k=0",
  "--l=1",
  "--m=y",
  "--n=n",
  "--o=yes",
  "--p=no",
];

// Get integer
expect(getArgumentAssignment(args, "--user-id", getInteger)).to.be.equal(3);
expect(getArgumentAssignment(args, "--b", getInteger)).to.be.equal(2);
expect(getArgumentAssignment(args, "--a", getInteger)).to.be.equal(1);

// Get plain-text string
expect(getArgumentAssignment(args, "--c", getString)).to.be.equal("X");

// Get hexadecimal number
expect(getArgumentAssignment(args, "--d", getHexadecimal)).to.be.equal(0xff);

// Get octal number
expect(getArgumentAssignment(args, "--e", getOctal)).to.be.equal(0o77);

// Get binary number
expect(getArgumentAssignment(args, "--f", getBinary)).to.be.equal(0b101);

// Get float number
expect(getArgumentAssignment(args, "--g", getFloat)).to.be.equal(3.14);

// Get big integer
expect(getArgumentAssignment(args, "--h", getBigInt)).to.be.equal(
  0x1fffffffffffffn,
);

// Get boolean
expect(getArgumentAssignment(args, "--i", getBoolean)).to.be.equal(false);
expect(getArgumentAssignment(args, "--j", getBoolean)).to.be.equal(true);
expect(getArgumentAssignment(args, "--k", getBoolean)).to.be.equal(false);
expect(getArgumentAssignment(args, "--l", getBoolean)).to.be.equal(true);
expect(getArgumentAssignment(args, "--m", getBoolean)).to.be.equal(true);
expect(getArgumentAssignment(args, "--n", getBoolean)).to.be.equal(false);
expect(getArgumentAssignment(args, "--o", getBoolean)).to.be.equal(true);
expect(getArgumentAssignment(args, "--p", getBoolean)).to.be.equal(false);

assert.strict.deepEqual(args, []);