123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
import type {  Checkbox,  Confirm,  Input,  List,  Number,  prompt,  Secret,  Select,  Toggle,} from "../deps/cli.ts";import { Match } from "../utils/create_matcher.ts";import { UserDetails } from "../utils/get_user_details.ts";import { ExportedConfig } from "./types.ts";
export function defineTemplate(  props: ExportedConfig<TemplateProps>,): ExportedConfig<TemplateProps> {  return props;}
type MaybePromise<Type> = Type | Promise<Awaited<Type>>;
export interface AnyVariables {  [key: string]: unknown;}
export interface BaseVariables extends AnyVariables, UserDetails {  /**   * The basename of the project directory. This can be used as a default name.   */  name: string;}export type Callable<Type, Props = void> =  | MaybePromise<Type>  | ((props: Props) => MaybePromise<Type>);interface MatchProps<Variables extends BaseVariables = BaseVariables>  extends BaseTemplateProps {  variables: Variables;}
interface PromptProps {  /**   * Only available if `interactive` is `true`.   */  prompt: typeof prompt;
  /**   * Only available if `interactive` is `true`.   */  type: {    Checkbox: typeof Checkbox;    Confirm: typeof Confirm;    Input: typeof Input;    Number: typeof Number;    Secret: typeof Secret;    Toggle: typeof Toggle;    List: typeof List;    Select: typeof Select;  };}
/** * Permissions granted will be persisted across runs of the templates. */export interface ScaffoldPermissions {  env: string[];  ffi: string[];  read: string[];  run: string[];  write: string[];}
export interface TemplateProps<  Variables extends BaseVariables = BaseVariables,> {  /**   * Use the prompt to ask the user for input to determine the variables.   *   * This is not always called, if the user decided to skip the prompt then it   * will be skipped.   *   * Further docs can be found here: https://cliffy.io/docs@v0.24.2/prompt   *   * ```ts   * import { defineTemplate } from 'https://deno.land/x/scaffold/mod.ts';   *   * export defineTemplate({   *   gatherVariables: async (props) => {   *     const { prompt,  } = props;   *   }   * });   * ```   */  getVariables?: Callable<    AnyVariables,    BaseTemplateProps & PromptProps  >;
  /**   * Gather the permissions for the worker.   *   * Permissions that are approved will be cached so that the template can be   * without requesting new permissions every time.   */  getPermissions?: Callable<    Partial<ScaffoldPermissions>,    MatchProps<Variables>  >;
  /**   * These file will be included.   *   * Starting a glob with the `!` will negate the match. For clarity it is   * advised to use the `exclude` option instead.   */  getIncluded?: Callable<Match | Match[], MatchProps<Variables>>;
  /**   * Files that match will be excluded.   */  getExcluded?: Callable<Match | Match[], MatchProps<Variables>>;
  /**   * A map of relative file names to their renamed counterparts.   *   * ```ts   * import { defineTemplate } from 'https://deno.land/x/scaffold/mod.ts';   *   * export defineTemplate({   *   getRenamed: {   *     "src/index.ts": "src/main.ts", // Rename index.ts to main.ts   *   }   * })   * ```   */  getRenamed?: Callable<    Record<string, string> | undefined,    MatchProps<Variables>  >;
  /**   * Get an installation command which is run after the template is copied over.   *   * This can be used to run an npm install and initialize git.   */  getInstallCommand?: Callable<() => MaybePromise<void>, MatchProps<Variables>>;}
export interface BaseTemplateProps {  /**   * The name of the configuration file.   *   * @default 'scaffold'   */  name: string;
  /**   * The absolute path to the source directory of the template.   */  source: string;
  /**   * The absolute path to the destination directory.   */  destination: string;
  /**   * All the cli arguments that were passed when created via the cli.   */  initialVariables: BaseVariables;
  /**   * The current permissions of the worker.   */  permissions: ScaffoldPermissions;
  /**   * By default interactive is true. The prompt should only be used when   * interactive is true.   *   * If false, then `getVariables` will not be called.   *   * @default true   */  interactive: boolean;}