aws-cdk/lib/commands/docs.js

AWS CDK Toolkit CLI, the command line tool for CDK apps

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.aliases = exports.describe = exports.command = void 0;
exports.docs = docs;
const chalk_1 = __importDefault(require("chalk"));
const tools_1 = require("../private/tools");
exports.command = 'docs';
exports.describe = 'Opens the reference documentation in a browser';
exports.aliases = ['doc'];
async function docs(options) {
    const ioHelper = options.ioHelper;
    const url = 'https://docs.aws.amazon.com/cdk/api/v2/';
    await ioHelper.defaults.info(chalk_1.default.green(url));
    // The browser command is the user's own `--browser` option (with %u replaced
    // by the constant docs URL) and may rely on shell features, so it runs
    // through the shell verbatim.
    const browserCommand = (options.browser).replace(/%u/g, url);
    await ioHelper.defaults.debug(`Opening documentation ${chalk_1.default.green(browserCommand)}`);
    try {
        const { stdout, stderr } = await (0, tools_1.runUserCommandLine)(browserCommand);
        if (stdout) {
            await ioHelper.defaults.debug(stdout);
        }
        if (stderr) {
            await ioHelper.defaults.warn(stderr);
        }
    }
    catch (err) {
        const e = err;
        await ioHelper.defaults.debug(`An error occurred when trying to open a browser: ${e.stack || e.message}`);
    }
    return 0;
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZG9jcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImRvY3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBdUJBLG9CQXdCQztBQS9DRCxrREFBMEI7QUFFMUIsNENBQXNEO0FBRXpDLFFBQUEsT0FBTyxHQUFHLE1BQU0sQ0FBQztBQUNqQixRQUFBLFFBQVEsR0FBRyxnREFBZ0QsQ0FBQztBQUM1RCxRQUFBLE9BQU8sR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDO0FBaUJ4QixLQUFLLFVBQVUsSUFBSSxDQUFDLE9BQW9CO0lBQzdDLE1BQU0sUUFBUSxHQUFHLE9BQU8sQ0FBQyxRQUFRLENBQUM7SUFDbEMsTUFBTSxHQUFHLEdBQUcseUNBQXlDLENBQUM7SUFDdEQsTUFBTSxRQUFRLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxlQUFLLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7SUFDL0MsNkVBQTZFO0lBQzdFLHVFQUF1RTtJQUN2RSw4QkFBOEI7SUFDOUIsTUFBTSxjQUFjLEdBQUcsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxHQUFHLENBQUMsQ0FBQztJQUM3RCxNQUFNLFFBQVEsQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLHlCQUF5QixlQUFLLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUV0RixJQUFJLENBQUM7UUFDSCxNQUFNLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxHQUFHLE1BQU0sSUFBQSwwQkFBa0IsRUFBQyxjQUFjLENBQUMsQ0FBQztRQUNwRSxJQUFJLE1BQU0sRUFBRSxDQUFDO1lBQ1gsTUFBTSxRQUFRLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUN4QyxDQUFDO1FBQ0QsSUFBSSxNQUFNLEVBQUUsQ0FBQztZQUNYLE1BQU0sUUFBUSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDdkMsQ0FBQztJQUNILENBQUM7SUFBQyxPQUFPLEdBQVksRUFBRSxDQUFDO1FBQ3RCLE1BQU0sQ0FBQyxHQUFHLEdBQVksQ0FBQztRQUN2QixNQUFNLFFBQVEsQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLG9EQUFvRCxDQUFDLENBQUMsS0FBSyxJQUFJLENBQUMsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO0lBQzVHLENBQUM7SUFFRCxPQUFPLENBQUMsQ0FBQztBQUNYLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgY2hhbGsgZnJvbSAnY2hhbGsnO1xuaW1wb3J0IHR5cGUgeyBJb0hlbHBlciB9IGZyb20gJy4uL2FwaS1wcml2YXRlJztcbmltcG9ydCB7IHJ1blVzZXJDb21tYW5kTGluZSB9IGZyb20gJy4uL3ByaXZhdGUvdG9vbHMnO1xuXG5leHBvcnQgY29uc3QgY29tbWFuZCA9ICdkb2NzJztcbmV4cG9ydCBjb25zdCBkZXNjcmliZSA9ICdPcGVucyB0aGUgcmVmZXJlbmNlIGRvY3VtZW50YXRpb24gaW4gYSBicm93c2VyJztcbmV4cG9ydCBjb25zdCBhbGlhc2VzID0gWydkb2MnXTtcblxuLyoqXG4gKiBPcHRpb25zIGZvciB0aGUgZG9jcyBjb21tYW5kXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgRG9jc09wdGlvbnMge1xuICAvKipcbiAgICogVGhlIGNvbW1hbmQgdG8gdXNlIHRvIG9wZW4gdGhlIGJyb3dzZXJcbiAgICovXG4gIHJlYWRvbmx5IGJyb3dzZXI6IHN0cmluZztcblxuICAvKipcbiAgICogSW9IZWxwZXIgZm9yIG1lc3NhZ2luZ1xuICAgKi9cbiAgcmVhZG9ubHkgaW9IZWxwZXI6IElvSGVscGVyO1xufVxuXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gZG9jcyhvcHRpb25zOiBEb2NzT3B0aW9ucyk6IFByb21pc2U8bnVtYmVyPiB7XG4gIGNvbnN0IGlvSGVscGVyID0gb3B0aW9ucy5pb0hlbHBlcjtcbiAgY29uc3QgdXJsID0gJ2h0dHBzOi8vZG9jcy5hd3MuYW1hem9uLmNvbS9jZGsvYXBpL3YyLyc7XG4gIGF3YWl0IGlvSGVscGVyLmRlZmF1bHRzLmluZm8oY2hhbGsuZ3JlZW4odXJsKSk7XG4gIC8vIFRoZSBicm93c2VyIGNvbW1hbmQgaXMgdGhlIHVzZXIncyBvd24gYC0tYnJvd3NlcmAgb3B0aW9uICh3aXRoICV1IHJlcGxhY2VkXG4gIC8vIGJ5IHRoZSBjb25zdGFudCBkb2NzIFVSTCkgYW5kIG1heSByZWx5IG9uIHNoZWxsIGZlYXR1cmVzLCBzbyBpdCBydW5zXG4gIC8vIHRocm91Z2ggdGhlIHNoZWxsIHZlcmJhdGltLlxuICBjb25zdCBicm93c2VyQ29tbWFuZCA9IChvcHRpb25zLmJyb3dzZXIpLnJlcGxhY2UoLyV1L2csIHVybCk7XG4gIGF3YWl0IGlvSGVscGVyLmRlZmF1bHRzLmRlYnVnKGBPcGVuaW5nIGRvY3VtZW50YXRpb24gJHtjaGFsay5ncmVlbihicm93c2VyQ29tbWFuZCl9YCk7XG5cbiAgdHJ5IHtcbiAgICBjb25zdCB7IHN0ZG91dCwgc3RkZXJyIH0gPSBhd2FpdCBydW5Vc2VyQ29tbWFuZExpbmUoYnJvd3NlckNvbW1hbmQpO1xuICAgIGlmIChzdGRvdXQpIHtcbiAgICAgIGF3YWl0IGlvSGVscGVyLmRlZmF1bHRzLmRlYnVnKHN0ZG91dCk7XG4gICAgfVxuICAgIGlmIChzdGRlcnIpIHtcbiAgICAgIGF3YWl0IGlvSGVscGVyLmRlZmF1bHRzLndhcm4oc3RkZXJyKTtcbiAgICB9XG4gIH0gY2F0Y2ggKGVycjogdW5rbm93bikge1xuICAgIGNvbnN0IGUgPSBlcnIgYXMgRXJyb3I7XG4gICAgYXdhaXQgaW9IZWxwZXIuZGVmYXVsdHMuZGVidWcoYEFuIGVycm9yIG9jY3VycmVkIHdoZW4gdHJ5aW5nIHRvIG9wZW4gYSBicm93c2VyOiAke2Uuc3RhY2sgfHwgZS5tZXNzYWdlfWApO1xuICB9XG5cbiAgcmV0dXJuIDA7XG59XG4iXX0=