chore: format ts files using eslint + prettier

Author: crutchcorn

packages/node-plop/types/index.d.ts

@@ -1,152 +1,159 @@
-import inquirer from 'inquirer';
+import inquirer from "inquirer";
 // @types/globby doesn't export types for GlobOptions, so we have to work a little bit to extract them:
 // GlobOptions is the second parameter of the sync function, which can be extracted with the Parameters<T> type
-import {globbySync} from 'globby';
+import { globbySync } from "globby";
 
 type GlobOptions = Parameters<typeof globbySync>[1];
-import {HelperDelegate as HelperFunction} from 'handlebars';
+import { HelperDelegate as HelperFunction } from "handlebars";
 
 export interface IncludeDefinitionConfig {
-    generators?: boolean;
-    helpers?: boolean;
-    partials?: boolean;
-    actionTypes?: boolean;
+  generators?: boolean;
+  helpers?: boolean;
+  partials?: boolean;
+  actionTypes?: boolean;
 }
 
-export type IncludeDefinition =
-    | boolean
-    | string[]
-    | IncludeDefinitionConfig;
+export type IncludeDefinition = boolean | string[] | IncludeDefinitionConfig;
 
 export interface NodePlopAPI {
-    setGenerator(name: string, config: Partial<PlopGeneratorConfig>): PlopGenerator;
+  setGenerator(
+    name: string,
+    config: Partial<PlopGeneratorConfig>
+  ): PlopGenerator;
 
-    setPrompt(name: string, prompt: inquirer.prompts.PromptConstructor): void;
+  setPrompt(name: string, prompt: inquirer.prompts.PromptConstructor): void;
 
-    setWelcomeMessage(message: string): void;
+  setWelcomeMessage(message: string): void;
 
-    getWelcomeMessage(): string;
+  getWelcomeMessage(): string;
 
-    getGenerator(name: string): PlopGenerator;
+  getGenerator(name: string): PlopGenerator;
 
-    getGeneratorList(): { name: string; description: string }[];
+  getGeneratorList(): { name: string; description: string }[];
 
-    setPartial(name: string, str: string): void;
+  setPartial(name: string, str: string): void;
 
-    getPartial(name: string): string;
+  getPartial(name: string): string;
 
-    getPartialList(): string[];
+  getPartialList(): string[];
 
-    setHelper(name: string, fn: HelperFunction): void;
+  setHelper(name: string, fn: HelperFunction): void;
 
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    getHelper(name: string): Function;
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  getHelper(name: string): Function;
 
-    getHelperList(): string[];
+  getHelperList(): string[];
 
-    setActionType(name: string, fn: CustomActionFunction): void;
+  setActionType(name: string, fn: CustomActionFunction): void;
 
-    /**
-     * This does not include a `CustomActionConfig` for the same reasons
-     * Listed in the `ActionType` declaration. Please see that JSDoc for more
-     */
-    getActionType(name: string): ActionType;
+  /**
+   * This does not include a `CustomActionConfig` for the same reasons
+   * Listed in the `ActionType` declaration. Please see that JSDoc for more
+   */
+  getActionType(name: string): ActionType;
 
-    getActionTypeList(): string[];
+  getActionTypeList(): string[];
 
-    setPlopfilePath(filePath: string): void;
+  setPlopfilePath(filePath: string): void;
 
-    getPlopfilePath(): string;
+  getPlopfilePath(): string;
 
-    getDestBasePath(): string;
+  getDestBasePath(): string;
 
-    // plop.load functionality
-    load(target: string[] | string, loadCfg?: Partial<PlopCfg> | null, includeOverride?: IncludeDefinition): Promise<void>;
+  // plop.load functionality
+  load(
+    target: string[] | string,
+    loadCfg?: Partial<PlopCfg> | null,
+    includeOverride?: IncludeDefinition
+  ): Promise<void>;
 
-    setDefaultInclude(inc: object): void;
+  setDefaultInclude(inc: object): void;
 
-    getDefaultInclude(): object;
+  getDefaultInclude(): object;
 
-    renderString(template: string, data: any): string; //set to any matching handlebars declaration
+  renderString(template: string, data: any): string; //set to any matching handlebars declaration
 
-    // passthroughs for backward compatibility
-    /**
-     * @deprecated Use "setPrompt" instead. This will be removed in the next major release
-     */
-    addPrompt(name: string, prompt: inquirer.PromptModule): void;
+  // passthroughs for backward compatibility
+  /**
+   * @deprecated Use "setPrompt" instead. This will be removed in the next major release
+   */
+  addPrompt(name: string, prompt: inquirer.PromptModule): void;
 
-    /**
-     * @deprecated Use "setPartial" instead. This will be removed in the next major release
-     */
-    addPartial(name: string, str: string): void;
+  /**
+   * @deprecated Use "setPartial" instead. This will be removed in the next major release
+   */
+  addPartial(name: string, str: string): void;
 
-    /**
-     * @deprecated Use "setHelper" instead. This will be removed in the next major release
-     */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    addHelper(name: string, fn: Function): void;
+  /**
+   * @deprecated Use "setHelper" instead. This will be removed in the next major release
+   */
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  addHelper(name: string, fn: Function): void;
 }
 
 interface PlopActionHooksFailures {
-    type: string;
-    path: string;
-    error: string;
-    message: string;
+  type: string;
+  path: string;
+  error: string;
+  message: string;
 }
 
 interface PlopActionHooksChanges {
-    type: string;
-    path: string;
+  type: string;
+  path: string;
 }
 
 interface PlopActionHooks {
-    onComment?: (msg: string) => void;
-    onSuccess?: (change: PlopActionHooksChanges) => void;
-    onFailure?: (failure: PlopActionHooksFailures) => void;
+  onComment?: (msg: string) => void;
+  onSuccess?: (change: PlopActionHooksChanges) => void;
+  onFailure?: (failure: PlopActionHooksFailures) => void;
 }
 
 export interface PlopGeneratorConfig {
-    description: string;
-    prompts: Prompts;
-    actions: Actions;
+  description: string;
+  prompts: Prompts;
+  actions: Actions;
 }
 
 export interface PlopGenerator extends PlopGeneratorConfig {
-    runPrompts: (bypassArr?: string[]) => Promise<any>;
-    runActions: (
-        answers: inquirer.Answers,
-        hooks?: PlopActionHooks
-    ) => Promise<{
-        changes: PlopActionHooksChanges[];
-        failures: PlopActionHooksFailures[];
-    }>;
+  runPrompts: (bypassArr?: string[]) => Promise<any>;
+  runActions: (
+    answers: inquirer.Answers,
+    hooks?: PlopActionHooks
+  ) => Promise<{
+    changes: PlopActionHooksChanges[];
+    failures: PlopActionHooksFailures[];
+  }>;
 }
 
