@alloy-js/core 0.20.0-dev.6 → 0.20.0-dev.8

package/temp/api.json

@@ -2584,6 +2584,105 @@
           ],
           "name": "code"
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/core!CommonFormatOptions:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface CommonFormatOptions "
+            }
+          ],
+          "fileUrlPath": "src/context/format-options.ts",
+          "releaseTag": "Public",
+          "name": "CommonFormatOptions",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!CommonFormatOptions#printWidth:member",
+              "docComment": "/**\n * The number of characters the printer will wrap on.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "printWidth?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "printWidth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!CommonFormatOptions#tabWidth:member",
+              "docComment": "/**\n * The number of spaces to use for indentation.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "tabWidth?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "tabWidth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!CommonFormatOptions#useTabs:member",
+              "docComment": "/**\n * Whether to use tabs instead of spaces for indentation.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "useTabs?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "useTabs",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@alloy-js/core!Component:interface",
@@ -4302,6 +4401,107 @@
           ],
           "name": "createFileResource"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!createFormatOptionsContextFor:function(1)",
+          "docComment": "/**\n * Create a format options context for a specific file type\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function createFormatOptionsContextFor<T>(filetype: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", defaults?: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    Provider: import(\"../index.js\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentDefinition",
+              "canonicalReference": "@alloy-js/core!ComponentDefinition:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"../context.js\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ContextProviderProps",
+              "canonicalReference": "@alloy-js/core!ContextProviderProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<T>>;\n    useFormatOptions: (overrides?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T>) => T;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/context/format-options.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 12
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "filetype",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "defaults",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "createFormatOptionsContextFor"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/core!createIntrinsic:function(1)",
@@ -6581,6 +6781,56 @@
             "endIndex": 14
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@alloy-js/core!FormatOptions:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "FormatOptions: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../index.js\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentDefinition",
+              "canonicalReference": "@alloy-js/core!ComponentDefinition:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"../context.js\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ContextProviderProps",
+              "canonicalReference": "@alloy-js/core!ContextProviderProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "CommonFormatOptions",
+              "canonicalReference": "@alloy-js/core!CommonFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">>"
+            }
+          ],
+          "fileUrlPath": "src/context/format-options.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "FormatOptions",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@alloy-js/core!ForProps:interface",
@@ -10732,13 +10982,30 @@
             },
             {
               "kind": "Content",
-              "text": ", member: "
+              "text": ", ...members: "
+            },
+            {
+              "kind": "Content",
+              "text": "["
             },
             {
               "kind": "Reference",
               "text": "Refkey",
               "canonicalReference": "@alloy-js/core!Refkey:type"
             },
+            {
+              "kind": "Content",
+              "text": ", ..."
+            },
+            {
+              "kind": "Reference",
+              "text": "Refkey",
+              "canonicalReference": "@alloy-js/core!Refkey:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[]]"
+            },
             {
               "kind": "Content",
               "text": "): "
@@ -10755,8 +11022,8 @@
           ],
           "fileUrlPath": "src/refkey.ts",
           "returnTypeTokenRange": {
-            "startIndex": 5,
-            "endIndex": 6
+            "startIndex": 9,
+            "endIndex": 10
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -10770,10 +11037,10 @@
               "isOptional": false
             },
             {
-              "parameterName": "member",
+              "parameterName": "members",
               "parameterTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 4
+                "endIndex": 8
               },
               "isOptional": false
             }
@@ -15487,25 +15754,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": " | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Ref",
-                  "canonicalReference": "@vue/reactivity!Ref:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "OutputSymbol",
-                  "canonicalReference": "@alloy-js/core!OutputSymbol:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": " | undefined> | undefined"
+                  "text": " | undefined"
                 },
                 {
                   "kind": "Content",
@@ -15545,7 +15794,7 @@
               "name": "type",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 7
+                "endIndex": 3
               },
               "isStatic": false,
               "isProtected": false,
@@ -21134,6 +21383,75 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!symbolForRefkey:function(1)",
+          "docComment": "/**\n * Get a ref to the symbol for the given refkey using the current binder. The\n * value of the ref will be undefined when no symbol with that refkey has been\n * created.\n *\n * @remarks\n *\n *\n *\n * This API may return a ref for undefined, but that does not mean that the symbol is\n * not found. The symbol you're looking for may not have been declared yet. When the symbol\n * is declared, the ref will be updated with the symbol.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function symbolForRefkey(refkey: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Refkey",
+              "canonicalReference": "@alloy-js/core!Refkey:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Ref",
+              "canonicalReference": "@vue/reactivity!Ref:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "OutputSymbol",
+              "canonicalReference": "@alloy-js/core!OutputSymbol:class"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined, "
+            },
+            {
+              "kind": "Reference",
+              "text": "OutputSymbol",
+              "canonicalReference": "@alloy-js/core!OutputSymbol:class"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined>"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/binder.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 9
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "refkey",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "symbolForRefkey"
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@alloy-js/core!SymbolRefkey:interface",
@@ -23223,6 +23541,62 @@
           ],
           "name": "useContext"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!useFormatOptions:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "useFormatOptions: (overrides?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "CommonFormatOptions",
