azure-cli/lib/commands/help.js

Microsoft Azure Cross Platform Command Line tool

// 
// Copyright (c) Microsoft and contributors.  All rights reserved.
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//   http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// 
// See the License for the specific language governing permissions and
// limitations under the License.
// 

var util = require('util');

var utils = require('../util/utils');
var $ = utils.getLocaleString;

exports.init = function (cli) {
  var log = cli.output;

  cli.command('help [command]')
    .description($('Display help for a given command'))
    .execute(function (name) {
      if (!name) {
        if (log.format().json) {
          log.json(cli.helpJSON());
        } else {
          cli.parse(['', '', '-h']);
        }
      } else if (!cli.categories[name]) {
        throw new Error(util.format($('Unknown command name %s'), name));
      } else {
        var args = ['', ''].concat(cli.rawArgs.slice(4), ['-h']);

        var cat = cli.categories[name];
        if (cat.stub) {
          cat = cli.loadCategory(cli, name);
        }

        cat.parse(args);
      }
    });
};