@typicalninja21/cmd-parser

Made for message command system in discord bots (Does not validate input, just parse the string and return a object with the parsed info)

Install

npm i @typicalninja21/cmd-parser

Usage

const parse = require('@typicalninja21/cmd-parser').parse;

// get this somehow, from discord bot message event etc...
const commandString = `!commands add -type string -name testCommand`

// first argument is the prefix, second is the command string you got
console.log(parse(commandString, {
  prefix: '!',
  // optionsOperator: '-' (optional, default to "-")
}))

OutPut

This is the result of the above parsed command string, subCommand might be null if no subCommand was found

this returns a Args class, [you can refer its functions below]

{
  command: 'commands',
  args: Args {
    rawArgs: [ [Object], [Object] ],
    _map: Map(2) { 'type' => 'string ', 'name' => 'testCommand' }
  },
  subCommand: 'add'
}

Default values

{
  command: string,
  args: Args {values here}
  subCommand: string
}

Args class

Args.get(argName: String, ErrorIfNotFound: Boolean): String

Gets a arg from the internal map

Example

 const commandString = `!eval -code \`\`\`some kind of code here\`\`\` -some "other option"`;
   const { args } = parse(commandString, { prefix: '!' });
   console.log(args.get('code'))

find(func: (val: string, key: string) => boolean, thisArg: any): { arg: string, value: string } | undefined

similar to get, but instead of searching with arg name Searches for a single item where the given function returns a truthy value

Example

const commandString = `!eval -code \`\`\`some kind of code here\`\`\` -some "other option"`;
const { args } = parse(commandString, { prefix: '!' });

console.log(args.find((arg, argName) => argName === 'some' && arg.includes('option')))

Args.has(argName: String, valueNeeded: Boolean): Boolean

returns a boolean indicating if the given argument exists

Example

 const commandString = `!eval -code \`\`\`some kind of code here\`\`\` -some "other option"`;
 const { args } = parse(commandString, { prefix: '!' });
 console.log(args.has('code'))

Args.parseAllKeys(func: (argument: string, value: string) => string): Args

Runs given function on each argument and returns a new Args object with the results, useful for escaping values in all args

Example

   const commandString = `!eval -code \`\`\`some kind of code here\`\`\` -some "other option"`;
   const { args } = parse(commandString, { prefix: '!' });
   
   console.log(args.parseAllKeys((k, s) => s.replace(/\`/g, '').replace(/"/g, ' ')))

Args.every(func: (arg: string, value: string) => boolean, thisArg?: any): boolean

Runs the given function on all the values of args and checks if at least one returns false

Example

  const commandString = `!help -page 2 -result 10`;
    const { args } = parse(commandString, { prefix: '!' });
    // checks if every val is a number
    console.log(args.every((val) => !isNaN(val)))

Tests

Tests are available here, (they can be also used as examples)

run npm run test to run the tests (requires mocha)

License

This repository and the code inside it is licensed under the MIT License. Read LICENSE for more information.