templates-mo/lib/types/settings.d.ts

Templates is a scaffolding framework that makes code generation simple, dynamic, and reusable. Generate files, parts of your app, or whole project structures—without the repetitive copy-pasting

import type { TemplateOptions, Templates } from "../templates/templates";
export declare enum SettingsFilePromptTpsType {
    data = "data",
    package = "package"
}
export declare enum SettingsFilePromptType {
    confirm = "confirm",
    input = "input",
    list = "list",
    rawlist = "rawlist",
    password = "password",
    checkbox = "checkbox"
}
export type AnswersData = any;
export type AnswersHash = Record<string, AnswersData>;
export interface PromptChoiceObject {
    name: string;
    short: string;
    value: string;
}
export type PromptChoice = string | PromptChoiceObject;
export interface SettingsFilePrompt {
    /**
     * Name of your prompt.
     */
    name: string;
    /**
     * Message that will be shown to users when generating a new instance.
     */
    message: string;
    /**
     * Prompt description.
     *
     * This description will be used on the templates options table for
     * the template and on the cli when `--help` is used.
     */
    description?: string;
    /**
     * Behavior of prompt.
     *
     * @link https://marcellino-ornelas.github.io/templates/docs/main/create-new-template/prompts#tps-type
     */
    tpsType: keyof typeof SettingsFilePromptTpsType;
    /**
     * Type of inquirer prompt you would like to use
     *
     * @link https://github.com/SBoudrias/Inquirer.js/tree/v6.0.0
     */
    type: keyof typeof SettingsFilePromptType;
    /**
     * Choices for your prompt.
     *
     * Only needed for prompts of type `list`, `rawlist` or `checkbox`
     */
    choices?: PromptChoice[];
    /**
     * Makes this prompt a hidden prompt.
     *
     * Hidden prompts dont get prompted to users by default but can
     * still be answered via a confiuration file or on the cli
     *
     * @version templates@>v1.1.1
     */
    hidden?: boolean;
    /**
     * Prompt aliases
     *
     * @example
     * 	{
     * 		name: 'example',
     * 		aliases: ['e', 'ex'],
     * 		// other options...
     * 	}
     */
    aliases?: string[];
    pageSize?: number;
    prefix?: string;
    suffix?: string;
    /**
     * Default value for this prompt
     */
    default?: string | number | boolean | Array<any> | DefaultFn;
    validate?: ValidateFn;
    filter?: (input: string) => Promise<string> | string;
    transformer?: (input: string) => string | Promise<string>;
    /**
     * Prompts user prompt when this function returns true
     */
    when?: boolean | WhenFn;
}
export type DefaultFn = (answers: AnswersHash) => any;
export type WhenFn = (answers: AnswersHash) => boolean;
export type ValidateFn = (input: string, answers: AnswersHash) => (boolean | string) | Promise<boolean | string>;
interface SettingsFileEvents {
    /**
     * Callback function to call before build paths are rendered
     */
    onRender?: (tps: Templates, args: {
        dest: string;
        buildPaths: string[];
        /**
         * Whether or not the process are building using build paths
         */
        hasBuildPaths: boolean;
        /**
         * Creates a new file in each instance
         */
        createFile: (file: string, content: string) => void;
        /**
         * Creates a new directory in each instance
         */
        createDirectory: (dir: string) => void;
    }) => Promise<void>;
    /**
     * Callback function to call before an build path is rendered
     */
    onBuildPathRender?: (tps: Templates, args: {
        buildPath: string;
    }) => Promise<void>;
    /**
     * Callback function to call when an build path is rendered
     */
    onBuildPathRendered?: (tps: Templates, args: {
        buildPath: string;
    }) => Promise<void>;
    /**
     * Callback function to call when all build paths are rendered
     */
    onRendered?: (tps: Templates, args: {
        dest: string;
        buildPaths: string[];
    }) => Promise<void>;
}
export interface SettingsFile {
    opts?: Partial<TemplateOptions>;
    prompts?: SettingsFilePrompt[];
    events?: SettingsFileEvents;
}
export {};