@adonisjs/assembler 6.1.3-6 → 6.1.3-8

package/index.ts

@@ -1,12 +0,0 @@
-/*
- * @adonisjs/assembler
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-export { Bundler } from './src/bundler.js'
-export { DevServer } from './src/dev_server.js'
-export { TestRunner } from './src/test_runner.js'

package/src/assets_dev_server.ts

@@ -1,182 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import type { ExecaChildProcess } from 'execa'
-import { type Logger, cliui } from '@poppinss/cliui'
-
-import { run } from './helpers.js'
-import type { AssetsBundlerOptions } from './types.js'
-
-/**
- * Instance of CLIUI
- */
-const ui = cliui()
-
-/**
- * Exposes the API to start the development server for processing assets during
- * development.
- *
- * - Here we are running the assets dev server in a child process.
- * - Piping the output from the child process and reformatting it before writing it to
- *   process streams.
- *
- * AssetsDevServer is agnostic and can run any assets dev server. Be it Vite or Encore or
- * even Webpack directly.
- */
-export class AssetsDevServer {
-  #cwd: URL
-  #logger = ui.logger
-  #options?: AssetsBundlerOptions
-  #devServer?: ExecaChildProcess<string>
-
-  /**
-   * Getting reference to colors library from logger
-   */
-  get #colors() {
-    return this.#logger.getColors()
-  }
-
-  constructor(cwd: URL, options?: AssetsBundlerOptions) {
-    this.#cwd = cwd
-    this.#options = options
-  }
-
-  /**
-   * Logs messages from vite dev server stdout and stderr
-   */
-  #logViteDevServerMessage(data: Buffer) {
-    const dataString = data.toString()
-    const lines = dataString.split('\n')
-
-    /**
-     * Logging VITE ready in message with proper
-     * spaces and newlines
-     */
-    if (dataString.includes('ready in')) {
-      console.log('')
-      console.log(dataString.trim())
-      return
-    }
-
-    /**
-     * Put a wrapper around vite network address log
-     */
-    if (dataString.includes('Local') && dataString.includes('Network')) {
-      const sticker = ui.sticker().useColors(this.#colors).useRenderer(this.#logger.getRenderer())
-
-      lines.forEach((line: string) => {
-        if (line.trim()) {
-          sticker.add(line)
-        }
-      })
-
-      sticker.render()
-      return
-    }
-
-    /**
-     * Log rest of the lines
-     */
-    lines.forEach((line: string) => {
-      if (line.trim()) {
-        console.log(line)
-      }
-    })
-  }
-
-  /**
-   * Logs messages from assets dev server stdout and stderr
-   */
-  #logAssetsDevServerMessage(data: Buffer) {
-    const dataString = data.toString()
-    const lines = dataString.split('\n')
-    lines.forEach((line: string) => {
-      if (line.trim()) {
-        console.log(line)
-      }
-    })
-  }
-
-  /**
-   * Set a custom CLI UI logger
-   */
-  setLogger(logger: Logger) {
-    this.#logger = logger
-    return this
-  }
-
-  /**
-   * Starts the assets bundler server. The assets bundler server process is
-   * considered as the secondary process and therefore we do not perform
-   * any cleanup if it dies.
-   */
-  start() {
-    if (!this.#options?.serve) {
-      return
-    }
-
-    this.#logger.info(`starting "${this.#options.driver}" dev server...`)
-
-    /**
-     * Create child process
-     */
-    this.#devServer = run(this.#cwd, {
-      script: this.#options.cmd,
-
-      /**
-       * We do not inherit the stdio for vite and encore, because in
-       * inherit mode they own the stdin and interrupts the
-       * `Ctrl + C` command.
-       */
-      stdio: 'pipe',
-      scriptArgs: this.#options.args,
-    })
-
-    /**
-     * Log child process messages
-     */
-    this.#devServer.stdout?.on('data', (data) => {
-      if (this.#options!.driver === 'vite') {
-        this.#logViteDevServerMessage(data)
-      } else {
-        this.#logAssetsDevServerMessage(data)
-      }
-    })
-
-    this.#devServer.stderr?.on('data', (data) => {
-      if (this.#options!.driver === 'vite') {
-        this.#logViteDevServerMessage(data)
-      } else {
-        this.#logAssetsDevServerMessage(data)
-      }
-    })
-
-    this.#devServer
-      .then((result) => {
-        this.#logger.warning(
-          `"${this.#options!.driver}" dev server closed with status code "${result.exitCode}"`
-        )
-      })
-      .catch((error) => {
-        this.#logger.warning(`unable to connect to "${this.#options!.driver}" dev server`)
-        this.#logger.fatal(error)
-      })
-  }
-
-  /**
-   * Stop the dev server
-   */
-  stop() {
-    if (this.#devServer) {
-      this.#devServer.removeAllListeners()
-      this.#devServer.kill('SIGKILL')
-      this.#devServer = undefined
-    }
-  }
-}

