@roots/bud-api/src/methods/copyFile/index.ts

bud.js core module

import type {Bud} from '@roots/bud-framework'
import type {Plugin as CopyPlugin} from '@roots/bud-support/copy-webpack-plugin'

import {dirname, isAbsolute} from 'node:path'

type FromToTuple = [string, string]

export type Parameters = [
  FromToTuple | string,
  string?,
  Partial<CopyPlugin.ObjectPattern>?,
]

export interface copyFile {
  (...parameters: Parameters): Promise<Bud>
}

export const copyFile: copyFile = async function copyFile(
  this: Bud,
  request,
  context,
  overrides = {},
) {
  const app = this as Bud
  const makePatternObjectFromString = fromStringFactory(app, overrides)
  const makePatternObjectFromTuple = fromTupleFactory(app, overrides)

  if (!context) context = app.path(`@src`)
  if (!isAbsolute(context)) context = app.path(context)

  const result =
    typeof request === `string`
      ? makePatternObjectFromString(request, context)
      : makePatternObjectFromTuple(...request, context)

  app.extensions
    .get(`@roots/bud-extensions/copy-webpack-plugin`)
    .set(`patterns`, (patterns = []) => [...patterns, result])

  app.api.logger.log(`bud.copyDir: asset pattern added`)

  return app
}

/**
 * Take an input string and return a {@link CopyPlugin.ObjectPattern}
 */
export const fromStringFactory =
  (app: Bud, overrides: Partial<CopyPlugin.ObjectPattern>) =>
  (from: string, context: string): CopyPlugin.ObjectPattern => ({
    context,
    from,
    to: app.relPath(dirname(from), `@file`),
    ...overrides,
  })

/**
 * Take an input [from,to] tuple and return a {@link CopyPlugin.ObjectPattern}
 */
export const fromTupleFactory =
  (app: Bud, overrides: Partial<CopyPlugin.ObjectPattern>) =>
  (
    from: string,
    to: string,
    context: string,
  ): CopyPlugin.ObjectPattern => ({
    context,
    from,
    to: app.relPath(to),
    ...overrides,
  })