@alloy-js/core 0.19.0-dev.12 → 0.19.0-dev.3

package/test/components/source-file.test.tsx

@@ -1,6 +1,5 @@
 import {
   computed,
-  ContentOutputFile,
   Output,
   render,
   renderTree,
@@ -51,9 +50,7 @@ it("has reactive context", () => {
     </Output>,
   );
 
-  expect((tree.contents[1] as ContentOutputFile).contents).toEqual(
-    "hi.txt contents.txt",
-  );
+  expect(tree.contents[1].contents).toEqual("hi.txt contents.txt");
 });
 
 it("Includes header", () => {
@@ -66,7 +63,7 @@ it("Includes header", () => {
     </Output>,
   );
 
-  expect((tree.contents[0] as ContentOutputFile).contents).toEqual(d`
+  expect(tree.contents[0].contents).toEqual(d`
     # This is a header
     hello!
     `);

package/test/rendering/formatting.test.tsx

@@ -1,11 +1,5 @@
 import { describe, expect, it } from "vitest";
-import {
-  ContentOutputFile,
-  For,
-  Output,
-  render,
-  SourceFile,
-} from "../../src/index.js";
+import { For, Output, render, SourceFile } from "../../src/index.js";
 import "../../testing/extend-expect.js";
 import { d } from "../../testing/render.js";
 
@@ -460,7 +454,7 @@ it("formats based on the output component props", () => {
   );
 
   const tree = render(template);
-  expect((tree.contents[0] as ContentOutputFile).contents).toEqual(d`
+  expect(tree.contents[0].contents).toEqual(d`
     1
     2
     3
@@ -482,7 +476,7 @@ it("formats based on the source file component props", () => {
   );
 
   const tree = render(template);
-  expect((tree.contents[0] as ContentOutputFile).contents).toEqual(d`
+  expect(tree.contents[0].contents).toEqual(d`
     1
     2
     3

package/testing/extend-expect.ts

@@ -7,7 +7,6 @@ import {
 } from "@alloy-js/core";
 import "vitest";
 import { expect } from "vitest";
-import { flushJobs, flushJobsAsync } from "../src/scheduler.js";
 import { dedent } from "./render.js";
 
 interface ToRenderToOptions {
@@ -22,82 +21,67 @@ expect.extend({
     expectedRaw: string | Record<string, string>,
     renderOptions?: ToRenderToOptions,
   ) {
-    const tree = renderTree(received);
-    flushJobs();
-    const actual = getFilesFromTree(tree, renderOptions);
+    const message = () => `Render is${isNot ? " not" : ""} incorrect`;
 
-    return validateRender(actual, expectedRaw, this.isNot);
-  },
-  async toRenderToAsync(
-    received: Children,
-    expectedRaw: string | Record<string, string>,
-    renderOptions?: ToRenderToOptions,
-  ) {
-    const tree = renderTree(received);
-    await flushJobsAsync();
-    const actual = getFilesFromTree(tree, renderOptions);
-    return validateRender(actual, expectedRaw, this.isNot);
-  },
-});
-
-function validateRender(
-  actual: string | Record<string, string>,
-  expectedRaw: string | Record<string, string>,
-  isNot: boolean,
-) {
-  const message = () => `Render is${isNot ? " not" : ""} incorrect`;
-
-  if (typeof expectedRaw === "string") {
-    const expected = dedent(expectedRaw);
-    let actualStr;
-    if (typeof actual === "string") {
-      actualStr = actual;
-    } else if (Object.keys(actual).length === 1) {
-      // If we have a single file, we can use its content directly.
-      actualStr = Object.values(actual)[0];
+    const { isNot } = this;
+    const actual = renderAsFiles(received, renderOptions);
+    if (typeof expectedRaw === "string") {
+      const expected = dedent(expectedRaw);
+      let actualStr;
+      if (typeof actual === "string") {
+        actualStr = actual;
+      } else if (Object.keys(actual).length === 1) {
+        // If we have a single file, we can use its content directly.
+        actualStr = Object.values(actual)[0];
+      } else {
+        return {
+          pass: false,
+          message,
+          actual,
+          expected,
+        };
+      }
+      return {
+        pass: actualStr === expected,
+        message,
+        actual: actualStr,
+        expected,
+      };
+    } else if (typeof actual === "object" && typeof expectedRaw === "object") {
+      const expected = expectedRaw;
+      const dedentExpected: Record<string, string> = {};
+      for (const [key, value] of Object.entries(expected)) {
+        dedentExpected[key] = dedent(value);
+      }
+      const pass =
+        Object.keys(actual).length === Object.keys(expected).length &&
+        Object.entries(actual).every(([key, value]) => {
+          return dedentExpected[key] === value;
+        });
+      return {
+        pass,
+        message,
+        actual,
+        expected: dedentExpected,
+      };
     } else {
       return {
         pass: false,
         message,
         actual,
-        expected,
+        expected: expectedRaw,
       };
     }
-    return {
-      pass: actualStr === expected,
-      message,
-      actual: actualStr,
-      expected,
-    };
-  } else if (typeof actual === "object" && typeof expectedRaw === "object") {
-    const expected = expectedRaw;
-    const dedentExpected: Record<string, string> = {};
-    for (const [key, value] of Object.entries(expected)) {
-      dedentExpected[key] = dedent(value);
-    }
-    const pass =
-      Object.keys(actual).length === Object.keys(expected).length &&
-      Object.entries(actual).every(([key, value]) => {
-        return dedentExpected[key] === value;
-      });
-    return {
-      pass,
-      message,
-      actual,
-      expected: dedentExpected,
-    };
-  } else {
-    return {
-      pass: false,
-      message,
-      actual,
-      expected: expectedRaw,
-    };
-  }
-}
+  },
+});
 
-function getFilesFromTree(tree: RenderedTextTree, options?: ToRenderToOptions) {
+function renderAsFiles(
+  received: Children,
+  options?: ToRenderToOptions,
+): Record<string, string> | string {
   const files: Record<string, string> = {};
+  const tree = renderTree(received);
+
   // when passing Output, the first render tree child is the Output component.
   const rootRenderOptions =
     Array.isArray(tree) ?
@@ -106,13 +90,6 @@ function getFilesFromTree(tree: RenderedTextTree, options?: ToRenderToOptions) {
     : {};
 
   collectSourceFiles(tree);
-  // If we found no source files, we return the tree as a string.
-  if (Object.keys(files).length === 0) {
-    return printTree(tree, options);
-  } else {
-    return files;
-  }
-
   function collectSourceFiles(root: RenderedTextTree) {
     if (!Array.isArray(root)) {
       return;
@@ -143,4 +120,11 @@ function getFilesFromTree(tree: RenderedTextTree, options?: ToRenderToOptions) {
       }
     }
   }
+
+  // If we found no source files, we return the tree as a string.
+  if (Object.keys(files).length === 0) {
+    return printTree(tree, options);
+  } else {
+    return files;
+  }
 }

package/testing/vitest.d.ts

@@ -11,10 +11,6 @@ interface CustomMatchers<R = unknown> {
     str: string | Record<string, string>,
     options?: ToRenderToRenderOptions,
   ) => R;
-  toRenderToAsync: (
-    str: string | Record<string, string>,
-    options?: ToRenderToRenderOptions,
-  ) => Promise<R>;
 }
 
 declare module "vitest" {

package/dist/src/components/AppendFile.d.ts

@@ -1,90 +0,0 @@
-import { Children } from "../runtime/component.js";
-export interface AppendFileProps {
-    /**
-     * The path to the file to read and append content to.
-     */
-    path: string;
-    /**
-     * List of region IDs to append to. Defaults to ["append"] if not specified.
-     * Each region corresponds to an AppendRegion child component.
-     */
-    regions?: string[];
-    /**
-     * AppendRegion children components that define content to append.
-     */
-    children?: Children;
-}
-/**
- * A component that reads a file and returns content with new content appended
- * at the end or within specific regions marked by alloy-\{region name\}-start/alloy-\{region name\}-end sigils.
- *
- * The component can append content in two ways:
- * 1. **Simple append**: Content is appended to the end of the file
- * 2. **Region-based append**: Content is appended before the end sigil on its own line
- *
- * Region sigils are line-based - any line containing "alloy-\{region name\}-start" or "alloy-\{region name\}-end"
- * is considered a sigil.
- *
- * @example
- * Simple append to end of file:
- * ```tsx
- * <AppendFile path="output.txt">
- *   <AppendRegion id="append">New content to add</AppendRegion>
- * </AppendFile>
- *
- * // Returns:
- * //   Original file content
- * //   New content to add
- * ```
- *
- * @example
- * Append to specific regions:
- * ```tsx
- * // File content before:
- * // Header content
- * // <!-- alloy-main-start -->
- * // <!-- alloy-main-end -->
- * // Footer content
- *
- * <AppendFile path="template.html" regions={["main"]}>
- *   <AppendRegion id="main">New main content</AppendRegion>
- * </AppendFile>
- *
- * // Returns:
- * //   Header content
- * //   <!-- alloy-main-start -->
- * //   New main content
- * //   <!-- alloy-main-end -->
- * //   Footer content
- * ```
- */
-export declare function AppendFile(props: AppendFileProps): Children;
-export interface AppendRegionPropsWithChildren {
-    /**
-     * The ID of the region.
-     */
-    id: string;
-    /**
-     * The content to append to the region.
-     */
-    children: Children;
-}
-export interface AppendRegionPropsWithContent {
-    /**
-     * The ID of the region.
-     */
-    id: string;
-    /**
-     * The content to append to the region.
-     */
-    content: Children;
-}
-export interface AppendRegionPropsBase {
-    /**
-     * The ID of the region.
-     */
-    id: string;
-}
-export type AppendRegionProps = AppendRegionPropsWithChildren | AppendRegionPropsWithContent | AppendRegionPropsBase;
-export declare function AppendRegion(props: AppendRegionProps): void;
-//# sourceMappingURL=AppendFile.d.ts.map

package/dist/src/components/AppendFile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AppendFile.d.ts","sourceRoot":"","sources":["../../../src/components/AppendFile.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAsB,MAAM,yBAAyB,CAAC;AAavE,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,QAAQ,CA0K3D;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,iBAAiB,GACzB,6BAA6B,GAC7B,4BAA4B,GAC5B,qBAAqB,CAAC;AAE1B,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,QAKpD"}

package/dist/src/components/AppendFile.js

@@ -1,226 +0,0 @@
-import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
-import { computed } from "@vue/reactivity";
-import { join } from "pathe";
-import { useContext } from "../context.js";
-import { SourceDirectoryContext } from "../context/source-directory.js";
-import { createFileResource } from "../resource.js";
-import { isComponentCreator } from "../runtime/component.js";
-import { childrenArray } from "../utils.js";
-import { SourceFile } from "./SourceFile.js";
-
-// Regular expression for finding all sigils at once
-const SIGIL_REGEX = /^(\s*)(.*alloy-(.+)-(start|end).*)$/gm;
-/**
- * A component that reads a file and returns content with new content appended
- * at the end or within specific regions marked by alloy-\{region name\}-start/alloy-\{region name\}-end sigils.
- *
- * The component can append content in two ways:
- * 1. **Simple append**: Content is appended to the end of the file
- * 2. **Region-based append**: Content is appended before the end sigil on its own line
- *
- * Region sigils are line-based - any line containing "alloy-\{region name\}-start" or "alloy-\{region name\}-end"
- * is considered a sigil.
- *
- * @example
- * Simple append to end of file:
- * ```tsx
- * <AppendFile path="output.txt">
- *   <AppendRegion id="append">New content to add</AppendRegion>
- * </AppendFile>
- *
- * // Returns:
- * //   Original file content
- * //   New content to add
- * ```
- *
- * @example
- * Append to specific regions:
- * ```tsx
- * // File content before:
- * // Header content
- * // <!-- alloy-main-start -->
- * // <!-- alloy-main-end -->
- * // Footer content
- *
- * <AppendFile path="template.html" regions={["main"]}>
- *   <AppendRegion id="main">New main content</AppendRegion>
- * </AppendFile>
- *
- * // Returns:
- * //   Header content
- * //   <!-- alloy-main-start -->
- * //   New main content
- * //   <!-- alloy-main-end -->
- * //   Footer content
- * ```
- */
-export function AppendFile(props) {
-  const regions = props.regions || ["append"];
-
-  // Get all children and filter for AppendRegion components
-  const children = childrenArray(() => props.children);
-  const appendRegions = {};
-
-  // Check if we have any AppendRegion components
-  let hasAppendRegions = false;
-  for (const child of children) {
-    if (isComponentCreator(child, AppendRegion)) {
-      hasAppendRegions = true;
-      const regionProps = child.props;
-      let content;
-      if ("children" in regionProps && regionProps.children !== undefined) {
-        content = regionProps.children;
-      } else if ("content" in regionProps) {
-        content = regionProps.content;
-      } else {
-        throw new Error(`AppendRegion "${regionProps.id}" must have either children or content`);
-      }
-      appendRegions[regionProps.id] = content;
-    }
-  }
-
-  // If no AppendRegion components found, treat all children as content for the default "append" region
-  if (!hasAppendRegions && children.length > 0) {
-    appendRegions["append"] = children;
-  }
-
-  // Validate that all requested regions have corresponding AppendRegion children
-  for (const regionId of regions) {
-    if (!(regionId in appendRegions)) {
-      throw new Error(`Region "${regionId}" specified but no corresponding AppendRegion child found`);
-    }
-  }
-
-  // Read existing file content or start with empty string
-  const parentDirectory = useContext(SourceDirectoryContext);
-  const fullPath = join(parentDirectory ? parentDirectory.path : "", props.path);
-  const currentContents = createFileResource(fullPath);
-  const newFileContent = computed(() => {
-    if (currentContents.loading) {
-      return;
-    }
-    const fileContent = currentContents.error ? "" : currentContents.data;
-
-    // Find all sigils in the file
-    const sigilInfo = {};
-    const endSigils = [];
-
-    // Reset regex and find all sigils
-    SIGIL_REGEX.lastIndex = 0;
-    let match;
-    while ((match = SIGIL_REGEX.exec(fileContent)) !== null) {
-      const indent = match[1];
-      const fullLine = match[0];
-      const regionId = match[3];
-      const sigilType = match[4];
-      const index = match.index;
-
-      // Initialize sigil info for this region if not exists
-      if (!sigilInfo[regionId]) {
-        sigilInfo[regionId] = {
-          id: regionId,
-          start: null,
-          end: null
-        };
-      }
-      if (sigilType === "start") {
-        sigilInfo[regionId].start = index;
-      } else if (sigilType === "end") {
-        sigilInfo[regionId].end = index;
-
-        // If this is a region we care about, track it for processing
-        if (regions.includes(regionId)) {
-          endSigils.push({
-            regionId,
-            index,
-            indent,
-            line: fullLine
-          });
-        }
-      }
-    }
-
-    // Validate regions - check for unclosed regions
-    for (const regionId of regions) {
-      const info = sigilInfo[regionId];
-      if (info && info.start !== null && info.end === null) {
-        throw new Error(`Region "${regionId}" has start sigil but no corresponding end sigil`);
-      }
-    }
-
-    // Check if we have any sigils to process
-    if (endSigils.length === 0) {
-      // No sigils found, append all regions to the end
-      const result = [fileContent];
-      for (const regionId of regions) {
-        if (fileContent && !fileContent.endsWith("\n")) {
-          result.push("\n");
-        }
-        result.push(appendRegions[regionId]);
-      }
-      return _$createComponent(SourceFile, {
-        get path() {
-          return props.path;
-        },
-        filetype: "text/plain",
-        children: result
-      });
-    }
-
-    // Sort end sigils by their position in the file
-    endSigils.sort((a, b) => a.index - b.index);
-
-    // Process content with sigils
-    const result = [];
-    let lastIndex = 0;
-
-    // Process each end sigil in order
-    for (const {
-      regionId,
-      index,
-      indent,
-      line
-    } of endSigils) {
-      // Add content before this sigil
-      if (index > lastIndex) {
-        const beforeContent = fileContent.substring(lastIndex, index);
-        if (beforeContent) {
-          result.push(beforeContent);
-        }
-      }
-
-      // Add the new content with proper indentation
-      result.push(indent);
-      result.push(appendRegions[regionId]);
-      result.push("\n");
-
-      // Add the sigil line
-      result.push(line);
-
-      // Update last processed index
-      lastIndex = index + line.length;
-    }
-
-    // Add any remaining content after the last sigil
-    if (lastIndex < fileContent.length) {
-      const remainingPart = fileContent.substring(lastIndex);
-      if (remainingPart) {
-        result.push(remainingPart);
-      }
-    }
-    return result;
-  });
-  return _$createComponent(SourceFile, {
-    get path() {
-      return props.path;
-    },
-    filetype: "text/plain",
-    children: newFileContent
-  });
-}
-export function AppendRegion(props) {
-  /**
-   * This component does nothing except hold props which are retrieved by
-   * the `AppendFile` component.
-   */
-}

package/dist/src/components/CopyFile.d.ts

@@ -1,12 +0,0 @@
-export interface CopyFileProps {
-    /**
-     * The path to write the copy to, relative to the containing directory.
-     */
-    path: string;
-    /**
-     * The path to the file to copy.
-     */
-    src: string;
-}
-export declare function CopyFile(props: CopyFileProps): void;
-//# sourceMappingURL=CopyFile.d.ts.map

package/dist/src/components/CopyFile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CopyFile.d.ts","sourceRoot":"","sources":["../../../src/components/CopyFile.tsx"],"names":[],"mappings":"AAMA,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,QAU5C"}

package/dist/src/components/CopyFile.js

@@ -1,15 +0,0 @@
-import { join } from "pathe";
-import { useContext } from "../context.js";
-import { SourceDirectoryContext } from "../context/source-directory.js";
-import { getContext } from "../reactivity.js";
-export function CopyFile(props) {
-  const parentDirectory = useContext(SourceDirectoryContext);
-  const context = {
-    path: join(parentDirectory ? parentDirectory.path : "", props.path),
-    sourcePath: props.src
-  };
-  parentDirectory?.addContent(context);
-  const nodeContext = getContext();
-  nodeContext.meta ??= {};
-  nodeContext.meta.copyFile = context;
-}

package/dist/src/components/TemplateFile.d.ts

@@ -1,84 +0,0 @@
-import { Children } from "../runtime/component.js";
-export interface TemplateFileProps {
-    /**
-     * The path to write the compiled template to.
-     */
-    path: string;
-    /**
-     * The file path of the template.
-     */
-    src: string;
-    /**
-     * Template variable children components.
-     */
-    children?: Children;
-}
-/**
- * A component that reads a template file and replaces variable placeholders
- * with actual values.
- *
- * Template files can contain variable placeholders in the format
- * `{{ variable_name }}` which will be replaced with values from `TemplateVariable`
- * children components. Whitespace around variable names is ignored, so
- * `{{ name }}`, `{{name}}`, and `{{  name  }}` are all equivalent.
- *
- * @example
- * Basic usage with template variables:
- * ```tsx
- * // Template file content (greeting.txt):
- * // "Hello {{ name }}! You are {{ age }} years old."
- *
- * <TemplateFile src="greeting.txt" path="output.txt">
- *   <TemplateVariable name="name" value="John" />
- *   <TemplateVariable name="age" value="25" />
- * </TemplateFile>
- * ```
- *
- * @example
- * Using children instead of value prop:
- * ```tsx
- * // Template file content (welcome.txt):
- * // "Welcome {{ greeting }}!"
- *
- * <TemplateFile src="welcome.txt" path="output.txt">
- *   <TemplateVariable name="greeting">Hello World</TemplateVariable>
- * </TemplateFile>
- * ```
- *
- * @example
- * Complex template with multiple variables:
- * ```tsx
- * // Template file content (profile.txt):
- * // "Name: {{ name }}\nAge: {{ age }}\nLocation: {{ location }}"
- *
- * <TemplateFile src="profile.txt" path="profile-output.txt">
- *   <TemplateVariable name="name" value="Alice" />
- *   <TemplateVariable name="age">30</TemplateVariable>
- *   <TemplateVariable name="location" value="New York" />
- * </TemplateFile>
- * ```
- */
-export declare function TemplateFile(props: TemplateFileProps): Children;
-export interface TemplateVariablePropsWithChildren {
-    /**
-     * The name of the variable.
-     */
-    name: string;
-    /**
-     * The value of the variable.
-     */
-    children: Children;
-}
-export interface TemplateVariablePropsWithValue {
-    /**
-     * The name of the variable.
-     */
-    name: string;
-    /**
-     * The value of the variable.
-     */
-    value: string;
-}
-export type TemplateVariableProps = TemplateVariablePropsWithChildren | TemplateVariablePropsWithValue;
-export declare function TemplateVariable(props: TemplateVariableProps): void;
-//# sourceMappingURL=TemplateFile.d.ts.map

package/dist/src/components/TemplateFile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TemplateFile.d.ts","sourceRoot":"","sources":["../../../src/components/TemplateFile.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAsB,MAAM,yBAAyB,CAAC;AAIvE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,QAAQ,CAyF/D;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,qBAAqB,GAC7B,iCAAiC,GACjC,8BAA8B,CAAC;AAEnC,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,QAK5D"}