-export type PromptQuestion = inquirer.Question
-    | inquirer.CheckboxQuestion
-    | inquirer.ListQuestion
-    | inquirer.ExpandQuestion
-    | inquirer.ConfirmQuestion
-    | inquirer.EditorQuestion
-    | inquirer.RawListQuestion
-    | inquirer.PasswordQuestion
-    | inquirer.NumberQuestion
-    | inquirer.InputQuestion;
-
-export type DynamicPromptsFunction = (inquirer: inquirer.Inquirer) => Promise<inquirer.Answers>;
+export type PromptQuestion =
+  | inquirer.Question
+  | inquirer.CheckboxQuestion
+  | inquirer.ListQuestion
+  | inquirer.ExpandQuestion
+  | inquirer.ConfirmQuestion
+  | inquirer.EditorQuestion
+  | inquirer.RawListQuestion
+  | inquirer.PasswordQuestion
+  | inquirer.NumberQuestion
+  | inquirer.InputQuestion;
+
+export type DynamicPromptsFunction = (
+  inquirer: inquirer.Inquirer
+) => Promise<inquirer.Answers>;
 export type DynamicActionsFunction = (data?: inquirer.Answers) => ActionType[];
 
-export type Prompts = DynamicPromptsFunction | PromptQuestion[]
+export type Prompts = DynamicPromptsFunction | PromptQuestion[];
 export type Actions = DynamicActionsFunction | ActionType[];
 
 interface Template {
-    template: string;
-    templateFile?: never;
+  template: string;
+  templateFile?: never;
 }
 
 interface TemplateFile {
-    template?: never;
-    templateFile: string;
+  template?: never;
+  templateFile: string;
 }
 
 type TemplateStrOrFile = Template | TemplateFile;
