feat(init): Initial commit

Author: max

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [ "es2015" ]
+}

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+coverage
+dist
+*.log
+*.swp
+*~

.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: node_js
+cache:
+  directories:
+    - node_modules
+notifications:
+  email: false
+node_js:
+  - '5'
+before_install:
+  - npm i -g npm@^3.8.5
+before_script:
+  - npm prune
+script:
+  - npm run test:single
+  - npm run check-coverage
+  - npm run build
+after_success:
+  - npm run report-coverage
+  - npm run semantic-release
+branches:
+  only:
+    - master

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 subk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+vorpal-comment
+==============
+
+[![Travis](https://img.shields.io/travis/subk/vorpal-comment.svg)](https://travis-ci.org/subk/vorpal-comment)
+[![Codecov](https://img.shields.io/codecov/c/github/subk/vorpal-comment.svg?maxAge=2592000)](https://codecov.io/github/subk/vorpal-comment)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+Bash-like comments for [Vorpal.js](http://vorpal.js.org/)
+
+## Installation
+```bash
+$ npm i vorpal-comment
+```
+
+## Usage
+```javascript
+import Vorpal from 'vorpal';
+import comment from 'vorpal-comment';
+
+const vorpal = new Vorpal();
+
+vorpal
+  .use(comment)
+  .delimiter('example>')
+  .show();
+```
+```bash
+example> # im a comment
+example>
+```
+
+## Options
+```javascript
+const options = {
+  command: '//',          // comments start with // instead of #
+  alias: [ '--', '<<' ]   // define some aliases
+}
+vorpal.use(comment, options);
+```
+## License
+MIT

package.json

@@ -0,0 +1,56 @@
+{
+  "name": "vorpal-comment",
+  "description": "Bash-like comments for Vorpal.js",
+  "main": "./dist/comment.js",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "babel src -d dist",
+    "check-coverage": "istanbul check-coverage --statements 100 --functions 100 --lines 100",
+    "report-coverage": "cat ./coverage/lcov.info | codecov",
+    "test": "mocha -w --compilers js:babel-register test/test.js",
+    "test:single": "istanbul cover _mocha -- -R spec --report lcovonly --compilers js:babel-register test/test.js",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post",
+    "commit": "git-cz"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/subk/vorpal-comment.git"
+  },
+  "keywords": [
+    "vorpal",
+    "comment",
+    "bash"
+  ],
+  "author": "kbus",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/subk/vorpal-comment/issues"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "homepage": "https://github.com/subk/vorpal-comment#readme",
+  "devDependencies": {
+    "babel-cli": "^6.6.5",
+    "babel-preset-es2015": "^6.6.0",
+    "chai": "^3.5.0",
+    "codecov.io": "^0.1.6",
+    "commitizen": "^2.7.6",
+    "cz-conventional-changelog": "^1.1.5",
+    "istanbul": "^1.0.0-alpha.2",
+    "mocha": "^2.4.5",
+    "rimraf": "^2.5.2",
+    "semantic-release": "^4.3.5",
+    "test-console": "^1.0.0",
+    "vorpal": "^1.10.10"
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-conventional-changelog"
+    },
+    "ghooks": {
+      "pre-commit": "npm run test:single && npm run check-coverage"
+    }
+  }
+}

src/comment.js

@@ -0,0 +1,13 @@
+import Vorpal from 'vorpal';
+
+export default function (vorpal, options = { command: '#' }) {
+  const comment = vorpal.command(options.command, 'A comment line');
+  if (options.alias) {
+    comment.alias(options.alias);
+  }
+  comment
+    .hidden()
+    .action(function (args, callback) {
+      callback();
+    });
+}

test/test.js

@@ -0,0 +1,63 @@
+import { expect } from 'chai';
+import comment from '../src/comment';
+import Vorpal from 'vorpal';
+import { stdout } from 'test-console';
+
+describe('vorpal-comment', function() {
+
+  it('should be properly imported as a function', () => {
+    expect(comment).to.be.instanceof(Function);
+  });
+
+  it('should be imported by Vorpal', () => {
+    expect(() => {
+      new Vorpal().use(comment);
+      new Vorpal().use(comment, { command: '!' });
+      new Vorpal().use(comment, { alias: '//' });
+      new Vorpal().use(comment, { command: '!', alias: '//' });
+      new Vorpal().use(comment, { command: '!', alias: [ '//', '--', '<<' ] });
+    }).to.not.throw();
+  });
+
+  it('should allow comments starting with #', () => {
+    const output = stdout.inspectSync(() => {
+      const vorpal = new Vorpal();
+      vorpal.use(comment);
+      vorpal.exec('# a comment line');
+    });
+    // no output
+    expect(output).to.have.length(0);
+  });
+
+  it('should allow comments starting with ? instead of #', () => {
+    const output = stdout.inspectSync(() => {
+      const vorpal = new Vorpal();
+      vorpal.use(comment, { command: '?' });
+      vorpal.exec('? a comment line');
+    });
+    // no output
+    expect(output).to.have.length(0);
+  });
+
+  it('should allow comments starting with an alias of //', () => {
+    const output = stdout.inspectSync(() => {
+      const vorpal = new Vorpal();
+      vorpal.use(comment, { alias: '//' });
+      vorpal.exec('// a comment line');
+    });
+    // no output
+    expect(output).to.have.length(0);
+  });
+
+  it('should allow comments starting with aliases of // -- <<', () => {
+    const output = stdout.inspectSync(() => {
+      const vorpal = new Vorpal();
+      vorpal.use(comment, { alias: [ '//', '--', '<<' ] });
+      vorpal.exec('// a comment line');
+      vorpal.exec('-- a comment line');
+      vorpal.exec('<< a comment line');
+    });
+    // no output
+    expect(output).to.have.length(0);
+  });
+});