CLI Suggestion

It's just a simple module to return a command suggestion based on a try.

Installation

Add to your project:

npm install cli-suggestion --save

Starting

Require and start with options:

var cliSuggestion = require('cli-suggestion');

...

var doSuggestion = cliSuggestion({
    command: 'cmd',
    file: 'suggestions.json',
    text: 'Did you want to say that?'
});

doSuggestion('version');
// Did you want to say that?
//    cmd --version

Then you can receive suggestions passing a string as the attempt:

var return = doSuggestion('test'); // Just the string, do not pass your app/command.

Options

command | default: a empty string

String | Your command. To be added before suggestion:

Did you want to say that?
  command suggestion

file | default: suggestions.json

String | The suggestions JSON file.

If it's invalid we will consider no suggestions.

text | default: Did you want to say that?

String | A humman readable text before suggestion.

Just like GIT.

Suggestion File

It's a JSON file with a array of suggestions.

Each suggestion should have command (string) and errors (array of strings) properties.

[
  {
    "command": "--test",
    "errors": ["test", "t"]
  },
  {
    "command": "--version",
    "errors": ["version", "v"]
  },
]

Examples

You can use 'chalk' to improve your logs.

var cliSuggestion = require('cli-suggestion');
var chalk = require('chalk');

var suggestion = cliSuggestion({ command: 'cmd' });

console.log(chalk.white(suggestion(suggestion)));
// Did you want to say that?
//      cmd example

Our purpose is to create suggestions to a cli tool, but you can use for anything:

var cliSuggestion = require('cli-suggestion');

var suggestion = cliSuggestion({ command: '', text: '' });

var suggestionToUseInYourCode = suggestion(suggestion).trim();
// Will return just the suggestion (no text, no command and trimmed)

License

MIT

Developers

Mário Valney