cli-argument-parser - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

package.json

		{
		"name": "cli-argument-parser",
		"version": "0.3.0",
		"version": "0.3.1",
		"description": "A package containing relevant CLI actions",
		@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

		@@ -32,3 +32,4 @@ <p align='center'><a href='https://github.com/danitseitlin/cli-argument-parser'><img src='.github/resources/logo.png' /></a></p>

		## :speak_no_evil: Easily configurate unique CLI's
		## :speak_no_evil: Configurate unique CLI's
		### Using a configuration file
		Create a file in the root of your project called `cli.config.json`
		@@ -44,2 +45,15 @@ and paste the following into it:
		The `separator` is a value which seperated between the argument name and argument value. `=` is the default one. (ex: `--arg=5`) <br>
		This gives you the abillity to configurate your cli arguments as you wish.
		This gives you the abillity to configurate your cli arguments as you wish. <br>

		### Using the CLI
		If additional files are a mess in your opinion, it is also possible to pass the CLI configuration via CLI arguments.
		`--cli-prefix` to configurate the CLI prefix, ie: `--cli-prefix=--`<br>
		`--cli-separator` to configurate the CLI separator, ie: `--cli-separator==`

		### Using the code
		Instead of using the existing `cliArguments`, you are able to also create a custom one, using the following code snippet:
		```
		import { filterArguments } from 'cli-argument-parser';
		const arguments = filterArguments('--', '=');
		```
		The `arguments` variable will hold a JS object with arguments (just like `cliArguments`) filtered by defined prefix and separator .

New alerts