https://github.com/victorqueiroz/cli-argument-helper

Functions to help you deal with parameters in your command-line application.
https://github.com/victorqueiroz/cli-argument-helper

argument-parser argument-parsing command-line command-line-tool typescript

Last synced: 17 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/victorqueiroz/cli-argument-helper
• Owner: VictorQueiroz
• Created: 2023-05-06T16:41:18.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-06T05:22:14.000Z (3 months ago)
• Last Synced: 2024-12-15T07:28:22.052Z (19 days ago)
• Topics: argument-parser, argument-parsing, command-line, command-line-tool, typescript
• Language: TypeScript
• Homepage: https://victorqueiroz.github.io/cli-argument-helper/
• Size: 502 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cli-argument-helper

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

## Installation

```bash

npm i cli-argument-helper

```

## Usage

```ts

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, []);

```