50 lines
1.4 KiB
TypeScript
50 lines
1.4 KiB
TypeScript
interface GitInfo {
|
|
provider: "github" | "gitlab" | "bitbucket" | "sourcehut";
|
|
repo: string;
|
|
subdir: string;
|
|
ref: string;
|
|
}
|
|
interface TemplateInfo {
|
|
name: string;
|
|
tar: string;
|
|
version?: string;
|
|
subdir?: string;
|
|
url?: string;
|
|
defaultDir?: string;
|
|
headers?: Record<string, string | undefined>;
|
|
source?: never;
|
|
dir?: never;
|
|
[key: string]: any;
|
|
}
|
|
type TemplateProvider = (input: string, options: {
|
|
auth?: string;
|
|
}) => TemplateInfo | Promise<TemplateInfo> | null;
|
|
|
|
interface DownloadTemplateOptions {
|
|
provider?: string;
|
|
force?: boolean;
|
|
forceClean?: boolean;
|
|
offline?: boolean;
|
|
preferOffline?: boolean;
|
|
providers?: Record<string, TemplateProvider>;
|
|
dir?: string;
|
|
registry?: false | string;
|
|
cwd?: string;
|
|
auth?: string;
|
|
install?: boolean;
|
|
silent?: boolean;
|
|
}
|
|
type DownloadTemplateResult = Omit<TemplateInfo, "dir" | "source"> & {
|
|
dir: string;
|
|
source: string;
|
|
};
|
|
declare function downloadTemplate(input: string, options?: DownloadTemplateOptions): Promise<DownloadTemplateResult>;
|
|
|
|
declare const registryProvider: (registryEndpoint?: string, options?: {
|
|
auth?: string;
|
|
}) => TemplateProvider;
|
|
|
|
declare function startShell(cwd: string): void;
|
|
|
|
export { type DownloadTemplateOptions, type DownloadTemplateResult, type GitInfo, type TemplateInfo, type TemplateProvider, downloadTemplate, registryProvider, startShell };
|