gen-jhipster/dist/cli/jhipster-command.d.ts

VHipster - Spring Boot + Angular/React/Vue in one handy generator

/**
 * Copyright 2013-2026 the original author or authors from the JHipster project.
 *
 * This file is part of the JHipster project, see https://www.jhipster.tech/
 * for more information.
 *
 * 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
 *
 *      https://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.
 */
import { Command, Option } from 'commander';
import { type JHipsterArgumentsWithChoices, type JHipsterCommandOptions, type JHipsterConfigs } from '../lib/command/index.ts';
import type { CliCommandOptions } from './types.ts';
export default class JHipsterCommand extends Command {
    configs: {};
    blueprintConfigs: {};
    generatorNamespaces: string[];
    _lazyBuildCommandCallBack?: (this: JHipsterCommand, args?: string | string[]) => Promise<void>;
    private _excessArgumentsCallback?;
    createCommand(name?: string): JHipsterCommand;
    /**
     * Alternative for alias() accepting chaining with undefined value.
     */
    addAlias(alias: string): this;
    /**
     * Register a callback to be executed before _parseCommand.
     * Used to lazy load options.
     * @param {} lazyBuildCommandCallBack
     * @return {JHipsterCommand} this;
     */
    lazyBuildCommand(lazyBuildCommandCallBack: (this: JHipsterCommand, args?: string | string[]) => Promise<void>): this;
    /**
     * Register callback to customize _excessArguments behavior.
     */
    excessArgumentsCallback(excessArgumentsCallback: (this: JHipsterCommand, receivedArgs: string[]) => void): this;
    /**
     * @private
     * Override _excessArguments to customize behavior.
     */
    _excessArguments(receivedArgs: string[]): void;
    /**
     * @private
     * Override _parseCommand to execute a callback before parsing.
     */
    _parseCommand(operands: string[], unknown: string[]): Promise<any>;
    /**
     * Override addOption to register a negative alternative for every option.
     */
    addOption(option: Option): this;
    /**
     * Register arguments using cli/commands.js structure.
     */
    addCommandArguments(args?: string[]): this;
    /**
     * Register options using cli/commands.js structure.
     */
    addCommandOptions(opts?: CliCommandOptions[]): this;
    _addCommandOption(opt: CliCommandOptions): this;
    addJHipsterArguments(jhipsterArguments?: JHipsterArgumentsWithChoices): this;
    addJHipsterConfigs(configs?: JHipsterConfigs, blueprintOptionDescription?: string): this;
    _addGeneratorOption(optionName: string, optionDefinition: JHipsterCommandOptions, additionalDescription?: string): any;
}