create-lacspace-app 2.2.1 → 2.3.0

package/dist/lib.d.cts

@@ -7,6 +7,39 @@ interface TemplateDef {
     siteName: string;
     siteDescription: string;
 }
+/**
+ * A composable, optional feature add-on (see {@link FEATURES}).
+ *
+ * A feature is a small, self-contained bundle you can layer onto **any**
+ * template: extra files (namespaced under its own routes), npm dependencies,
+ * `package.json` scripts, `.env.example` entries and onboarding next-steps.
+ * Features are order-independent and never collide with the base scaffold.
+ */
+interface FeatureDef {
+    /** Stable key (used by `--with <key>` and `add <key>`). */
+    key: string;
+    /** Short human label. */
+    label: string;
+    /** One-line description (shown in the interactive picker & `--help`). */
+    description: string;
+    /** npm dependencies this feature adds, merged into `package.json`. */
+    deps: Record<string, string>;
+    /** The files this feature drops in, given the resolved {@link Ctx}. */
+    files: (ctx: Ctx) => Record<string, string>;
+    /** Optional `.env.example` entries — `NAME: "explanatory comment"`. */
+    env?: Record<string, string>;
+    /** Optional `package.json` scripts, merged in. */
+    scripts?: Record<string, string>;
+    /** Onboarding steps appended to the terminal output and `LEARN.md`. */
+    nextSteps: string[];
+    /** Optional "learn more" URL for `LEARN.md`. */
+    learn?: string;
+}
+interface Ctx {
+    name: string;
+    template: TemplateDef;
+    features: FeatureDef[];
+}
 /** Options accepted by the programmatic API (see `./lib`). */
 interface GenerateOptions {
     /** Project name — becomes the folder name and the default site name slug. Default `"my-app"`. */
@@ -15,6 +48,13 @@ interface GenerateOptions {
     template?: string;
     /** Accent theme: a preset name, a `#hex`, or a `from,to` pair. Falls back to the template's default accent. */
     theme?: string;
+    /**
+     * Optional composable feature add-ons (see {@link FEATURES}) — e.g.
+     * `["ai-chat", "rag"]`. Unknown keys are ignored; duplicates are de-duped.
+     * Purely additive: an empty (or omitted) list generates today's scaffold
+     * byte-for-byte.
+     */
+    features?: string[];
 }
 
 /** A project file map: relative path → file contents. */
@@ -34,6 +74,14 @@ declare function listSections(): string[];
  * `add <name>` would drop into `components/sections/`), or `undefined`.
  */
 declare function getSection(name: string): string | undefined;
+/**
+ * The composable feature add-ons available (see {@link FeatureDef}) — the ones
+ * you can pass as `options.features` or request with the CLI's `--with <key>`.
+ * Returns copies, so mutating the result never affects the registry.
+ */
+declare function listFeatures(): FeatureDef[];
+/** Look up one feature add-on's definition by key, or `undefined`. */
+declare function getFeature(key: string): FeatureDef | undefined;
 /**
  * Generate a full project as an in-memory file map (relative path → contents).
  *
@@ -65,4 +113,4 @@ interface ScaffoldResult {
  */
 declare function scaffold(options?: ScaffoldOptions): Promise<ScaffoldResult>;
 
-export { type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getSection, getTemplate, listSections, listTemplates, scaffold, templateKeys, templates };
+export { type FeatureDef, type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getFeature, getSection, getTemplate, listFeatures, listSections, listTemplates, scaffold, templateKeys, templates };

package/dist/lib.d.ts

@@ -7,6 +7,39 @@ interface TemplateDef {
     siteName: string;
     siteDescription: string;
 }
+/**
+ * A composable, optional feature add-on (see {@link FEATURES}).
+ *
+ * A feature is a small, self-contained bundle you can layer onto **any**
+ * template: extra files (namespaced under its own routes), npm dependencies,
+ * `package.json` scripts, `.env.example` entries and onboarding next-steps.
+ * Features are order-independent and never collide with the base scaffold.
+ */
+interface FeatureDef {
+    /** Stable key (used by `--with <key>` and `add <key>`). */
+    key: string;
+    /** Short human label. */
+    label: string;
+    /** One-line description (shown in the interactive picker & `--help`). */
+    description: string;
+    /** npm dependencies this feature adds, merged into `package.json`. */
+    deps: Record<string, string>;
+    /** The files this feature drops in, given the resolved {@link Ctx}. */
+    files: (ctx: Ctx) => Record<string, string>;
+    /** Optional `.env.example` entries — `NAME: "explanatory comment"`. */
+    env?: Record<string, string>;
+    /** Optional `package.json` scripts, merged in. */
+    scripts?: Record<string, string>;
+    /** Onboarding steps appended to the terminal output and `LEARN.md`. */
+    nextSteps: string[];
+    /** Optional "learn more" URL for `LEARN.md`. */
+    learn?: string;
+}
+interface Ctx {
+    name: string;
+    template: TemplateDef;
+    features: FeatureDef[];
+}
 /** Options accepted by the programmatic API (see `./lib`). */
 interface GenerateOptions {
     /** Project name — becomes the folder name and the default site name slug. Default `"my-app"`. */
@@ -15,6 +48,13 @@ interface GenerateOptions {
     template?: string;
     /** Accent theme: a preset name, a `#hex`, or a `from,to` pair. Falls back to the template's default accent. */
     theme?: string;
+    /**
+     * Optional composable feature add-ons (see {@link FEATURES}) — e.g.
+     * `["ai-chat", "rag"]`. Unknown keys are ignored; duplicates are de-duped.
+     * Purely additive: an empty (or omitted) list generates today's scaffold
+     * byte-for-byte.
+     */
+    features?: string[];
 }
 
 /** A project file map: relative path → file contents. */
@@ -34,6 +74,14 @@ declare function listSections(): string[];
  * `add <name>` would drop into `components/sections/`), or `undefined`.
  */
 declare function getSection(name: string): string | undefined;
+/**
+ * The composable feature add-ons available (see {@link FeatureDef}) — the ones
+ * you can pass as `options.features` or request with the CLI's `--with <key>`.
+ * Returns copies, so mutating the result never affects the registry.
+ */
+declare function listFeatures(): FeatureDef[];
+/** Look up one feature add-on's definition by key, or `undefined`. */
+declare function getFeature(key: string): FeatureDef | undefined;
 /**
  * Generate a full project as an in-memory file map (relative path → contents).
  *
@@ -65,4 +113,4 @@ interface ScaffoldResult {
  */
 declare function scaffold(options?: ScaffoldOptions): Promise<ScaffoldResult>;
 
-export { type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getSection, getTemplate, listSections, listTemplates, scaffold, templateKeys, templates };
+export { type FeatureDef, type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getFeature, getSection, getTemplate, listFeatures, listSections, listTemplates, scaffold, templateKeys, templates };