Skip to content

dworthen/argville

Repository files navigation

TypeScript NPM Build Status Test Coverage

Argville

Another CLI arg parser.

// index.js
const { parseAndValidate } = require('argville')

const flags = {
  pm: {
    type: 'string',
    required: true,
    map: (arg) => {
      return (arg as string).toLowerCase()
    },
  },

  name: {
    type: 'string',
    default: 'John',
    expected: /^John$/
  },

  age: {
    type: 'number',
    alias: 'a',
    validator: (age) => {
      if(age < 0) {
        return [false, "Error. Age must be > 0"]
      } else {
        return [true]
      }
    }
  },

  toppings: {
    type: 'string',
    alias: 't',
    multiple: true,
    expected: ["sprinkles", "candy"]
  },

  repeat: {
    alias: 'r',
    count: true,
  },

  verbose: {
    type: 'boolean',
    default: false,
  },
}

const args = parseAndValidate({ flags }, process.argv.slice(2))
node index.js cmd --pm PNPM -a 100 -t sprinkles candy -rrr --verbose
# args:
# {
#   _: ['cmd'],
#   pm: 'pnpm',
#   age: 100,
#   toppings: ['sprinkles', 'candy'],
#   repeat: 3,
#   verbose: true,
#   name: 'John',
# }

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published