mccormicka / string-argv Goto Github PK

License: MIT License

JavaScript 76.35% TypeScript 23.65%

string-argv's Introduction

What is it?

string-argv parses a string into an argument array to mimic process.argv. This is useful when testing Command Line Utilities that you want to pass arguments to and is the opposite of what the other argv utilities do.

Installation

npm install string-argv --save

Usage

// Typescript
import stringArgv from 'string-argv';

const args = stringArgv(
  '-testing test -valid=true --quotes "test quotes" "nested \'quotes\'" --key="some value" --title="Peter\'s Friends"',
  'node',
  'testing.js'
);

console.log(args);

// Javascript
var { parseArgsStringToArgv } = require('string-argv');

var args = parseArgsStringToArgv(
    '-testing test -valid=true --quotes "test quotes" "nested \'quotes\'" --key="some value" --title="Peter\'s Friends"',
    'node',
    'testing.js'
);

console.log(args);
/** output
[ 'node',
  'testing.js',
  '-testing',
  'test',
  '-valid=true',
  '--quotes',
  'test quotes',
  'nested \'quotes\'',
  '--key="some value"',
  '--title="Peter\'s Friends"' ]
  **/

params

required: arguments String: arguments that you would normally pass to the command line.

optional: environment String: Adds to the environment position in the argv array. If ommitted then there is no need to call argv.split(2) to remove the environment/file values. However if your cli.parse method expects a valid argv value then you should include this value.

optional: file String: file that called the arguments. If omitted then there is no need to call argv.split(2) to remove the environment/file values. However if your cli.parse method expects a valid argv value then you should include this value.

string-argv's People

Contributors

Stargazers

Watchers

Forkers

gliviu abrkn cellule rafase282 jamesmessinger styfle chadulous vikiboss robbieinoz

string-argv's Issues

Setup Continous Integration

I want to setup CI to see tests results on Pull Request and on the master branch.
I have the necessary setup on https://dev.azure.com/cellule/String-Argv but I can't hook it up on this github repo.
@mccormicka if you're still around, is it possible to give me more permissions on this repo ?

separates unquoted tail of argument starting with quotes

require('string-argv').default('"a"b') gives ['a', 'b']. It should be ['ab'].

require('string-argv').default('-"a"b') gives ['-"a"b'] as expected per #20.

Doesn't support empty quotes

An empty pair of quotes (e.g. "") should pass an empty string argument. But string-argv currently passes the actual quote characters instead.

STEPS TO REPRODUCE

$ node
> var stringArgv = require('string-argv');
undefined
> stringArgv('git commit --message ""')

EXPECTED RESULTS

[ 'git', 'commit', '--message', '' ]        // <--- Last arg is an empty string

ACTUAL RESULTS

[ 'git', 'commit', '--message', '""' ]      // <--- Last arg is two quotes

Missing license declaration

It seems like this library misses a license declaration?

v2.0.0 published a git repo

The last version published to npm included the git repo. This causes conflicts w/ npm when removing.

Feature request: support #-style comments

Samples:

"hello # world" => ["hello"]

"hello \n # multiline \n world" => ["hello" , "world"]

WDYT?

doesn't strip word-internal quotes

require('string-argv').default('a" b"') gives ['a" b"']. It should be ['a b'].

Nested quotes with no spaces not handled

Hi, congrats on the lib! It is a dependency for the exits bin, and I've found this to be an issue on string-argv@0.1.2:

const toArgv = require('string-argv');
console.log(toArgv('jake run:silent["echo 1"]'));

Expect: [ 'jake', 'run:silent["echo 1"]' ]
Get: [ 'jake', 'run:silent["echo 1"', ']' ]

Escaped space not handled

STEPS TO REPRODUCE

$ node
> var stringArgv = require('string-argv');
undefined
> stringArgv('one\ one two')

EXPECTED RESULTS

[ 'one one', 'two' ]

ACTUAL RESULTS

[ 'one', 'one', 'two' ]

Doesn't correctly handle nested quotes

test.js

let parseArgv = require('string-argv').parseArgsStringToArgv;
let string = `--title "Peter's Friends" --name 'Phil "The Power" Taylor'`;

console.log(parseArgv(string));

expect

[ "--title", "Peter's Friends", "--name", 'Phil "The Power" Taylor' ]

get

[ "--title", "Peter", "s", "Friends", " --name ", "Phil", "The Power", "Taylor" ]

Missing license file

Hello, is is possible to incorporate the LICENSE file inside the repository and the npm package. Now it's missing. It's implied by MIT license that if licensed under the MIT the source code must be accompanied by full license text. If the license file is not in the npm package or the repo a lot of people cannot use it.

Thank you

Supports for shell script string?

$ node
> var stringArgv = require('string-argv');
undefined
> stringArgv('eslint `git ls-files`')
[ 'eslint', '`cat', 'a`' ]
> stringArgv('eslint $(git ls-files)')
[ 'eslint', '$(cat', 'a)' ]