@tanstack/cta-engine 0.15.2 → 0.15.4

package/dist/constants.js

@@ -1,3 +1 @@
-export const CODE_ROUTER = 'code-router';
-export const FILE_ROUTER = 'file-router';
 export const CONFIG_FILE = '.cta.json';

package/dist/create-app.js

@@ -171,7 +171,7 @@ Use the following commands to start your app:
 % cd ${options.projectName}
 % ${formatCommand(getPackageManagerScriptCommand(options.packageManager, ['dev']))}
 
-Please check the README.md for more information on testing, styling, adding routes, etc.${errorStatement}`);
+Please read the README.md for information on testing, styling, adding routes, etc.${errorStatement}`);
 }
 export async function createApp(environment, options) {
     environment.startRun();

package/dist/custom-add-ons/add-on.js

@@ -61,8 +61,8 @@ export default (parentRoute: RootRoute) => createRoute({
 }
 export async function validateAddOnSetup(environment) {
     const options = await readCurrentProjectOptions(environment);
-    if (options.mode !== 'file-router') {
-        environment.error('This project is not using file-router mode.', 'To create an add-on, the project must be created with the file-router mode.');
+    if (options.mode === 'code-router') {
+        environment.error('This project is using code-router mode.', 'To create an add-on, the project must not use code-router mode.');
         process.exit(1);
     }
     if (!options.tailwind) {

package/dist/frameworks.js

@@ -2,9 +2,28 @@ import { existsSync, readFileSync, readdirSync } from 'node:fs';
 import { resolve } from 'node:path';
 import { findFilesRecursively, isDirectory, readFileHelper, } from './file-helpers.js';
 const frameworks = [];
-function getAddOns(framework) {
+export function scanProjectDirectory(projectDirectory, baseDirectory) {
+    const absolutePaths = {};
+    findFilesRecursively(baseDirectory, absolutePaths);
+    const files = Object.keys(absolutePaths).reduce((acc, path) => {
+        acc[path.replace(baseDirectory, '.')] = absolutePaths[path];
+        return acc;
+    }, {});
+    const basePackageJSON = existsSync(resolve(baseDirectory, 'package.json'))
+        ? JSON.parse(readFileSync(resolve(baseDirectory, 'package.json'), 'utf8'))
+        : {};
+    const optionalPackages = existsSync(resolve(projectDirectory, 'packages.json'))
+        ? JSON.parse(readFileSync(resolve(projectDirectory, 'packages.json'), 'utf8'))
+        : {};
+    return {
+        files,
+        basePackageJSON,
+        optionalPackages,
+    };
+}
+export function scanAddOnDirectories(addOnsDirectories) {
     const addOns = [];
-    for (const addOnsBase of framework.addOnsDirectories) {
+    for (const addOnsBase of addOnsDirectories) {
         for (const dir of readdirSync(addOnsBase).filter((file) => isDirectory(resolve(addOnsBase, file)))) {
             const filePath = resolve(addOnsBase, dir, 'info.json');
             const fileContent = readFileSync(filePath, 'utf-8');
@@ -58,25 +77,16 @@ export function __testClearFrameworks() {
     frameworks.length = 0;
 }
 export function registerFramework(framework) {
-    const baseAssetsDirectory = resolve(framework.baseDirectory, 'base');
-    const basePackageJSON = JSON.parse(readFileSync(resolve(baseAssetsDirectory, 'package.json'), 'utf8'));
-    const optionalPackages = JSON.parse(readFileSync(resolve(framework.baseDirectory, 'packages.json'), 'utf8'));
-    const addOns = getAddOns(framework);
+    const { addOns, base, ...rest } = framework;
     const frameworkWithBundler = {
-        ...framework,
-        getFiles: () => {
-            const files = {};
-            findFilesRecursively(baseAssetsDirectory, files);
-            return Promise.resolve(Object.keys(files).map((path) => path.replace(baseAssetsDirectory, '.')));
-        },
+        ...rest,
+        getFiles: () => Promise.resolve(Object.keys(base)),
         getFileContents: (path) => {
-            return Promise.resolve(readFileHelper(resolve(baseAssetsDirectory, path)));
+            return Promise.resolve(base[path]);
         },
         getDeletedFiles: () => {
             return Promise.resolve([]);
         },
-        basePackageJSON,
-        optionalPackages,
         getAddOns: () => addOns,
     };
     frameworks.push(frameworkWithBundler);

package/dist/index.js

@@ -4,9 +4,9 @@ export { finalizeAddOns, getAllAddOns } from './add-ons.js';
 export { loadRemoteAddOn } from './custom-add-ons/add-on.js';
 export { loadStarter } from './custom-add-ons/starter.js';
 export { createMemoryEnvironment, createDefaultEnvironment, } from './environment.js';
-export { CODE_ROUTER, CONFIG_FILE, FILE_ROUTER } from './constants.js';
+export { CONFIG_FILE } from './constants.js';
 export { DEFAULT_PACKAGE_MANAGER, SUPPORTED_PACKAGE_MANAGERS, getPackageManager, } from './package-manager.js';
-export { registerFramework, getFrameworkById, getFrameworkByName, getFrameworks, } from './frameworks.js';
+export { registerFramework, getFrameworkById, getFrameworkByName, getFrameworks, scanProjectDirectory, scanAddOnDirectories, } from './frameworks.js';
 export { writeConfigFileToEnvironment, readConfigFileFromEnvironment, readConfigFile, } from './config-file.js';
 export { cleanUpFiles, cleanUpFileArray, readFileHelper, getBinaryFile, recursivelyGatherFiles, relativePath, } from './file-helpers.js';
 export { formatCommand, handleSpecialURL } from './utils.js';

package/dist/package-json.js

@@ -1,4 +1,3 @@
-import { FILE_ROUTER } from './constants.js';
 import { sortObject } from './utils.js';
 export function mergePackageJSON(packageJSON, overlayPackageJSON) {
     return {
@@ -29,9 +28,7 @@ export function createPackageJSON(options) {
         options.tailwind
             ? options.framework.optionalPackages.tailwindcss
             : undefined,
-        options.mode === FILE_ROUTER
-            ? options.framework.optionalPackages['file-router']
-            : undefined,
+        options.mode ? options.framework.optionalPackages[options.mode] : undefined,
     ];
     for (const addition of additions.filter(Boolean)) {
         packageJSON = mergePackageJSON(packageJSON, addition);

package/dist/registry.js

@@ -9,7 +9,7 @@ const registrySchema = z.object({
         description: z.string(),
         url: z.string(),
         banner: z.string().optional(),
-        mode: z.enum(['code-router', 'file-router']),
+        mode: z.string(),
         framework: z.string(),
     }))
         .optional(),
@@ -18,7 +18,7 @@ const registrySchema = z.object({
         name: z.string(),
         description: z.string(),
         url: z.string(),
-        modes: z.array(z.enum(['code-router', 'file-router'])),
+        modes: z.array(z.string()),
         framework: z.string(),
     }))
         .optional(),

package/dist/template-file.js

@@ -1,7 +1,6 @@
 import { resolve, sep } from 'node:path';
 import { render } from 'ejs';
 import { format } from 'prettier';
-import { CODE_ROUTER, FILE_ROUTER } from './constants.js';
 import { formatCommand } from './utils.js';
 import { getPackageManagerInstallCommand, getPackageManagerScriptCommand, } from './package-manager.js';
 import { relativePath } from './file-helpers.js';
@@ -53,8 +52,8 @@ export function createTemplateFile(environment, options) {
             tailwind: options.tailwind,
             js: options.typescript ? 'ts' : 'js',
             jsx: options.typescript ? 'tsx' : 'jsx',
-            fileRouter: options.mode === FILE_ROUTER,
-            codeRouter: options.mode === CODE_ROUTER,
+            fileRouter: options.mode === 'file-router',
+            codeRouter: options.mode === 'code-router',
             addOnEnabled,
             addOns: options.chosenAddOns,
             integrations,

package/dist/types/add-ons.d.ts

@@ -1,3 +1,3 @@
-import type { AddOn, Framework, Mode } from './types.js';
-export declare function getAllAddOns(framework: Framework, mode: Mode): Array<AddOn>;
-export declare function finalizeAddOns(framework: Framework, mode: Mode, chosenAddOnIDs: Array<string>): Promise<Array<AddOn>>;
+import type { AddOn, Framework } from './types.js';
+export declare function getAllAddOns(framework: Framework, mode: string): Array<AddOn>;
+export declare function finalizeAddOns(framework: Framework, mode: string, chosenAddOnIDs: Array<string>): Promise<Array<AddOn>>;

package/dist/types/constants.d.ts

@@ -1,3 +1 @@
-export declare const CODE_ROUTER = "code-router";
-export declare const FILE_ROUTER = "file-router";
 export declare const CONFIG_FILE = ".cta.json";

package/dist/types/frameworks.d.ts

@@ -1,4 +1,10 @@
-import type { Framework, FrameworkDefinition } from './types.js';
+import type { AddOn, Framework, FrameworkDefinition } from './types.js';
+export declare function scanProjectDirectory(projectDirectory: string, baseDirectory: string): {
+    files: Record<string, string>;
+    basePackageJSON: any;
+    optionalPackages: any;
+};
+export declare function scanAddOnDirectories(addOnsDirectories: Array<string>): AddOn[];
 export declare function __testRegisterFramework(framework: Framework): void;
 export declare function __testClearFrameworks(): void;
 export declare function registerFramework(framework: FrameworkDefinition): void;

package/dist/types/index.d.ts

@@ -4,9 +4,9 @@ export { finalizeAddOns, getAllAddOns } from './add-ons.js';
 export { loadRemoteAddOn } from './custom-add-ons/add-on.js';
 export { loadStarter } from './custom-add-ons/starter.js';
 export { createMemoryEnvironment, createDefaultEnvironment, } from './environment.js';
-export { CODE_ROUTER, CONFIG_FILE, FILE_ROUTER } from './constants.js';
+export { CONFIG_FILE } from './constants.js';
 export { DEFAULT_PACKAGE_MANAGER, SUPPORTED_PACKAGE_MANAGERS, getPackageManager, } from './package-manager.js';
-export { registerFramework, getFrameworkById, getFrameworkByName, getFrameworks, } from './frameworks.js';
+export { registerFramework, getFrameworkById, getFrameworkByName, getFrameworks, scanProjectDirectory, scanAddOnDirectories, } from './frameworks.js';
 export { writeConfigFileToEnvironment, readConfigFileFromEnvironment, readConfigFile, } from './config-file.js';
 export { cleanUpFiles, cleanUpFileArray, readFileHelper, getBinaryFile, recursivelyGatherFiles, relativePath, } from './file-helpers.js';
 export { formatCommand, handleSpecialURL } from './utils.js';
@@ -16,6 +16,6 @@ export { createAppOptionsFromPersisted, createSerializedOptionsFromPersisted, }
 export { createSerializedOptions } from './options.js';
 export { getRawRegistry, getRegistry, getRegistryAddOns, getRegistryStarters, } from './registry.js';
 export { StarterCompiledSchema, StatusEvent, StatusStepType, StopEvent, AddOnCompiledSchema, AddOnInfoSchema, IntegrationSchema, } from './types.js';
-export type { AddOn, Environment, FileBundleHandler, Framework, FrameworkDefinition, Mode, Options, SerializedOptions, Starter, StarterCompiled, } from './types.js';
+export type { AddOn, Environment, FileBundleHandler, Framework, FrameworkDefinition, Options, SerializedOptions, Starter, StarterCompiled, } from './types.js';
 export type { PersistedOptions } from './config-file.js';
 export type { PackageManager } from './package-manager.js';

package/dist/types/registry.d.ts

@@ -6,41 +6,41 @@ declare const registrySchema: z.ZodObject<{
         description: z.ZodString;
         url: z.ZodString;
         banner: z.ZodOptional<z.ZodString>;
-        mode: z.ZodEnum<["code-router", "file-router"]>;
+        mode: z.ZodString;
         framework: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         name: string;
         description: string;
         url: string;
         framework: string;
-        mode: "code-router" | "file-router";
+        mode: string;
         banner?: string | undefined;
     }, {
         name: string;
         description: string;
         url: string;
         framework: string;
-        mode: "code-router" | "file-router";
+        mode: string;
         banner?: string | undefined;
     }>, "many">>;
     'add-ons': z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         description: z.ZodString;
         url: z.ZodString;
-        modes: z.ZodArray<z.ZodEnum<["code-router", "file-router"]>, "many">;
+        modes: z.ZodArray<z.ZodString, "many">;
         framework: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         name: string;
         description: string;
         url: string;
         framework: string;
-        modes: ("code-router" | "file-router")[];
+        modes: string[];
     }, {
         name: string;
         description: string;
         url: string;
         framework: string;
-        modes: ("code-router" | "file-router")[];
+        modes: string[];
     }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     starters?: {
@@ -48,7 +48,7 @@ declare const registrySchema: z.ZodObject<{
         description: string;
         url: string;
         framework: string;
-        mode: "code-router" | "file-router";
+        mode: string;
         banner?: string | undefined;
     }[] | undefined;
     'add-ons'?: {
@@ -56,7 +56,7 @@ declare const registrySchema: z.ZodObject<{
         description: string;
         url: string;
         framework: string;
-        modes: ("code-router" | "file-router")[];
+        modes: string[];
     }[] | undefined;
 }, {
     starters?: {
@@ -64,7 +64,7 @@ declare const registrySchema: z.ZodObject<{
         description: string;
         url: string;
         framework: string;
-        mode: "code-router" | "file-router";
+        mode: string;
         banner?: string | undefined;
     }[] | undefined;
     'add-ons'?: {
@@ -72,7 +72,7 @@ declare const registrySchema: z.ZodObject<{
         description: string;
         url: string;
         framework: string;
-        modes: ("code-router" | "file-router")[];
+        modes: string[];
     }[] | undefined;
 }>;
 export type Registry = z.infer<typeof registrySchema>;

package/dist/types/types.d.ts

@@ -1,7 +1,5 @@
 import z from 'zod';
-import type { CODE_ROUTER, FILE_ROUTER } from './constants.js';
 import type { PackageManager } from './package-manager.js';
-export type Mode = typeof CODE_ROUTER | typeof FILE_ROUTER;
 export type StatusStepType = 'file' | 'command' | 'info' | 'package-manager' | 'other';
 export declare const AddOnBaseSchema: z.ZodObject<{
     id: z.ZodString;
@@ -736,20 +734,24 @@ export type FrameworkDefinition = {
     name: string;
     description: string;
     version: string;
-    baseDirectory: string;
-    addOnsDirectories: Array<string>;
-    examplesDirectory: string;
-};
-export type Framework = FrameworkDefinition & FileBundleHandler & {
+    base: Record<string, string>;
+    addOns: Array<AddOn>;
     basePackageJSON: Record<string, any>;
     optionalPackages: Record<string, any>;
+    supportedModes: Record<string, {
+        displayName: string;
+        description: string;
+        forceTypescript: boolean;
+    }>;
+};
+export type Framework = Omit<FrameworkDefinition, 'base' | 'addOns'> & FileBundleHandler & {
     getAddOns: () => Array<AddOn>;
 };
 export interface Options {
     projectName: string;
     targetDir: string;
     framework: Framework;
-    mode: Mode;
+    mode: string;
     typescript: boolean;
     tailwind: boolean;
     packageManager: PackageManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/cta-engine",
-  "version": "0.15.2",
+  "version": "0.15.4",
   "description": "Tanstack Application Builder Engine",
   "type": "module",
   "main": "./dist/index.js",

package/src/add-ons.ts

@@ -1,15 +1,15 @@
 import { loadRemoteAddOn } from './custom-add-ons/add-on.js'
 
-import type { AddOn, Framework, Mode } from './types.js'
+import type { AddOn, Framework } from './types.js'
 
-export function getAllAddOns(framework: Framework, mode: Mode): Array<AddOn> {
+export function getAllAddOns(framework: Framework, mode: string): Array<AddOn> {
   return framework.getAddOns().filter((a) => a.modes.includes(mode))
 }
 
 // Turn the list of chosen add-on IDs into a final list of add-ons by resolving dependencies
 export async function finalizeAddOns(
   framework: Framework,
-  mode: Mode,
+  mode: string,
   chosenAddOnIDs: Array<string>,
 ): Promise<Array<AddOn>> {
   const finalAddOnIDs = new Set(chosenAddOnIDs)

package/src/add-to-app.ts

@@ -19,7 +19,7 @@ import { mergePackageJSON } from './package-json.js'
 import { runSpecialSteps } from './special-steps/index.js'
 import { loadStarter } from './custom-add-ons/starter.js'
 
-import type { Environment, Mode, Options } from './types.js'
+import type { Environment, Options } from './types.js'
 import type { PersistedOptions } from './config-file.js'
 
 export async function hasPendingGitChanges(
@@ -48,7 +48,7 @@ async function createOptions(
     framework,
     tailwind: true,
     addOns: true,
-    chosenAddOns: await finalizeAddOns(framework!, json.mode as Mode, [
+    chosenAddOns: await finalizeAddOns(framework!, json.mode!, [
       ...json.chosenAddOns,
       ...addOns,
     ]),

package/src/constants.ts

@@ -1,4 +1 @@
-export const CODE_ROUTER = 'code-router'
-export const FILE_ROUTER = 'file-router'
-
 export const CONFIG_FILE = '.cta.json'

package/src/create-app.ts

@@ -233,7 +233,7 @@ Use the following commands to start your app:
       getPackageManagerScriptCommand(options.packageManager, ['dev']),
     )}
 
-Please check the README.md for more information on testing, styling, adding routes, etc.${errorStatement}`,
+Please read the README.md for information on testing, styling, adding routes, etc.${errorStatement}`,
   )
 }
 

package/src/custom-add-ons/add-on.ts

@@ -100,10 +100,10 @@ export default (parentRoute: RootRoute) => createRoute({
 export async function validateAddOnSetup(environment: Environment) {
   const options = await readCurrentProjectOptions(environment)
 
-  if (options.mode !== 'file-router') {
+  if (options.mode === 'code-router') {
     environment.error(
-      'This project is not using file-router mode.',
-      'To create an add-on, the project must be created with the file-router mode.',
+      'This project is using code-router mode.',
+      'To create an add-on, the project must not use code-router mode.',
     )
     process.exit(1)
   }

package/src/custom-add-ons/shared.ts

@@ -8,7 +8,7 @@ import { readConfigFileFromEnvironment } from '../config-file.js'
 import { readFileHelper } from '../file-helpers.js'
 import { loadStarter } from '../custom-add-ons/starter.js'
 
-import type { Environment, Mode, Options, SerializedOptions } from '../types.js'
+import type { Environment, Options, SerializedOptions } from '../types.js'
 import type { PersistedOptions } from '../config-file.js'
 
 export function createPackageAdditions(
@@ -68,7 +68,7 @@ export async function createAppOptionsFromPersisted(
   const framework = getFrameworkById(rest.framework)
   return {
     ...rest,
-    mode: json.mode as Mode,
+    mode: json.mode!,
     projectName: json.projectName!,
     typescript: json.typescript!,
     tailwind: json.tailwind!,
@@ -77,7 +77,7 @@ export async function createAppOptionsFromPersisted(
     targetDir: '',
     framework: framework!,
     starter: json.starter ? await loadStarter(json.starter) : undefined,
-    chosenAddOns: await finalizeAddOns(framework!, json.mode as Mode, [
+    chosenAddOns: await finalizeAddOns(framework!, json.mode!, [
       ...json.chosenAddOns,
     ]),
   }
@@ -91,7 +91,7 @@ export function createSerializedOptionsFromPersisted(
   /* eslint-enable unused-imports/no-unused-vars */
   return {
     ...rest,
-    mode: json.mode as Mode,
+    mode: json.mode!,
     projectName: json.projectName!,
     typescript: json.typescript!,
     tailwind: json.tailwind!,

package/src/frameworks.ts

@@ -11,10 +11,44 @@ import type { AddOn, Framework, FrameworkDefinition } from './types.js'
 
 const frameworks: Array<Framework> = []
 
-function getAddOns(framework: FrameworkDefinition) {
+export function scanProjectDirectory(
+  projectDirectory: string,
+  baseDirectory: string,
+) {
+  const absolutePaths: Record<string, string> = {}
+  findFilesRecursively(baseDirectory, absolutePaths)
+
+  const files = Object.keys(absolutePaths).reduce(
+    (acc, path) => {
+      acc[path.replace(baseDirectory, '.')] = absolutePaths[path]
+      return acc
+    },
+    {} as Record<string, string>,
+  )
+
+  const basePackageJSON = existsSync(resolve(baseDirectory, 'package.json'))
+    ? JSON.parse(readFileSync(resolve(baseDirectory, 'package.json'), 'utf8'))
+    : {}
+
+  const optionalPackages = existsSync(
+    resolve(projectDirectory, 'packages.json'),
+  )
+    ? JSON.parse(
+        readFileSync(resolve(projectDirectory, 'packages.json'), 'utf8'),
+      )
+    : {}
+
+  return {
+    files,
+    basePackageJSON,
+    optionalPackages,
+  }
+}
+
+export function scanAddOnDirectories(addOnsDirectories: Array<string>) {
   const addOns: Array<AddOn> = []
 
-  for (const addOnsBase of framework.addOnsDirectories) {
+  for (const addOnsBase of addOnsDirectories) {
     for (const dir of readdirSync(addOnsBase).filter((file) =>
       isDirectory(resolve(addOnsBase, file)),
     )) {
@@ -85,36 +119,17 @@ export function __testClearFrameworks() {
 }
 
 export function registerFramework(framework: FrameworkDefinition) {
-  const baseAssetsDirectory = resolve(framework.baseDirectory, 'base')
-
-  const basePackageJSON = JSON.parse(
-    readFileSync(resolve(baseAssetsDirectory, 'package.json'), 'utf8'),
-  )
-  const optionalPackages = JSON.parse(
-    readFileSync(resolve(framework.baseDirectory, 'packages.json'), 'utf8'),
-  )
-
-  const addOns = getAddOns(framework)
+  const { addOns, base, ...rest } = framework
 
   const frameworkWithBundler: Framework = {
-    ...framework,
-    getFiles: () => {
-      const files: Record<string, string> = {}
-      findFilesRecursively(baseAssetsDirectory, files)
-      return Promise.resolve(
-        Object.keys(files).map((path) =>
-          path.replace(baseAssetsDirectory, '.'),
-        ),
-      )
-    },
+    ...rest,
+    getFiles: () => Promise.resolve(Object.keys(base)),
     getFileContents: (path: string) => {
-      return Promise.resolve(readFileHelper(resolve(baseAssetsDirectory, path)))
+      return Promise.resolve(base[path])
     },
     getDeletedFiles: () => {
       return Promise.resolve([])
     },
-    basePackageJSON,
-    optionalPackages,
     getAddOns: () => addOns,
   }
 

package/src/index.ts

@@ -11,7 +11,7 @@ export {
   createDefaultEnvironment,
 } from './environment.js'
 
-export { CODE_ROUTER, CONFIG_FILE, FILE_ROUTER } from './constants.js'
+export { CONFIG_FILE } from './constants.js'
 
 export {
   DEFAULT_PACKAGE_MANAGER,
@@ -24,6 +24,8 @@ export {
   getFrameworkById,
   getFrameworkByName,
   getFrameworks,
+  scanProjectDirectory,
+  scanAddOnDirectories,
 } from './frameworks.js'
 
 export {
@@ -75,7 +77,6 @@ export type {
   FileBundleHandler,
   Framework,
   FrameworkDefinition,
-  Mode,
   Options,
   SerializedOptions,
   Starter,

package/src/package-json.ts

@@ -1,4 +1,3 @@
-import { FILE_ROUTER } from './constants.js'
 import { sortObject } from './utils.js'
 
 import type { Options } from './types.js'
@@ -37,9 +36,7 @@ export function createPackageJSON(options: Options) {
     options.tailwind
       ? options.framework.optionalPackages.tailwindcss
       : undefined,
-    options.mode === FILE_ROUTER
-      ? options.framework.optionalPackages['file-router']
-      : undefined,
+    options.mode ? options.framework.optionalPackages[options.mode] : undefined,
   ]
   for (const addition of additions.filter(Boolean)) {
     packageJSON = mergePackageJSON(packageJSON, addition)

package/src/registry.ts

@@ -13,7 +13,7 @@ const registrySchema = z.object({
         description: z.string(),
         url: z.string(),
         banner: z.string().optional(),
-        mode: z.enum(['code-router', 'file-router']),
+        mode: z.string(),
         framework: z.string(),
       }),
     )
@@ -24,7 +24,7 @@ const registrySchema = z.object({
         name: z.string(),
         description: z.string(),
         url: z.string(),
-        modes: z.array(z.enum(['code-router', 'file-router'])),
+        modes: z.array(z.string()),
         framework: z.string(),
       }),
     )

package/src/template-file.ts

@@ -2,7 +2,6 @@ import { resolve, sep } from 'node:path'
 import { render } from 'ejs'
 import { format } from 'prettier'
 
-import { CODE_ROUTER, FILE_ROUTER } from './constants.js'
 import { formatCommand } from './utils.js'
 import {
   getPackageManagerInstallCommand,
@@ -83,8 +82,8 @@ export function createTemplateFile(environment: Environment, options: Options) {
       tailwind: options.tailwind,
       js: options.typescript ? 'ts' : 'js',
       jsx: options.typescript ? 'tsx' : 'jsx',
-      fileRouter: options.mode === FILE_ROUTER,
-      codeRouter: options.mode === CODE_ROUTER,
+      fileRouter: options.mode === 'file-router',
+      codeRouter: options.mode === 'code-router',
       addOnEnabled,
       addOns: options.chosenAddOns,
       integrations,

package/src/types.ts

@@ -1,10 +1,7 @@
 import z from 'zod'
 
-import type { CODE_ROUTER, FILE_ROUTER } from './constants.js'
 import type { PackageManager } from './package-manager.js'
 
-export type Mode = typeof CODE_ROUTER | typeof FILE_ROUTER
-
 export type StatusStepType =
   | 'file'
   | 'command'
@@ -112,16 +109,23 @@ export type FrameworkDefinition = {
   description: string
   version: string
 
-  baseDirectory: string
-  addOnsDirectories: Array<string>
-  examplesDirectory: string
+  base: Record<string, string>
+  addOns: Array<AddOn>
+  basePackageJSON: Record<string, any>
+  optionalPackages: Record<string, any>
+
+  supportedModes: Record<
+    string,
+    {
+      displayName: string
+      description: string
+      forceTypescript: boolean
+    }
+  >
 }
 
-export type Framework = FrameworkDefinition &
+export type Framework = Omit<FrameworkDefinition, 'base' | 'addOns'> &
   FileBundleHandler & {
-    basePackageJSON: Record<string, any>
-    optionalPackages: Record<string, any>
-
     getAddOns: () => Array<AddOn>
   }
 
@@ -130,7 +134,7 @@ export interface Options {
   targetDir: string
 
   framework: Framework
-  mode: Mode
+  mode: string
 
   typescript: boolean
   tailwind: boolean

package/tests/add-to-app.test.ts

@@ -50,7 +50,6 @@ beforeEach(() => {
     version: '1.0.0',
     baseDirectory: '/foo',
     addOnsDirectories: [],
-    examplesDirectory: '',
     basePackageJSON: {},
     optionalPackages: {},
     getAddOns: () => [

package/tests/custom-add-ons/shared.test.ts

@@ -38,9 +38,18 @@ beforeEach(() => {
     version: '1.0.0',
     baseDirectory: '/foo',
     addOnsDirectories: [],
-    examplesDirectory: '',
     basePackageJSON: {},
     optionalPackages: {},
+    supportedModes: {
+      'code-router': {
+        displayName: 'Code Router',
+        description: 'Code Router',
+      },
+      'file-router': {
+        displayName: 'File Router',
+        description: 'File Router',
+      },
+    },
     getAddOns: () => [
       {
         id: 'test',

package/tests/frameworks.test.ts

@@ -6,6 +6,8 @@ import {
   getFrameworkById,
   getFrameworkByName,
   registerFramework,
+  scanAddOnDirectories,
+  scanProjectDirectory,
 } from '../src/frameworks.js'
 
 vi.mock('node:fs', () => fs)
@@ -28,50 +30,24 @@ describe('registerFramework', () => {
       version: '1.0.0',
     }
 
-    vol.mkdirSync('/test/add-ons/test/assets', { recursive: true })
-    vol.writeFileSync(
-      '/test/add-ons/test/info.json',
-      JSON.stringify({
-        id: 'test',
-        name: 'Test',
-        description: 'Test',
-        version: '1.0.0',
-      }),
-    )
-    vol.writeFileSync(
-      '/test/add-ons/test/package.json',
-      JSON.stringify({
-        id: 'test',
-        name: 'Test',
-        description: 'Test',
-        version: '1.0.0',
-      }),
-    )
-    vol.writeFileSync(
-      '/test/add-ons/test/assets/package.json',
-      JSON.stringify(addOnPackageJSON),
-    )
-    vol.writeFileSync('/test/add-ons/test/README.md', 'foo')
-    vol.mkdirSync('/test/project/base/assets', { recursive: true })
-    vol.writeFileSync(
-      '/test/project/base/package.json',
-      JSON.stringify(basePackageJSON),
-    )
-    vol.writeFileSync(
-      '/test/project/packages.json',
-      JSON.stringify({
-        typescript: {},
-      }),
-    )
-
     registerFramework({
       id: 'test',
       name: 'Test',
-      addOnsDirectories: ['/test/add-ons'],
+      addOns: [],
       description: 'Test',
       version: '1.0.0',
-      baseDirectory: '/test/project',
-      examplesDirectory: '/test/examples',
+      base: {
+        './package.json': JSON.stringify(basePackageJSON),
+      },
+      basePackageJSON,
+      optionalPackages: {},
+      supportedModes: {
+        'code-router': {
+          displayName: 'Code Router',
+          description: 'Code Router',
+          forceTypescript: false,
+        },
+      },
     })
 
     const f = getFrameworkById('test')!
@@ -82,13 +58,6 @@ describe('registerFramework', () => {
     const fileContents = await f.getFileContents('./package.json')
     expect(fileContents).toEqual(JSON.stringify(basePackageJSON))
 
-    const addOns = await f.getAddOns()
-    const addOnFiles = await addOns[0].getFiles()
-    expect(addOnFiles).toEqual(['./package.json'])
-
-    const addOnFileContents = await addOns[0].getFileContents('./package.json')
-    expect(addOnFileContents).toEqual(JSON.stringify(addOnPackageJSON))
-
     expect(getFrameworkByName('Test')).not.toBeUndefined()
     expect(getFrameworks().length).toEqual(1)
   })

package/tests/package-json.test.ts

@@ -1,7 +1,6 @@
 import { describe, expect, it } from 'vitest'
 
 import { createPackageJSON } from '../src/package-json.js'
-import { FILE_ROUTER } from '../src/constants.js'
 
 import type { Options, Framework } from '../src/types.js'
 
@@ -17,7 +16,7 @@ describe('createPackageJSON', () => {
           },
         },
       ],
-      mode: FILE_ROUTER,
+      mode: 'file-router',
       typescript: true,
       tailwind: true,
       projectName: 'test',