Class Codemods

constructor

• new Codemods(app: Application<any>, cliLogger: Logger): Codemods

  Parameters

  • app: Application<any>
  • cliLogger: Logger

  Returns Codemods

overwriteExisting

verboseInstallOutput

defineEnvVariables

• defineEnvVariables<T extends Record<string, string | number | boolean>>(
      environmentVariables: T,
      options?: { omitFromExample?: (keyof T)[] },
  ): Promise<void>

  Define one or more environment variables

  Type Parameters

  • T extends Record<string, string | number | boolean>

  Parameters

  • environmentVariables: T
  • Optionaloptions: { omitFromExample?: (keyof T)[] }

  Returns Promise<void>

getTsMorphProject

• getTsMorphProject(): Promise<undefined | Project>

  Returns the TsMorph project instance See https://ts-morph.com/

  Returns Promise<undefined | Project>

defineEnvValidations

• defineEnvValidations(validations: EnvValidationNode): Promise<void>

  Define validations for the environment variables

  Parameters

  • validations: EnvValidationNode

  Returns Promise<void>

registerMiddleware

• registerMiddleware(
      stack: "server" | "router" | "named",
      middleware: MiddlewareNode[],
  ): Promise<void>

  Define validations for the environment variables

  Parameters

  • stack: "server" | "router" | "named"
  • middleware: MiddlewareNode[]

  Returns Promise<void>

registerPolicies

• registerPolicies(policies: BouncerPolicyNode[]): Promise<void>

  Register bouncer policies to the list of policies collection exported from the "app/policies/main.ts" file.

  Parameters

  • policies: BouncerPolicyNode[]

  Returns Promise<void>

updateRcFile

• updateRcFile(
      ...params: [callback: (transformer: RcFileTransformer) => void],
  ): Promise<void>

  Update RCFile

  Parameters

  • ...params: [callback: (transformer: RcFileTransformer) => void]

  Returns Promise<void>

registerVitePlugin

• registerVitePlugin(
      ...params: [pluginCall: string, importDeclarations: {}[]],
  ): Promise<void>

  Register a new Vite plugin in the vite.config.ts file

  Parameters

  • ...params: [pluginCall: string, importDeclarations: {}[]]

  Returns Promise<void>

registerJapaPlugin

• registerJapaPlugin(
      ...params: [pluginCall: string, importDeclarations: {}[]],
  ): Promise<void>

  Register a new Japa plugin in the tests/bootstrap.ts file

  Parameters

  • ...params: [pluginCall: string, importDeclarations: {}[]]

  Returns Promise<void>

makeUsingStub

• makeUsingStub(
      stubsRoot: string,
      stubPath: string,
      stubState: Record<string, any>,
  ): Promise<
      | { relativeFileName: string }
      | { relativeFileName: string }
      | { relativeFileName: string },
  >

  Generate the stub

  Parameters

  • stubsRoot: string
  • stubPath: string
  • stubState: Record<string, any>

  Returns Promise<
      | { relativeFileName: string }
      | { relativeFileName: string }
      | { relativeFileName: string },
  >

installPackages

• installPackages(
      packages: { name: string; isDevDependency: boolean }[],
      packageManager?: SupportedPackageManager | "pnpm@6" | "deno",
  ): Promise<boolean>

  Install packages using the correct package manager You can specify version of each package by setting it in the name like :

  this.installPackages([{ name: '@adonisjs/lucid@next', isDevDependency: false }])
  Copy

  Parameters

  • packages: { name: string; isDevDependency: boolean }[]
  • OptionalpackageManager: SupportedPackageManager | "pnpm@6" | "deno"

  Returns Promise<boolean>

listPackagesToInstall

• listPackagesToInstall(
      packages: { name: string; isDevDependency: boolean }[],
  ): Promise<void>

  List the packages one should install before using the packages

  Parameters

  • packages: { name: string; isDevDependency: boolean }[]

  Returns Promise<void>