chore: end to end working, lots to be done

Author: jherr

src/add-ons.ts

@@ -1,5 +1,5 @@
 import { readFile } from 'node:fs/promises'
-import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs'
+import { existsSync, readFileSync, readdirSync, statSync } from 'node:fs'
 import { resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import chalk from 'chalk'
@@ -103,6 +103,7 @@ export async function finalizeAddOns(
       addOn = loadAddOn(localAddOn)
     } else if (addOnID.startsWith('http')) {
       addOn = await loadRemoteAddOn(addOnID)
+      addOns.push(addOn)
     } else {
       throw new Error(`Add-on ${addOnID} not found`)
     }
@@ -116,7 +117,10 @@ export async function finalizeAddOns(
     }
   }
 
-  return [...finalAddOnIDs].map((id) => addOns.find((a) => a.id === id)!)
+  const finalAddOns = [...finalAddOnIDs].map(
+    (id) => addOns.find((a) => a.id === id)!,
+  )
+  return finalAddOns
 }
 
 export async function listAddOns(options: CliOptions) {
@@ -138,5 +142,6 @@ function loadAddOn(addOn: AddOn): AddOn {
 async function loadRemoteAddOn(url: string): Promise<AddOn> {
   const response = await fetch(url)
   const fileContent = await response.json()
-  return JSON.parse(fileContent)
+  fileContent.id = url
+  return fileContent
 }

src/create-app.ts

@@ -1,4 +1,4 @@
-import { basename, dirname, resolve } from 'node:path'
+import { basename, resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { log, outro, spinner } from '@clack/prompts'
 import { render } from 'ejs'
@@ -10,7 +10,7 @@ import { sortObject } from './utils.js'
 import { writeConfigFile } from './config-file.js'
 import { packageManagerExecute } from './package-manager.js'
 
-import type { Environment, Options } from './types.js'
+import type { AddOn, Environment, Options } from './types.js'
 
 function createCopyFiles(environment: Environment, targetDir: string) {
   return async function copyFiles(
@@ -342,6 +342,34 @@ export async function createApp(
   const isAddOnEnabled = (id: string) =>
     options.chosenAddOns.find((a) => a.id === id)
 
+  async function runAddOn(addOn: AddOn) {
+    if (addOn.files) {
+      for (const file of Object.keys(addOn.files)) {
+        await copyAddOnFile(
+          environment,
+          addOn.files[file],
+          file,
+          resolve(targetDir, file),
+          (content, targetFileName) =>
+            templateFileFromContent(targetFileName, content),
+        )
+      }
+    }
+    if (addOn.deletedFiles) {
+      for (const file of addOn.deletedFiles) {
+        await environment.deleteFile(resolve(targetDir, file))
+      }
+    }
+
+    if (addOn.command && addOn.command.command) {
+      await environment.execute(
+        addOn.command.command,
+        addOn.command.args || [],
+        resolve(targetDir),
+      )
+    }
+  }
+
   // Setup the .vscode directory
   switch (options.toolchain) {
     case 'biome':
@@ -437,33 +465,15 @@ export async function createApp(
 
   // Copy all the asset files from the addons
   const s = silent ? null : spinner()
-  for (const phase of ['setup', 'add-on', 'example']) {
-    for (const addOn of options.chosenAddOns.filter(
-      (addOn) => addOn.phase === phase,
-    )) {
-      s?.start(`Setting up ${addOn.name}...`)
-      if (addOn.files) {
-        for (const file of Object.keys(addOn.files)) {
-          await copyAddOnFile(
-            environment,
-            addOn.files[file],
-            file,
-            resolve(targetDir, file),
-            (content, targetFileName) =>
-              templateFileFromContent(targetFileName, content),
-          )
-        }
-      }
-
-      if (addOn.command) {
-        await environment.execute(
-          addOn.command.command,
-          addOn.command.args || [],
-          resolve(targetDir),
-        )
+  for (const type of ['add-on', 'example']) {
+    for (const phase of ['setup', 'add-on']) {
+      for (const addOn of options.chosenAddOns.filter(
+        (addOn) => addOn.phase === phase && addOn.type === type,
+      )) {
+        s?.start(`Setting up ${addOn.name}...`)
+        await runAddOn(addOn)
+        s?.stop(`${addOn.name} setup complete`)
       }
-
-      s?.stop(`${addOn.name} setup complete`)
     }
   }
 
@@ -654,6 +664,15 @@ export async function createApp(
   // Create the README.md
   await templateFile(templateDirBase, 'README.md.ejs')
 
+  // Adding overlays
+  for (const addOn of options.chosenAddOns.filter(
+    (addOn) => addOn.type === 'overlay',
+  )) {
+    s?.start(`Setting up overlay ${addOn.name}...`)
+    await runAddOn(addOn)
+    s?.stop(`Overlay ${addOn.name} setup complete`)
+  }
+
   // Install dependencies
   s?.start(`Installing dependencies via ${options.packageManager}...`)
   await environment.execute(

src/custom-add-on.ts

@@ -91,14 +91,14 @@ This is probably because this was created with an older version of create-tsrout
           author: 'John Doe',
           license: 'MIT',
           link: 'https://github.com/john-doe/custom-add-on',
-          commands: [],
+          command: {},
           shadcnComponents: [],
           templates: [persistedOptions.mode],
           routes: [],
           warning: '',
           variables: {},
-          type: 'example',
           phase: 'add-on',
+          type: 'overlay',
         },
         null,
         2,

src/environment.ts

@@ -3,6 +3,7 @@ import {
   copyFile,
   mkdir,
   readFile,
+  unlink,
   writeFile,
 } from 'node:fs/promises'
 import { existsSync, readdirSync, statSync } from 'node:fs'
@@ -44,6 +45,9 @@ export function createDefaultEnvironment(): Environment {
         )
       }
     },
+    deleteFile: async (path: string) => {
+      await unlink(path)
+    },
 
     readFile: (path: string, encoding?: BufferEncoding) =>
       readFile(path, { encoding: encoding || 'utf8' }),
@@ -107,6 +111,9 @@ export function createMemoryEnvironment() {
     fs.mkdirSync(dirname(path), { recursive: true })
     await fs.writeFileSync(path, contents)
   }
+  environment.deleteFile = async (path: string) => {
+    await fs.unlinkSync(path)
+  }
   environment.exists = (path: string) => {
     if (isTemplatePath(path)) {
       return existsSync(path)

src/types.ts

@@ -41,6 +41,7 @@ export type Environment = {
   copyFile: (from: string, to: string) => Promise<void>
   writeFile: (path: string, contents: string) => Promise<void>
   execute: (command: string, args: Array<string>, cwd: string) => Promise<void>
+  deleteFile: (path: string) => Promise<void>
 
   readFile: (path: string, encoding?: BufferEncoding) => Promise<string>
   exists: (path: string) => boolean
@@ -73,9 +74,9 @@ export type Variable = BooleanVariable | NumberVariable | StringVariable
 
 export type AddOn = {
   id: string
-  type: 'add-on' | 'example'
   name: string
   description: string
+  type: 'add-on' | 'example' | 'overlay'
   link: string
   templates: Array<string>
   routes: Array<{

tests/test-utilities.ts

@@ -43,6 +43,10 @@ export function createTestEnvironment(projectName: string) {
       args,
     })
   }
+  environment.deleteFile = async (path: string) => {
+    const relPath = trimProjectRelativePath(path)
+    delete output.files[relPath]
+  }
   environment.readFile = async (path: string, encoding?: BufferEncoding) => {
     if (isTemplatePath(path)) {
       return (await readFile(path, encoding)).toString()