package/src/bundler.ts

@@ -1,267 +0,0 @@
-/*
- * @adonisjs/assembler
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import slash from 'slash'
-import copyfiles from 'cpy'
-import fs from 'node:fs/promises'
-import type tsStatic from 'typescript'
-import { fileURLToPath } from 'node:url'
-import { join, relative } from 'node:path'
-import { cliui, type Logger } from '@poppinss/cliui'
-
-import { run, parseConfig } from './helpers.js'
-import type { BundlerOptions } from './types.js'
-
-/**
- * Instance of CLIUI
- */
-const ui = cliui()
-
-/**
- * The bundler class exposes the API to build an AdonisJS project.
- */
-export class Bundler {
-  #cwd: URL
-  #cwdPath: string
-  #ts: typeof tsStatic
-  #logger = ui.logger
-  #options: BundlerOptions
-
-  /**
-   * Getting reference to colors library from logger
-   */
-  get #colors() {
-    return this.#logger.getColors()
-  }
-
-  constructor(cwd: URL, ts: typeof tsStatic, options: BundlerOptions) {
-    this.#cwd = cwd
-    this.#cwdPath = fileURLToPath(this.#cwd)
-    this.#ts = ts
-    this.#options = options
-  }
-
-  #getRelativeName(filePath: string) {
-    return slash(relative(this.#cwdPath, filePath))
-  }
-
-  /**
-   * Cleans up the build directory
-   */
-  async #cleanupBuildDirectory(outDir: string) {
-    await fs.rm(outDir, { recursive: true, force: true, maxRetries: 5 })
-  }
-
-  /**
-   * Runs assets bundler command to build assets.
-   */
-  async #buildAssets(): Promise<boolean> {
-    const assetsBundler = this.#options.assets
-    if (!assetsBundler?.serve) {
-      return true
-    }
-
-    try {
-      this.#logger.info('compiling frontend assets', { suffix: assetsBundler.cmd })
-      await run(this.#cwd, {
-        stdio: 'inherit',
-        script: assetsBundler.cmd,
-        scriptArgs: [],
-      })
-      return true
-    } catch {
-      return false
-    }
-  }
-
-  /**
-   * Runs tsc command to build the source.
-   */
-  async #runTsc(outDir: string): Promise<boolean> {
-    try {
-      await run(this.#cwd, {
-        stdio: 'inherit',
-        script: 'tsc',
-        scriptArgs: ['--outDir', outDir],
-      })
-      return true
-    } catch {
-      return false
-    }
-  }
-
-  /**
-   * Copy files to destination directory
-   */
-  async #copyFiles(files: string[], outDir: string) {
-    try {
-      await copyfiles(files, outDir, { cwd: this.#cwdPath })
-    } catch (error) {
-      if (!error.message.includes("the file doesn't exist")) {
-        throw error
-      }
-    }
-  }
-
-  /**
-   * Copy meta files to the output directory
-   */
-  async #copyMetaFiles(outDir: string, additionalFilesToCopy: string[]) {
-    const metaFiles = (this.#options.metaFiles || [])
-      .map((file) => file.pattern)
-      .concat(additionalFilesToCopy)
-
-    await this.#copyFiles(metaFiles, outDir)
-  }
-
-  /**
-   * Copies .adonisrc.json file to the destination
-   */
-  async #copyAdonisRcFile(outDir: string) {
-    const existingContents = JSON.parse(
-      await fs.readFile(join(this.#cwdPath, '.adonisrc.json'), 'utf-8')
-    )
-    const compiledContents = Object.assign({}, existingContents, {
-      typescript: false,
-      lastCompiledAt: new Date().toISOString(),
-    })
-
-    await fs.mkdir(outDir, { recursive: true })
-    await fs.writeFile(
-      join(outDir, '.adonisrc.json'),
-      JSON.stringify(compiledContents, null, 2) + '\n'
-    )
-  }
-
-  /**
-   * Returns the lock file name for a given packages client
-   */
-  #getClientLockFile(client: 'npm' | 'yarn' | 'pnpm') {
-    switch (client) {
-      case 'npm':
-        return 'package-lock.json'
-      case 'yarn':
-        return 'yarn.lock'
-      case 'pnpm':
-        return 'pnpm-lock.yaml'
-    }
-  }
-
-  /**
-   * Returns the installation command for a given packages client
-   */
-  #getClientInstallCommand(client: 'npm' | 'yarn' | 'pnpm') {
-    switch (client) {
-      case 'npm':
-        return 'npm ci --omit="dev"'
-      case 'yarn':
-        return 'yarn install --production'
-      case 'pnpm':
-        return 'pnpm i --prod'
-    }
-  }
-
-  /**
-   * Set a custom CLI UI logger
-   */
-  setLogger(logger: Logger) {
-    this.#logger = logger
-    return this
-  }
-
-  /**
-   * Bundles the application to be run in production
-   */
-  async bundle(
-    stopOnError: boolean = true,
-    client: 'npm' | 'yarn' | 'pnpm' = 'npm'
-  ): Promise<boolean> {
-    /**
-     * Step 1: Parse config file to get the build output directory
-     */
-    const config = parseConfig(this.#cwd, this.#ts)
-    if (!config) {
-      return false
-    }
-
-    /**
-     * Step 2: Cleanup existing build directory (if any)
-     */
-    const outDir = config.options.outDir || fileURLToPath(new URL('build/', this.#cwd))
-    this.#logger.info('cleaning up output directory', { suffix: this.#getRelativeName(outDir) })
-    await this.#cleanupBuildDirectory(outDir)
-
-    /**
-     * Step 3: Build frontend assets
-     */
-    if (!(await this.#buildAssets())) {
-      return false
-    }
-
-    /**
-     * Step 4: Build typescript source code
-     */
-    this.#logger.info('compiling typescript source', { suffix: 'tsc' })
-    const buildCompleted = await this.#runTsc(outDir)
-    await this.#copyFiles(['ace.js'], outDir)
-
-    /**
-     * Remove incomplete build directory when tsc build
-     * failed and stopOnError is set to true.
-     */
-    if (!buildCompleted && stopOnError) {
-      await this.#cleanupBuildDirectory(outDir)
-      const instructions = ui
-        .sticker()
-        .fullScreen()
-        .drawBorder((borderChar, colors) => colors.red(borderChar))
-
-      instructions.add(
-        this.#colors.red('Cannot complete the build process as there are TypeScript errors.')
-      )
-      instructions.add(
-        this.#colors.red(
-          'Use "--ignore-ts-errors" flag to ignore TypeScript errors and continue the build.'
-        )
-      )
-
-      this.#logger.logError(instructions.prepare())
-      return false
-    }
-
-    /**
-     * Step 5: Copy meta files to the build directory
-     */
-    const pkgFiles = ['package.json', this.#getClientLockFile(client)]
-    this.#logger.info('copying meta files to the output directory')
-    await this.#copyMetaFiles(outDir, pkgFiles)
-
-    /**
-     * Step 6: Copy .adonisrc.json file to the build directory
-     */
-    this.#logger.info('copying .adonisrc.json file to the output directory')
-    await this.#copyAdonisRcFile(outDir)
-
-    this.#logger.success('build completed')
-    this.#logger.log('')
-
-    /**
-     * Next steps
-     */
-    ui.instructions()
-      .useRenderer(this.#logger.getRenderer())
-      .heading('Run the following commands to start the server in production')
-      .add(this.#colors.cyan(`cd ${this.#getRelativeName(outDir)}`))
-      .add(this.#colors.cyan(this.#getClientInstallCommand(client)))
-      .add(this.#colors.cyan('node bin/server.js'))
-      .render()
-
-    return true
-  }
-}