shx/lib/help.js

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _shelljs = require('shelljs');

var _shelljs2 = _interopRequireDefault(_shelljs);

var _config = require('./config');

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

exports.default = function () {
  var commandList = Object.keys(_shelljs2.default).filter(function (cmd) {
    return typeof _shelljs2.default[cmd] === 'function' && _config.CMD_BLACKLIST.indexOf(cmd) === -1;
  });

  return '\nshx: A wrapper for shelljs UNIX commands.\n\nUsage: shx <command> [options]\n\nExample:\n\n    $ shx ls .\n    foo.txt\n    bar.txt\n    baz.js\n    $ shx rm -rf *.txt\n    $ shx ls .\n    baz.js\n\nCommands:\n\n' + commandList.map(function (cmd) {
    return '    - ' + cmd;
  }).join('\n') + '\n';
};