Package Exports

vorpal-comment

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vorpal-comment) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vorpal-comment

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