Class CodeTransformer

constructor

• new CodeTransformer(cwd: URL): CodeTransformer

  Create a new CodeTransformer instance

  Parameters

  • cwd: URL

    The current working directory URL

  Returns CodeTransformer

installPackage

detectPackageManager

project

defineEnvValidations

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

  Add new env variable validation in the env.ts file

  Parameters

  • definition: EnvValidationNode

    Environment validation definition containing variables and comment

  Returns Promise<void>

addMiddlewareToStack

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

  Define new middlewares inside the start/kernel.ts file

  This function is highly based on some assumptions and will not work if you significantly tweaked your start/kernel.ts file.

  Parameters

  • stack: "named" | "server" | "router"

    The middleware stack to add to ('server', 'router', or 'named')

  • middleware: MiddlewareNode[]

    Array of middleware entries to add

  Returns Promise<void>

updateRcFile

• updateRcFile(callback: (transformer: RcFileTransformer) => void): Promise<void>

  Update the adonisrc.ts file using the provided callback

  Parameters

  • callback: (transformer: RcFileTransformer) => void

    Function that receives the RcFileTransformer for modifications

  Returns Promise<void>

addJapaPlugin

• addJapaPlugin(
      pluginCall: string,
      importDeclarations: {
          isNamed: boolean;
          module: string;
          identifier: string;
      }[],
  ): Promise<void>

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

  Parameters

  • pluginCall: string

    The plugin function call to add

  • importDeclarations: { isNamed: boolean; module: string; identifier: string }[]

    Import declarations needed for the plugin

  Returns Promise<void>

addVitePlugin

• addVitePlugin(
      pluginCall: string,
      importDeclarations: {
          isNamed: boolean;
          module: string;
          identifier: string;
      }[],
  ): Promise<void>

  Add a new Vite plugin to the vite.config.ts file

  Parameters

  • pluginCall: string

    The plugin function call to add

  • importDeclarations: { isNamed: boolean; module: string; identifier: string }[]

    Import declarations needed for the plugin

  Returns Promise<void>

addPolicies

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

  Adds a policy to the list of policies object configured inside the app/policies/main.ts file.

  Parameters

  • policies: BouncerPolicyNode[]

    Array of bouncer policy entries to add

  Returns Promise<void>