package.src.utilities.completion.d.ts Maven / Gradle / Ivy
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import { logging } from '@angular-devkit/core';
/**
* Checks if it is appropriate to prompt the user to setup autocompletion. If not, does nothing. If
* so prompts and sets up autocompletion for the user. Returns an exit code if the program should
* terminate, otherwise returns `undefined`.
* @returns an exit code if the program should terminate, undefined otherwise.
*/
export declare function considerSettingUpAutocompletion(command: string, logger: logging.Logger): Promise;
/**
* Sets up autocompletion for the user's terminal. This attempts to find the configuration file for
* the current shell (`.bashrc`, `.zshrc`, etc.) and append a command which enables autocompletion
* for the Angular CLI. Supports only Bash and Zsh. Returns whether or not it was successful.
* @return The full path of the configuration file modified.
*/
export declare function initializeAutocomplete(): Promise;
/**
* Returns whether the user has a global CLI install.
* Execution from `npx` is *not* considered a global CLI install.
*
* This does *not* mean the current execution is from a global CLI install, only that a global
* install exists on the system.
*/
export declare function hasGlobalCliInstall(): Promise;