@@ -165,18 +172,17 @@ type TemplateStrOrFile = Template | TemplateFile;
  *
  * To ignore this limitation, simply pass "string"
  */
-export interface CustomActionConfig<TypeString extends string> extends Omit<ActionConfig, 'type'> {
-    type: TypeString extends 'addMany' |
-        'modify' |
-        'append' ? never : TypeString;
+export interface CustomActionConfig<TypeString extends string>
+  extends Omit<ActionConfig, "type"> {
+  type: TypeString extends "addMany" | "modify" | "append" ? never : TypeString;
 
-    [key: string]: any;
+  [key: string]: any;
 }
 
 export type CustomActionFunction = (
-    answers: inquirer.Answers,
-    config: CustomActionConfig<string>,
-    plopfileApi: NodePlopAPI
+  answers: inquirer.Answers,
+  config: CustomActionConfig<string>,
+  plopfileApi: NodePlopAPI
 ) => Promise<string> | string;
 
 /**
@@ -190,69 +196,83 @@ export type CustomActionFunction = (
  * If you know of a solution, please open a GitHub issue to discuss
  */
 export type ActionType =
-    | string
-    | ActionConfig
-    | AddActionConfig
-    | AddManyActionConfig
-    | ModifyActionConfig
-    | AppendActionConfig
-    | CustomActionFunction;
+  | string
+  | ActionConfig
+  | AddActionConfig
+  | AddManyActionConfig
+  | ModifyActionConfig
+  | AppendActionConfig
+  | CustomActionFunction;
 
 export interface ActionConfig {
-    type: string;
-    force?: boolean;
-    data?: object;
-    abortOnFail?: boolean;
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    skip?: Function;
+  type: string;
+  force?: boolean;
+  data?: object;
+  abortOnFail?: boolean;
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  skip?: Function;
 }
 
-type TransformFn<T> = (template: string, data: any, cfg: T) => string | Promise<string>;
+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>;
+  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: GlobOptions;
-    verbose?: boolean;
-    transform?: TransformFn<AddManyActionConfig>;
+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: GlobOptions;
+  verbose?: boolean;
+  transform?: TransformFn<AddManyActionConfig>;
 }
 
 interface ModifyActionConfigBase extends ActionConfig {
-    type: 'modify';
-    path: string;
-    pattern: string | RegExp;
-    transform?: TransformFn<ModifyActionConfig>;
+  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;
+  type: "append";
+  path: string;
+  pattern: string | RegExp;
+  unique: boolean;
+  separator: string;
 }
 
 export type AppendActionConfig = AppendActionConfigBase & TemplateStrOrFile;
 
 export interface PlopCfg {
-    force: boolean;
-    destBasePath: string | undefined;
+  force: boolean;
+  destBasePath: string | undefined;
 }
 
-declare function nodePlop(plopfilePath?: string, plopCfg?: PlopCfg): Promise<NodePlopAPI>;
+declare function nodePlop(
+  plopfilePath?: string,
+  plopCfg?: PlopCfg
+): Promise<NodePlopAPI>;
 
 export default nodePlop;