Sketch out a directory copy feature

Author: bcomnes

README.md

@@ -587,6 +587,36 @@ These imports will include the `root.layout.js` layout assets into the `blog.lay
 
 All static assets in the `src` directory are copied 1:1 to the `public` directory. Any file in the `src` directory that doesn't end in `.js`, `.css`, `.html`, or `.md` is copied to the `dest` directory.
 
+### 📁 `.copy` directories
+
+If a directory with the `.copy` suffix is found in your `src` directory—like `oldsite.copy/`—its contents will be copied **as-is** into the `dest` directory during build. No processing or transformation is applied to any files inside. That means `.html`, `.js`, `.css`, and all other files are left untouched.
+
+This is useful when you have legacy or archived site content that you want to include in your site but don't want `top-bun` to process or modify.
+
+For example:
+
+```
+src/
+├── oldsite.copy/
+│   ├── client.js
+│   ├── hello.html
+│   └── styles/
+│       └── globals.css
+```
+
+After build:
+
+```
+public/
+├── oldsite/
+│   ├── client.js
+│   ├── hello.html
+│   └── styles/
+│       └── globals.css
+```
+
+You can have multiple `.copy` directories in `src`—they’ll all be handled this way.
+
 ## Templates
 
 Template files let you write any kind of file type to the `dest` folder while customizing the contents of that file with access to the site [Variables](#variables) object, or inject any other kind of data fetched at build time. Template files can be located anywhere and look like:

index.js

@@ -56,6 +56,7 @@ const DEFAULT_IGNORES = /** @type {const} */ ([
   'package-lock.json',
   'pnpm-lock.yaml',
   'yarn.lock',
+  '*.copy/*'
 ])
 
 /**

lib/build-copy/fixtures/bing/another.copy/.keep

@@ -0,0 +1,77 @@
+// @ts-ignore
+import cpx from 'cpx2'
+import { glob } from 'glob'
+import { join } from 'node:path'
+const copy = cpx.copy
+
+/**
+ * @typedef {Awaited<ReturnType<typeof copy>>} CopyBuilderReport
+ */
+
+/**
+ * @typedef {import('../builder.js').BuildStepResult<'static', CopyBuilderReport>} CopyBuildStepResult
+ */
+
+/**
+ * @typedef {import('../builder.js').BuildStep<'static', CopyBuilderReport>} CopyBuildStep
+ */
+
+/**
+ * @param  {string} src
+ * @return {Promise<{
+ *   src: string,
+ *   dest: string,
+ * }[]>}
+ */
+export async function getCopyDirs (src) {
+  const pattern = '**/*.copy/'
+
+  const copyDirs = await glob(pattern, {
+    cwd: src,
+    mark: true,
+    includeChildMatches: false
+  })
+
+  return copyDirs
+    .map(p => {
+      return {
+        src: join(p, '**/*'),
+        dest: join(p.replace('.copy', ''))
+      }
+    })
+}
+
+/**
+ * run CPX2 on src folder
+ *
+ * @type {CopyBuildStep}
+ */
+export async function buildCopy (src, dest, _siteData, _opts) {
+  /** @type {CopyBuildStepResult} */
+  const results = {
+    type: 'static',
+    report: {},
+    errors: [],
+    warnings: [],
+  }
+
+  const copyDirs = await getCopyDirs(src)
+
+  const copyTasks = copyDirs.map((copyDir) => {
+    return copy(join(src, copyDir.src), join(dest, copyDir.dest))
+  })
+
+  const settled = await Promise.allSettled(copyTasks)
+
+  for (const [index, result] of Object.entries(settled)) {
+    // @ts-expect-error
+    const copyDir = copyDirs[index]
+    if (result.status === 'rejected') {
+      const buildError = new Error('Error copying copy folders', { cause: result.reason })
+      results.errors.push(buildError)
+    } else {
+      results.report[copyDir.src] = result.value
+    }
+  }
+  return results
+}

lib/build-copy/fixtures/foo.copy/.keep

@@ -0,0 +1,24 @@
+import tap from 'tap'
+import { getCopyDirs } from './index.js'
+import { resolve } from 'node:path'
+
+const __dirname = import.meta.dirname
+
+tap.test('getCopyDirs returns correct src/dest pairs', async (t) => {
+  const src = resolve(__dirname, './fixtures')
+  const copyDirs = await getCopyDirs(src)
+
+  // console.log({ copyDirs })
+
+  const expected = [
+    { src: 'foo.copy/**/*', dest: 'foo/' },
+    { src: 'bing/another.copy/**/*', dest: 'bing/another/' }
+  ]
+
+  // Sort by src to avoid order mismatch
+  t.strictSame(
+    copyDirs.sort((a, b) => a.src.localeCompare(b.src)),
+    expected.sort((a, b) => a.src.localeCompare(b.src)),
+    'The copyDirs should contain the correct src/dest mappings'
+  )
+})

lib/build-copy/fixtures/foo.copy/bar/baz.copy/.keep

@@ -1,6 +1,7 @@
 import { buildPages } from './build-pages/index.js'
 import { identifyPages } from './identify-pages.js'
 import { buildStatic } from './build-static/index.js'
+import { buildCopy } from './build-copy/index.js'
 import { buildEsbuild } from './build-esbuild/index.js'
 import { TopBunAggregateError } from './helpers/top-bun-aggregate-error.js'
 import { ensureDest } from './helpers/ensure-dest.js'
@@ -57,13 +58,15 @@ import { ensureDest } from './helpers/ensure-dest.js'
  * @typedef {import('./build-esbuild/index.js').EsBuildStepResults} EsBuildStepResults
  * @typedef {import('./build-pages/index.js').PageBuildStepResult} PageBuildStepResult
  * @typedef {import('./build-static/index.js').StaticBuildStepResult} StaticBuildStepResult
+ * @typedef {import('./build-copy/index.js').CopyBuildStepResult} CopyBuildStepResult
  */
 
 /**
  * @typedef Results
  * @property {SiteData} siteData
  * @property {EsBuildStepResults} esbuildResults
  * @property {StaticBuildStepResult} [staticResults]
+ * @property {CopyBuildStepResult} [copyResults]
  * @property {PageBuildStepResult} [pageBuildResults]
  * @property {BuildStepWarnings} warnings
  */
@@ -112,11 +115,13 @@ export async function builder (src, dest, opts) {
   const [
     esbuildResults,
     staticResults,
+    copyResults,
   ] = await Promise.all([
     buildEsbuild(src, dest, siteData, opts),
     opts.static
       ? buildStatic(src, dest, siteData, opts)
       : Promise.resolve(),
+    buildCopy(src, dest, siteData, opts),
   ])
 
   /** @type {Results} */
@@ -135,6 +140,10 @@ export async function builder (src, dest, opts) {
     results.staticResults = staticResults
   }
 
+  errors.push(...copyResults.errors)
+  warnings.push(...copyResults.warnings)
+  results.copyResults = copyResults
+
   if (errors.length > 0) {
     const preBuildError = new TopBunAggregateError(errors, 'Prebuild finished but there were errors.', results)
     throw preBuildError

lib/build-copy/index.js

@@ -8,7 +8,7 @@
  *  'TOP_BUN_WARNING_UNKNOWN_PAGE_BUILDER' |
  *  'TOP_BUN_WARNING_DUPLICATE_GLOBAL_STYLE' |
  *  'TOP_BUN_WARNING_DUPLICATE_GLOBAL_CLIENT' |
- *  'TOP_BUN_WARNING_DUPLICATE_ESBUILD_SETINGS' |
+ *  'TOP_BUN_WARNING_DUPLICATE_ESBUILD_SETTINGS' |
  * 'TOP_BUN_WARNING_DUPLICATE_GLOBAL_VARS'
  *  } TopBunWarningCode
  */

lib/build-copy/index.test.js

@@ -84,7 +84,7 @@ const shaper = ({
  * @typedef TemplateInfo
  * @property {WalkerFile} templateFile - The template file info.
  * @property {string} path - The the path of the parent dir of the template
- * @property {string} outputName - The derived output name of the template file. Might be overriden.
+ * @property {string} outputName - The derived output name of the template file. Might be overridden.
  */
 
 /**
@@ -296,12 +296,12 @@ export async function identifyPages (src, opts = {}) {
       if (templateSuffixs.some(suffix => fileName.endsWith(suffix))) {
         const suffix = templateSuffixs.find(suffix => fileName.endsWith(suffix))
         if (!suffix) throw new Error('template suffix not found')
-        const temlateFileName = fileName.slice(0, -suffix.length)
+        const templateFileName = fileName.slice(0, -suffix.length)
 
         templates.push({
           templateFile: fileInfo,
           path: dir,
-          outputName: temlateFileName,
+          outputName: templateFileName,
         })
       }
 
@@ -341,7 +341,7 @@ export async function identifyPages (src, opts = {}) {
       if (esbuildSettingsNames.some(name => basename(fileName) === name)) {
         if (esbuildSettings) {
           warnings.push({
-            code: 'TOP_BUN_WARNING_DUPLICATE_ESBUILD_SETINGS',
+            code: 'TOP_BUN_WARNING_DUPLICATE_ESBUILD_SETTINGS',
             message: `Skipping ${fileInfo.relname}. Duplicate esbuild options ${fileName} to ${esbuildSettings.filepath}`,
           })
         } else {