@turbo/gen 2.8.17 → 2.8.18-canary.2

package/dist/types.d.ts

@@ -1,2 +1,155 @@
-import * as PlopTypes from "node-plop";
-export { type PlopTypes };
+//#region src/types.d.ts
+declare namespace PlopTypes {
+  export interface Answers {
+    [key: string]: any;
+  }
+  export interface IncludeDefinitionConfig {
+    generators?: boolean;
+    helpers?: boolean;
+    partials?: boolean;
+    actionTypes?: boolean;
+  }
+  export type IncludeDefinition = boolean | string[] | IncludeDefinitionConfig;
+  export interface PlopCfg {
+    force: boolean;
+    destBasePath: string | undefined;
+  }
+  export interface ActionConfig {
+    type: string;
+    force?: boolean;
+    data?: object;
+    abortOnFail?: boolean;
+    skip?: (...args: any[]) => any;
+  }
+  interface Template {
+    template: string;
+    templateFile?: never;
+  }
+  interface TemplateFile {
+    template?: never;
+    templateFile: string;
+  }
+  type TemplateStrOrFile = Template | TemplateFile;
+  type TransformFn<T> = (template: string, data: any, cfg: T) => string | Promise<string>;
+  interface AddActionConfigBase extends ActionConfig {
+    type: "add";
+    path: string;
+    skipIfExists?: boolean;
+    transform?: TransformFn<AddActionConfig>;
+  }
+  export type AddActionConfig = AddActionConfigBase & TemplateStrOrFile;
+  export interface AddManyActionConfig extends Pick<AddActionConfig, Exclude<keyof AddActionConfig, "type" | "templateFile" | "template" | "transform">> {
+    type: "addMany";
+    destination: string;
+    base: string;
+    templateFiles: string | string[];
+    stripExtensions?: string[];
+    globOptions: Record<string, unknown>;
+    verbose?: boolean;
+    transform?: TransformFn<AddManyActionConfig>;
+  }
+  interface ModifyActionConfigBase extends ActionConfig {
+    type: "modify";
+    path: string;
+    pattern: string | RegExp;
+    transform?: TransformFn<ModifyActionConfig>;
+  }
+  export type ModifyActionConfig = ModifyActionConfigBase & TemplateStrOrFile;
+  interface AppendActionConfigBase extends ActionConfig {
+    type: "append";
+    path: string;
+    pattern: string | RegExp;
+    unique: boolean;
+    separator: string;
+  }
+  export type AppendActionConfig = AppendActionConfigBase & TemplateStrOrFile;
+  export interface CustomActionConfig<TypeString extends string> extends Omit<ActionConfig, "type"> {
+    type: TypeString extends "addMany" | "modify" | "append" ? never : TypeString;
+    [key: string]: any;
+  }
+  export type CustomActionFunction = (answers: Answers, config: CustomActionConfig<string>, plopfileApi: NodePlopAPI) => Promise<string> | string;
+  export type ActionType = string | ActionConfig | AddActionConfig | AddManyActionConfig | ModifyActionConfig | AppendActionConfig | CustomActionFunction;
+  export interface PromptQuestion {
+    type?: string;
+    name?: string;
+    message?: string | ((...args: any[]) => string);
+    default?: any;
+    choices?: Array<any> | ((...args: any[]) => any);
+    validate?: (...args: any[]) => boolean | string | Promise<boolean | string>;
+    filter?: (...args: any[]) => any;
+    transformer?: (...args: any[]) => any;
+    when?: boolean | ((...args: any[]) => boolean | Promise<boolean>);
+    prefix?: string;
+    suffix?: string;
+    [key: string]: any;
+  }
+  export type DynamicPromptsFunction = (inquirer: unknown) => Promise<Answers>;
+  export type DynamicActionsFunction = (data?: Answers) => ActionType[];
+  export type Prompts = DynamicPromptsFunction | PromptQuestion[];
+  export type Actions = DynamicActionsFunction | ActionType[];
+  interface PlopActionHooksFailures {
+    type: string;
+    path: string;
+    error: string;
+    message: string;
+  }
+  interface PlopActionHooksChanges {
+    type: string;
+    path: string;
+  }
+  interface PlopActionHooks {
+    onComment?: (msg: string) => void;
+    onSuccess?: (change: PlopActionHooksChanges) => void;
+    onFailure?: (failure: PlopActionHooksFailures) => void;
+  }
+  export interface PlopGeneratorConfig {
+    description: string;
+    prompts: Prompts;
+    actions: Actions;
+  }
+  export interface PlopGenerator extends PlopGeneratorConfig {
+    runPrompts: (bypassArr?: string[]) => Promise<any>;
+    runActions: (answers: Answers, hooks?: PlopActionHooks) => Promise<{
+      changes: PlopActionHooksChanges[];
+      failures: PlopActionHooksFailures[];
+    }>;
+  }
+  export interface NodePlopAPI {
+    setGenerator(name: string, config: Partial<PlopGeneratorConfig>): PlopGenerator;
+    setPrompt(name: string, prompt: unknown): void;
+    setWelcomeMessage(message: string): void;
+    getWelcomeMessage(): string;
+    getGenerator(name: string): PlopGenerator;
+    getGeneratorList(): {
+      name: string;
+      description: string;
+    }[];
+    setPartial(name: string, str: string): void;
+    getPartial(name: string): string;
+    getPartialList(): string[];
+    setHelper(name: string, fn: (...args: any[]) => any): void;
+    getHelper(name: string): (...args: any[]) => any;
+    getHelperList(): string[];
+    setActionType(name: string, fn: CustomActionFunction): void;
+    getActionType(name: string): ActionType;
+    getActionTypeList(): string[];
+    setPlopfilePath(filePath: string): void;
+    getPlopfilePath(): string;
+    getDestBasePath(): string;
+    load(target: string[] | string, loadCfg?: Partial<PlopCfg> | null, includeOverride?: IncludeDefinition): Promise<void>;
+    setDefaultInclude(inc: object): void;
+    getDefaultInclude(): object;
+    renderString(template: string, data: any): string;
+    /** @deprecated Use "setPrompt" instead. */
+    addPrompt(name: string, prompt: unknown): void;
+    /** @deprecated Use "setPartial" instead. */
+    addPartial(name: string, str: string): void;
+    /** @deprecated Use "setHelper" instead. */
+    addHelper(name: string, fn: (...args: any[]) => any): void;
+  }
+  export {};
+}
+//# sourceMappingURL=types.d.ts.map
+//#endregion
+export { PlopTypes };
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../../../../../src/types.ts"],"sourcesContent":[],"mappings":";kBAWiB,SAAA;EAAA,OAAA,UAAS,OAAA,CAAA;IAAA,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,GAAA;EAAA;EAYoD,OAyBnD,UAAA,uBAAA,CAAA;IAAW,UAAA,CAAA,EAAA,OAAA;IAK7B,OAAA,CAAA,EAAA,OAAA;IACO,QAAA,CAAA,EAAA,OAAA;IAMY,WAAA,CAAA,EAAA,OAAA;EAAe;EAAhB,OAJa,KAAA,iBAAA,GAAA,OAAA,GAAA,MAAA,EAAA,GAjCe,uBAiCf;EAAY,OAOpB,UAAA,OAAA,CAAA;IAAsB,KAAA,EAAA,OAAA;IAGlD,YAAA,EAAA,MAAA,GAAA,SAAA;EAAe;EAEQ,OADvB,UAAA,YAAA,CAAA;IAUa,IAAA,EAAA,MAAA;IAEW,KAAA,CAAA,EAAA,OAAA;IAAZ,IAAA,CAAA,EAAA,MAAA;IAd+B,WAAA,CAAA,EAAA,OAAA;IAoBzB,IAAA,CAAA,EAAA,CAAA,GAAA,IAAA,EAAA,GAAA,EAAA,EAAA,GAAA,GAAA;EAAM;EACkB,UAA9B,QAAA,CAAA;IAJ2B,QAAA,EAAA,MAAA;IAOR,YAAA,CAAA,EAAA,KAAA;EAAsB;EAAoB,UAKvD,YAAA,CAAA;IAHqB,QAAA,CAAA,EAAA,KAAA;IAQR,YAAA,EAAA,MAAA;EAAsB;EAAoB,KAGzE,iBAAA,GAtDuB,QAsDvB,GAtDkC,YAsDlC;EAAY,KAGN,WAAA,CAAA,CAAA,CAAA,GAAA,CAAA,QAAA,EAAA,MAAA,EAAA,IAAA,EAAA,GAAA,EAAA,GAAA,EApDD,CAoDC,EAAA,GAAA,MAAA,GAnDM,OAmDN,CAAA,MAAA,CAAA;EAAU,UAEZ,mBAAA,SAnDgC,YAmDhC,CAAA;IANiE,IAAA,EAAA,KAAA;IAW5D,IAAA,EAAA,MAAA;IACD,YAAA,CAAA,EAAA,OAAA;IACK,SAAA,CAAA,EAtDD,WAsDC,CAtDW,eAsDX,CAAA;EAAW;EACd,OAIR,KAAA,eAAA,GAxD0B,mBAwD1B,GAxDgD,iBAwDhD;EAAY,OACZ,UAAA,mBAAA,SAvDyC,IAuDzC,CAtDF,eAsDE,EArDF,OAqDE,CAAA,MApDM,eAoDN,EAAA,MAAA,GAAA,cAAA,GAAA,UAAA,GAAA,WAAA,CAAA,CAAA,CAAA;IACA,IAAA,EAAA,SAAA;IACA,WAAA,EAAA,MAAA;IACA,IAAA,EAAA,MAAA;IACA,aAAA,EAAA,MAAA,GAAA,MAAA,EAAA;IAOQ,eAAA,CAAA,EAAA,MAAA,EAAA;IACwC,WAAA,EAvDrC,MAuDqC,CAAA,MAAA,EAAA,OAAA,CAAA;IAGF,OAAA,CAAA,EAAA,OAAA;IAMkB,SAAA,CAAA,EA9DtD,WA8DsD,CA9D1C,mBA8D0C,CAAA;EAAO;EAAR,UAEtB,sBAAA,SA7DJ,YA6DI,CAAA;IAAY,IAAA,EAAA,QAAA;IAEnC,IAAA,EAAA,MAAA;IAAyB,OAAA,EAAA,MAAA,GA5D3B,MA4D2B;IACzB,SAAA,CAAA,EA5DR,WA4DQ,CA5DI,kBA4DJ,CAAA;EAAsB;EAAa,OAgBlC,KAAA,kBAAA,GAzEU,sBAyEV,GAzEmC,iBAyEnC;EAAsB,UACrB,sBAAA,SAxEiB,YAwEjB,CAAA;IAKb,IAAA,EAAA,QAAA;IACA,IAAA,EAAA,MAAA;IAI6B,OAAA,EAAA,MAAA,GA/EpB,MA+EoB;IAE3B,MAAA,EAAA,OAAA;IACD,SAAA,EAAA,MAAA;EAAe;EAEQ,OACrB,KAAA,kBAAA,GAhFmB,sBAgFnB,GAhF4C,iBAgF5C;EAAuB,OAF9B,UAAA,kBAAA,CAAA,mBAAA,MAAA,CAAA,SA5EgE,IA4EhE,CA3EL,YA2EK,EAAA,MAAA,CAAA,CAAA;IALgC,IAAA,EAnE/B,UAmE+B,SAAA,SAAA,GAAA,QAAA,GAAA,QAAA,GAAA,KAAA,GAjEjC,UAiEiC;IAcnB,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,GAAA;EAAmB;EAApB,OACd,KAAA,oBAAA,GAAA,CAAA,OAAA,EA3EM,OA2EN,EAAA,MAAA,EA1EK,kBA0EL,CAAA,MAAA,CAAA,EAAA,WAAA,EAzEU,WAyEV,EAAA,GAxEA,OAwEA,CAAA,MAAA,CAAA,GAAA,MAAA;EAAa,OAQY,KAAA,UAAA,GAAA,MAAA,GA5E1B,YA4E0B,GA3E1B,eA2E0B,GA1E1B,mBA0E0B,GAzE1B,kBAyE0B,GAxE1B,kBAwE0B,GAvE1B,oBAuE0B;EAAa,OAgBT,UAAA,cAAA,CAAA;IAEH,IAAA,CAAA,EAAA,MAAA;IAYT,IAAA,CAAA,EAAA,MAAA;IAAR,OAAA,CAAA,EAAA,MAAA,GAAA,CAAA,CAAA,GAAA,IAAA,EAAA,GAAA,EAAA,EAAA,GAAA,MAAA,CAAA;IACQ,OAAA,CAAA,EAAA,GAAA;IACjB,OAAA,CAAA,EAhGO,KAgGP,CAAA,GAAA,CAAA,GAAA,CAAA,CAAA,GAAA,IAAA,EAAA,GAAA,EAAA,EAAA,GAAA,GAAA,CAAA;IAAO,QAAA,CAAA,EAAA,CAAA,GAAA,IAAA,EAAA,GAAA,EAAA,EAAA,GAAA,OAAA,GAAA,MAAA,GA/FwC,OA+FxC,CAAA,OAAA,GAAA,MAAA,CAAA;;;oDA5FsC;;;;;8DAMU,QAAQ;+CAEvB,YAAY;wBAEnC,yBAAyB;wBACzB,yBAAyB;;;;;;;;;;;;;yBAgBxB;0BACC;;;;aAKb;aACA;;yCAG4B;0CACC;0BAE3B,iBACD,oBACL;eACM;gBACC;;;;uCAOF,QAAQ,uBACf;;;;gCAQyB;;;;;;;;;;;oCAgBI;iCAEH;;;;;8CAYjB,QAAQ,mCACA,oBACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbo/gen",
-  "version": "2.8.17",
+  "version": "2.8.18-canary.2",
   "description": "Extend a Turborepo",
   "homepage": "https://turborepo.dev",
   "bugs": {
@@ -42,10 +42,10 @@
     "typescript": "5.5.4",
     "update-check": "1.5.4",
     "validate-npm-package-name": "5.0.0",
-    "@turbo/test-utils": "0.0.0",
-    "@turbo/tsconfig": "0.0.0",
     "@turbo/utils": "0.0.0",
-    "@turbo/workspaces": "2.8.17"
+    "@turbo/workspaces": "2.8.18-canary.2",
+    "@turbo/tsconfig": "0.0.0",
+    "@turbo/test-utils": "0.0.0"
   },
   "scripts": {
     "build": "tsdown",