outfitter
Version:
Command-line tool for equipping your development journey with configurations and fieldguides
38 lines • 1.66 kB
TypeScript
import { type Ora } from 'ora';
import type { PackageSelection } from '../types/index.js';
import { type TerrainFeatures } from '../utils/detect-terrain.js';
/**
* Displays a cyan-colored welcome message introducing the Outfitter tool in the CLI.
*/
export declare function showWelcome(): void;
/**
* Displays a summary of detected terrain features in the console.
*
* If any terrain features are present in {@link terrain}, each is listed as a bullet point under a cyan-colored heading.
*
* @param terrain - The terrain features to summarize and display.
*/
export declare function showTerrainSummary(terrain: TerrainFeatures): void;
/**
* Displays the name of the package manager being used in gray text.
*
* @param manager - The name of the package manager.
*/
export declare function showPackageManager(manager: string): void;
/**
* Displays a list of recommended next steps after setting up the Outfitter project.
*
* Prints instructions for linting, reviewing AI assistant documentation, and, if applicable, exploring available fieldguides.
*
* @param packageManager - The package manager to use for running commands.
* @param selection - The user's package selection, used to determine if fieldguides are included.
*/
export declare function showNextSteps(packageManager: string, selection: PackageSelection): void;
/**
* Creates and returns a CLI spinner initialized with the specified text.
*
* @param text - The message to display alongside the spinner.
* @returns An `Ora` spinner instance for indicating progress in the CLI.
*/
export declare function createSpinner(text: string): Ora;
//# sourceMappingURL=console.d.ts.map