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

package/src/context/format-options.ts

@@ -1,21 +1,7 @@
 import { createNamedContext, useContext } from "../context.js";
+import { PrintTreeOptions } from "../render.js";
 
-export interface CommonFormatOptions {
-  /**
-   * The number of characters the printer will wrap on.
-   */
-  printWidth?: number;
-
-  /**
-   * Whether to use tabs instead of spaces for indentation.
-   */
-  useTabs?: boolean;
-
-  /**
-   * The number of spaces to use for indentation.
-   */
-  tabWidth?: number;
-}
+export interface CommonFormatOptions extends PrintTreeOptions {}
 
 export const { Provider: FormatOptions, useFormatOptions } =
   createFormatOptionsContextFor<CommonFormatOptions>("*");

package/src/render.ts

@@ -261,6 +261,10 @@ export function sourceFilesForTree(
             options?.printWidth ?? context.meta?.printOptions?.printWidth,
           tabWidth: options?.tabWidth ?? context.meta?.printOptions?.tabWidth,
           useTabs: options?.useTabs ?? context.meta?.printOptions?.useTabs,
+          insertFinalNewLine:
+            options?.insertFinalNewLine ??
+            context.meta?.printOptions?.insertFinalNewLine ??
+            true,
         }),
       };
 
@@ -590,6 +594,12 @@ export interface PrintTreeOptions {
    * The number of spaces to use for indentation. Defaults to 2 spaces.
    */
   tabWidth?: number;
+
+  /**
+   * If files should end with a final new line.
+   * @default true
+   */
+  insertFinalNewLine?: boolean;
 }
 
 const defaultPrintTreeOptions: PrintTreeOptions = {
@@ -609,8 +619,14 @@ export function printTree(tree: RenderedTextTree, options?: PrintTreeOptions) {
   flushJobs();
 
   const d = printTreeWorker(tree);
-  return doc.printer.printDocToString(d, options as doc.printer.Options)
-    .formatted;
+  const result = doc.printer.printDocToString(
+    d,
+    options as doc.printer.Options,
+  ).formatted;
+
+  return options.insertFinalNewLine && !result.endsWith("\n") ?
+      `${result}\n`
+    : result;
 }
 
 function printTreeWorker(tree: RenderedTextTree): Doc {

package/temp/api.json

@@ -117,6 +117,10 @@
         {
           "tagName": "@reactive",
           "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@default",
+          "syntaxKind": "block"
         }
       ],
       "reportUnsupportedHtmlElements": false
@@ -2591,97 +2595,29 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface CommonFormatOptions "
+              "text": "export interface CommonFormatOptions extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "PrintTreeOptions",
+              "canonicalReference": "@alloy-js/core!PrintTreeOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "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
-              }
-            },
+          "members": [],
+          "extendsTokenRanges": [
             {
-              "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
-              }
+              "startIndex": 1,
+              "endIndex": 2
             }
-          ],
-          "extendsTokenRanges": []
+          ]
         },
         {
           "kind": "Interface",
@@ -16582,6 +16518,33 @@
           "name": "PrintTreeOptions",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!PrintTreeOptions#insertFinalNewLine:member",
+              "docComment": "/**\n * If files should end with a final new line.\n *\n * @default\n *\n *  true\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "insertFinalNewLine?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "insertFinalNewLine",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/core!PrintTreeOptions#printWidth:member",

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

@@ -47,34 +47,32 @@ it("has reactive context", () => {
     );
   }
 
-  const tree = render(
+  expect(
     <Output>
       <SourceFile path="hi.txt" filetype="text">
         hello!
       </SourceFile>
       <TrackContents />
     </Output>,
-  );
-
-  expect((tree.contents[1] as ContentOutputFile).contents).toEqual(
-    "hi.txt contents.txt",
-  );
+  ).toRenderTo({
+    "hi.txt": "hello!",
+    "contents.txt": "hi.txt contents.txt",
+  });
 });
 
-it("Includes header", () => {
+it("includes header", () => {
   const header = <># This is a header</>;
-  const tree = render(
+
+  expect(
     <Output>
       <SourceFile path="hi.txt" filetype="text" header={header}>
         hello!
       </SourceFile>
     </Output>,
-  );
-
-  expect((tree.contents[0] as ContentOutputFile).contents).toEqual(d`
+  ).toRenderTo(`
     # This is a header
     hello!
-    `);
+  `);
 });
 
 describe("format options", () => {
@@ -139,4 +137,35 @@ describe("format options", () => {
          indented 3 spaces
     `);
   });
+
+  describe("trailing line", () => {
+    function testRender(comp: any) {
+      const tree = render(<Output>{comp}</Output>);
+      return (tree.contents[0] as ContentOutputFile).contents;
+    }
+
+    it("add trailing new line by default", () => {
+      expect(
+        testRender(
+          <SourceFile filetype="text" path="abc.txt">
+            end with new line
+          </SourceFile>,
+        ),
+      ).toEqual(d`
+        end with new line
+        
+      `);
+    });
+    it("add trailing new line by default", () => {
+      expect(
+        testRender(
+          <SourceFile filetype="text" path="abc.txt" insertFinalNewLine={false}>
+            end with no line
+          </SourceFile>,
+        ),
+      ).toEqual(d`
+        end with no line
+      `);
+    });
+  });
 });

package/test/rendering/formatting.test.tsx

@@ -467,6 +467,7 @@ it("formats based on the output component props", () => {
     4
     5
     6
+    
   `);
 });
 
@@ -489,5 +490,6 @@ it("formats based on the source file component props", () => {
     4
     5
     6
+
   `);
 });

package/testing/extend-expect.ts

@@ -40,6 +40,12 @@ expect.extend({
   },
 });
 
+function isAsymmetricMatcher(value: any): value is {
+  asymmetricMatch: (other: any) => boolean;
+} {
+  return value.$$typeof === Symbol.for("jest.asymmetricMatcher");
+}
+
 function validateRender(
   actual: string | Record<string, string>,
   expectedRaw: string | Record<string, string>,
@@ -73,12 +79,18 @@ function validateRender(
     const expected = expectedRaw;
     const dedentExpected: Record<string, string> = {};
     for (const [key, value] of Object.entries(expected)) {
-      dedentExpected[key] = dedent(value);
+      if (isAsymmetricMatcher(value)) {
+        dedentExpected[key] = value;
+      } else {
+        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 isAsymmetricMatcher(dedentExpected[key]) ?
+            dedentExpected[key].asymmetricMatch(value)
+          : dedentExpected[key] === value;
       });
     return {
       pass,