Method makeUsingStub

modules/ace/codemods.ts:563–610

* Generate a file using a stub template * * @param stubsRoot - Root directory containing stub files * @param stubPath - Path to the specific stub file * @param stubState - Template variables for stub generation * * @example * ```ts * const result = await codemods.makeUsingStu

(
    stubsRoot: string,
    stubPath: string,
    stubState: Record<string, any>,
    options?: {
      contentsFromFile?: string
    }
  )

   * ```
   */
  async makeUsingStub(
    stubsRoot: string,
    stubPath: string,
    stubState: Record<string, any>,
    options?: {
      contentsFromFile?: string
    }
  ): Promise<GeneratedStub> {
    const stubs = await this.#app.stubs.create()
    const stub = await stubs.build(stubPath, { source: stubsRoot })

    /**
     * Overwrite the contents of the stub output with the contents
     * of the provided file.
     */
    if (options?.contentsFromFile) {
      const source = isAbsolute(options.contentsFromFile)
        ? options.contentsFromFile
        : this.#app.makePath(options.contentsFromFile)

      try {
        debug('overwriting stub output with contents from file %s', source)
        stub.replaceWith(await readFile(source, 'utf-8'))
      } catch (error: any) {
        if (error.code === 'ENOENT') {
          throw new Error(
            `Cannot replace stub output with "${options.contentsFromFile}" file contents as the file is missing`,
            { cause: error }
          )
        }
        throw error
      }
    }

    const output = await stub.generate({ force: this.overwriteExisting, ...stubState })
    debug('generating file %O', output)

    const entityFileName = stringHelpers.toUnixSlash(this.#app.relativePath(output.destination))
    const result = { ...output, relativeFileName: entityFileName }

    if (output.status === 'skipped') {
      this.#cliLogger.action(`create ${entityFileName}`).skipped(output.skipReason)
      return result
    }

    this.#cliLogger.action(`create ${entityFileName}`).succeeded()
    return result
  }

  /**
   * Install packages using the detected or specified package manager.