@nonamenpm/text-parser

#This is an utility for parsing text.

#Docs

#approx(token) Kinda working Autocorrects the input token with the tokens list

NOTE: This function is experimental and can cause some bugs

#listify(input, output) Takes a string input and converts it into an array.

First argument: input string

Second argument: output array

#stringify(input, output) Takes an array and comverts it into a string.

First argument: input array

Second argument: output string

#add(tokens, cb, description) Adds a token and a callback function, throws an error if there isn't a function.

First argument: the token

Second argument: callback function, now if you put an argument,

the parse() function will pass the tokens remaining.

Third argument: description for the token

To now add an argument, you need to put angle brackets in the first argument, and some text inside it so the users when they call the help function know what to pass in. NOTE: You have to put angle brackets AFTER the tokens, otherwise it will break.

#parse(input) Parses the input and executes the function if the token is present.
If it finds an unknown token it calls the error() function (see below).

First argument: the input, default is from argv

#error(cb) Error function called from parse()

First argument: callback function called on error,

the callback function must take 1 argument that the parse() function

will use to pass the unknown token

#help(cb) Function used by user to override the

default help function.

First argument: callback function

#getArgs(n) Get arguments from a specified array

First argument: how many arguments to return

Second argument: from what array to get the arguments, default is argv

NOTE: This function is now used internally by the library.

#ignore(n) Ignore errors thrown by parse().

First argument: how many errors to ignore.

Putting -1 will suppress all errors

#Changelog

• To now add an inline argument you have to put in the token angle brackets. See the example for more details.

#Examples

//import the library
const parse = require('@nonamenpm/text-parser')

//initialize a string
var test_string = 'foo bar 3'

parse.add('foo <text> <repeat>', 
  (element) => {
      //write the next argument in the parsing array
      for (var i = 0; i < parseInt(element[1]); i++) {
        console.log('This is an argument! ' + element[0])
      }
  },
  'Test command'
  
)

parse.parse(test_string)

In this case, the output will be:

This is an argument! bar This is an argument! bar This is an argument! bar