@bubblewrap/cli/dist/lib/cmds/help.js

CLI tool to Generate TWA projects from a Web Manifest

"use strict";
/*
 * Copyright 2019 Google Inc. 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.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.help = void 0;
const core_1 = require("@bubblewrap/core");
const strings_1 = require("../strings");
const HELP_MESSAGES = new Map([
    ['main', [
            'bubblewrap [command] <options>',
            '',
            '',
            'build ............... generates an Android APK from a TWA Project',
            'help ................ shows this menu',
            'init ................ initializes a new TWA Project',
            'update .............. updates an existing TWA Project with the latest bubblewrap template',
            'validate ............ validates if an URL matches the PWA Quality Criteria for Trusted' +
                ' Web Activity',
            'install ............. installs the output application to a connected device',
            'updateConfig ........ sets the paths of the jdk or the androidSdk to the given paths',
            'doctor ............. checks that the jdk and the androidSdk are in place and at the' +
                ' correct version',
        ].join('\n')],
    ['init', [
            'Usage:',
            '',
            '',
            'bubblewrap init --manifest=[web-manifest-url]',
            '',
            '',
            'Options:',
            '--directory ......... path where to generate the project. Defaults to the current' +
                ' directory',
        ].join('\n')],
    ['build', [
            'Usage:',
            '',
            '',
            'bubblewrap build',
            '',
            '',
            'Options:',
            '--skipPwaValidation ....... skips validating the wrapped PWA against the Quality Criteria',
        ].join('\n')],
    ['update', [
            'Usage:',
            '',
            '',
            'bubblewrap update',
            '',
            '',
            'Options:',
            '--appVersionName ........... version name to be used on on the upgrade. Ignored if ' +
                '--skipVersionUpgrade is used',
            '--skipVersionUpgrade ....... skips upgrading appVersion and appVersionCode',
            '--manifest ................. directory where the client should look for twa-manifest.json',
        ].join('\n')],
    ['validate', [
            'Usage:',
            '',
            '',
            'bubblewrap validate --url=[pwa-url]',
        ].join('\n')],
    ['install', [
            'Usage:',
            '',
            '',
            'bubblewrap install',
            '',
            '',
            'Options: ',
            '--apkFile ................. path to the APK file to be installed. Defaults to ' +
                '"./app-release-signed.apk"',
            '--verbose ................. prints the adb command being executed',
        ].join('\n')],
    ['updateConfig', [
            strings_1.enUS.updateConfigUsage,
            '',
            '',
            'Options: ',
            '--jdk ................. sets the jdk\'s path to the path given',
            '--androidSdk .......... sets the androidSdk\'s path to the path given',
        ].join('\n')],
    ['doctor', [
            'Usage:',
            '',
            '',
            'bubblewrap doctor',
        ].join('\n')],
]);
async function help(args, log = new core_1.ConsoleLog('help')) {
    // minimist uses an `_` object to store details.
    const command = args._[1];
    const message = HELP_MESSAGES.get(command) || HELP_MESSAGES.get('main');
    // We know we have a message for 'main', in case the command is invalid.
    log.info(message);
    return true;
}
exports.help = help;