Skip to content

subk/vorpal-comment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vorpal-comment

Travis Codecov Commitizen friendly

Bash-like comment for Vorpal.js

Installation

$ npm i vorpal-comment

Usage

import Vorpal from 'vorpal';
import comment from 'vorpal-comment';

const vorpal = new Vorpal();

vorpal
  .use(comment)
  .delimiter('example>')
  .show();
example> # im a comment
example>

Options

const options = {
  command: '//',          // comments start with // instead of #
  alias: [ '--', '<<' ]   // define some aliases
}
vorpal.use(comment, options);

License

MIT