+              "canonicalReference": "@alloy-js/core!CommonFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "> | undefined"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "CommonFormatOptions",
+              "canonicalReference": "@alloy-js/core!CommonFormatOptions:interface"
+            }
+          ],
+          "fileUrlPath": "src/context/format-options.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "overrides",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "useFormatOptions"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/core!useMemberContext:function(1)",

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

@@ -1,13 +1,18 @@
 import {
+  Children,
+  CommonFormatOptions,
   computed,
   ContentOutputFile,
+  FormatOptions,
+  Indent,
   Output,
+  Prose,
   render,
   renderTree,
   SourceFile,
   useContext,
 } from "@alloy-js/core";
-import { expect, it } from "vitest";
+import { describe, expect, it } from "vitest";
 import { SourceDirectoryContext } from "../../src/context/source-directory.js";
 import "../../testing/extend-expect.js";
 import { d } from "../../testing/render.js";
@@ -71,3 +76,67 @@ it("Includes header", () => {
     hello!
     `);
 });
+
+describe("format options", () => {
+  function FileWithFormatOptions(props: {
+    options: CommonFormatOptions;
+    children: Children;
+  }) {
+    return (
+      <FormatOptions value={props.options}>
+        <SourceFile path="hi.txt" filetype="text">
+          {props.children}
+        </SourceFile>
+      </FormatOptions>
+    );
+  }
+
+  it("respect tabWidth", () => {
+    expect(
+      <FileWithFormatOptions options={{ tabWidth: 5 }}>
+        hello
+        <Indent>indented 5 spaces</Indent>
+      </FileWithFormatOptions>,
+    ).toRenderTo(`
+      hello
+           indented 5 spaces
+    `);
+  });
+
+  it("respect useTabs", () => {
+    expect(
+      <FileWithFormatOptions options={{ useTabs: true }}>
+        hello
+        <Indent>indented with tabs</Indent>
+      </FileWithFormatOptions>,
+    ).toRenderTo(`
+      hello
+      \tindented with tabs
+    `);
+  });
+
+  it("respect printWidth", () => {
+    expect(
+      <FileWithFormatOptions options={{ printWidth: 10 }}>
+        <Prose>this is too long</Prose>
+      </FileWithFormatOptions>,
+    ).toRenderTo(`
+      this is
+      too long
+    `);
+  });
+
+  it("source file overrides take precedence", () => {
+    expect(
+      <FormatOptions value={{ tabWidth: 5 }}>
+        <SourceFile path="hi.txt" filetype="text" tabWidth={3}>
+          hello
+          <Indent>indented 3 spaces</Indent>
+        </SourceFile>
+      </FormatOptions>,
+    ).toRenderTo(`
+      hello
+         indented 3 spaces
+    `);
+  });
+});

package/testing/extend-expect.ts

@@ -98,12 +98,6 @@ function validateRender(
 
 function getFilesFromTree(tree: RenderedTextTree, options?: ToRenderToOptions) {
   const files: Record<string, string> = {};
-  // when passing Output, the first render tree child is the Output component.
-  const rootRenderOptions =
-    Array.isArray(tree) ?
-      (getContextForRenderNode(tree[0] as RenderedTextTree)?.meta
-        ?.printOptions ?? {})
-    : {};
 
   collectSourceFiles(tree);
   // If we found no source files, we return the tree as a string.
@@ -121,17 +115,9 @@ function getFilesFromTree(tree: RenderedTextTree, options?: ToRenderToOptions) {
     if (context?.meta?.sourceFile) {
       files[context.meta.sourceFile.path] = printTree(root, {
         printWidth:
-          options?.printWidth ??
-          context.meta?.printOptions?.printWidth ??
-          rootRenderOptions.printWidth,
-        tabWidth:
-          options?.tabWidth ??
-          context.meta?.printOptions?.tabWidth ??
-          rootRenderOptions.tabWidth,
-        useTabs:
-          options?.useTabs ??
-          context.meta?.printOptions?.useTabs ??
-          rootRenderOptions.useTabs,
+          options?.printWidth ?? context.meta?.printOptions?.printWidth,
+        tabWidth: options?.tabWidth ?? context.meta?.printOptions?.tabWidth,
+        useTabs: options?.useTabs ?? context.meta?.printOptions?.useTabs,
       });
     } else {
       visitChildren();