@alloy-js/csharp 0.18.0-dev.7 → 0.18.0-dev.9

package/dist/src/components/doc/from-markdown.test.js

@@ -0,0 +1,83 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { d } from "@alloy-js/core/testing";
+import { describe, expect, it } from "vitest";
+import { DocFromMarkdown } from "./from-markdown.js";
+it("convert code block to <code>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        Some markdown with code
+        \`\`\`csharp
+        var foo = "bar";
+        \`\`\`
+    `
+  })).toRenderTo(`
+    Some markdown with code
+    <code>
+    var foo = "bar";
+    </code>
+  `);
+});
+it("convert inline code block to <c>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        Some markdown with \`inline\` code
+    `
+  })).toRenderTo(`
+    Some markdown with <c>inline</c> code
+  `);
+});
+it("convert link to <see>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        Some markdown with [link](https://example.com)
+    `
+  })).toRenderTo(`
+    Some markdown with <see href="https://example.com">link</see>
+  `);
+});
+it("convert bullet list to <list>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        - Item 1
+        - Item 2
+        - Item 3
+    `
+  })).toRenderTo(`
+    <list type="bullet">
+      <item><description>Item 1</description></item>
+      <item><description>Item 2</description></item>
+      <item><description>Item 3</description></item>
+    </list>
+  `);
+});
+it("convert numbered list to <list>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        1. Item 1
+        2. Item 2
+        3. Item 3
+    `
+  })).toRenderTo(`
+    <list type="number">
+      <item><description>Item 1</description></item>
+      <item><description>Item 2</description></item>
+      <item><description>Item 3</description></item>
+    </list>
+  `);
+});
+describe("strip unsupported elements", () => {
+  it("bold", () => {
+    expect(_$createComponent(DocFromMarkdown, {
+      markdown: d`
+        Some markdown with **bold** text
+    `
+    })).toRenderTo(`Some markdown with bold text`);
+  });
+  it("italic", () => {
+    expect(_$createComponent(DocFromMarkdown, {
+      markdown: d`
+        Some markdown with *italic* text
+    `
+    })).toRenderTo(`Some markdown with italic text`);
+  });
+});

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

@@ -1,6 +1,8 @@
 export * from "./ClassDeclaration.jsx";
 export * from "./ClassMethod.jsx";
 export * from "./Declaration.js";
+export * from "./doc/comment.jsx";
+export * from "./doc/from-markdown.jsx";
 export * from "./EnumDeclaration.jsx";
 export * from "./interface/declaration.js";
 export * from "./interface/method.js";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC"}

package/dist/src/components/index.js

@@ -1,6 +1,8 @@
 export * from "./ClassDeclaration.js";
 export * from "./ClassMethod.js";
 export * from "./Declaration.js";
+export * from "./doc/comment.js";
+export * from "./doc/from-markdown.js";
 export * from "./EnumDeclaration.js";
 export * from "./interface/declaration.js";
 export * from "./interface/method.js";

package/dist/src/components/interface/declaration.d.ts

@@ -5,6 +5,8 @@ export interface InterfaceModifiers {
 }
 export interface InterfaceDeclarationProps extends Omit<core.DeclarationProps, "nameKind">, AccessModifiers, InterfaceModifiers {
     name: string;
+    /** Doc comment */
+    doc?: core.Children;
     refkey?: core.Refkey;
     typeParameters?: Record<string, core.Refkey>;
 }

package/dist/src/components/interface/declaration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"declaration.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/declaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAKD,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,kBAAkB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,iBAuDpE"}
+{"version":3,"file":"declaration.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/declaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAO5B,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAKD,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,kBAAkB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,iBAwDpE"}

package/dist/src/components/interface/declaration.js

@@ -4,6 +4,7 @@ import { computeModifiersPrefix, getAccessModifier, makeModifiers } from "../../
 import { useCSharpNamePolicy } from "../../name-policy.js";
 import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope } from "../../symbols/scopes.js";
+import { DocWhen } from "../doc/comment.js";
 import { Name } from "../Name.js";
 const getInterfaceModifiers = makeModifiers(["partial"]);
 
@@ -69,7 +70,11 @@ export function InterfaceDeclaration(props) {
   return _$createComponent(core.Declaration, {
     symbol: thisInterfaceSymbol,
     get children() {
-      return [modifiers, "interface ", _$createComponent(Name, {}), typeParams, _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(core.Block, {
+      return [_$createComponent(DocWhen, {
+        get doc() {
+          return props.doc;
+        }
+      }), modifiers, "interface ", _$createComponent(Name, {}), typeParams, _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(core.Block, {
         newline: true,
         get children() {
           return _$createComponent(core.Scope, {

package/dist/src/components/interface/declaration.test.js

@@ -53,4 +53,17 @@ describe("modifiers", () => {
         public partial interface TestInterface;
     `);
   });
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(InterfaceDeclaration, {
+        name: "TestInterface",
+        doc: "This is a test"
+      });
+    }
+  })).toRenderTo(`
+    /// This is a test
+    interface TestInterface;
+  `);
 });

package/dist/src/components/interface/method.d.ts

@@ -11,6 +11,8 @@ export interface InterfaceMethodProps extends AccessModifiers, InterfaceMethodMo
     children?: Children;
     parameters?: Array<ParameterProps>;
     returns?: Children;
+    /** Doc comment */
+    doc?: Children;
 }
 export declare function InterfaceMethod(props: InterfaceMethodProps): Children;
 //# sourceMappingURL=method.d.ts.map

package/dist/src/components/interface/method.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"method.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/method.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,cAAc,EAAc,MAAM,mBAAmB,CAAC;AAE/D,yCAAyC;AACzC,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB;AAKD,MAAM,WAAW,oBACf,SAAQ,eAAe,EACrB,wBAAwB;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,QAAQ,CAAC;CACpB;AAGD,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,YAsC1D"}
+{"version":3,"file":"method.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/method.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,cAAc,EAAc,MAAM,mBAAmB,CAAC;AAG/D,yCAAyC;AACzC,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB;AAKD,MAAM,WAAW,oBACf,SAAQ,eAAe,EACrB,wBAAwB;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;CAChB;AAGD,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,YAuC1D"}

package/dist/src/components/interface/method.js

@@ -5,6 +5,7 @@ import { useCSharpNamePolicy } from "../../name-policy.js";
 import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../../symbols/scopes.js";
 import { Parameters } from "../Parameters.js";
+import { DocWhen } from "../doc/comment.js";
 
 /** Method modifiers. Can only be one. */
 
@@ -41,7 +42,11 @@ export function InterfaceMethod(props) {
       return _$createComponent(Scope, {
         value: methodScope,
         get children() {
-          return [modifiers, _$memo(() => props.returns ?? "void"), " ", name, "(", params, ")", _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(Block, {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, _$memo(() => props.returns ?? "void"), " ", name, "(", params, ")", _$memo(() => _$memo(() => !!props.children)() ? _$createComponent(Block, {
             newline: true,
             get children() {
               return props.children;

package/dist/src/components/interface/method.test.js

@@ -107,4 +107,25 @@ it("defines params and return type", () => {
       public string MethodOne(int intParam, string stringParam);
     }
   `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(InterfaceDeclaration, {
+        name: "Test",
+        get children() {
+          return _$createComponent(InterfaceMethod, {
+            name: "Method",
+            doc: "This is a test"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      void Method();
+    }
+  `);
 });

package/dist/src/components/interface/property.d.ts

@@ -14,6 +14,8 @@ export interface InterfacePropertyProps extends AccessModifiers, InterfaceProper
     get?: boolean;
     /** If property should have a setter */
     set?: boolean;
+    /** Doc comment */
+    doc?: Children;
 }
 export declare function InterfaceProperty(props: InterfacePropertyProps): Children;
 //# sourceMappingURL=property.d.ts.map

package/dist/src/components/interface/property.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAIR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAK5B,yCAAyC;AACzC,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,iBAAiB,8CAE5B,CAAC;AAGH,MAAM,WAAW,sBACf,SAAQ,eAAe,EACrB,0BAA0B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,oBAAoB;IACpB,IAAI,EAAE,QAAQ,CAAC;IAEf,uCAAuC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,uCAAuC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAGD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,YAsC9D"}
+{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAIR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,yCAAyC;AACzC,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,iBAAiB,8CAE5B,CAAC;AAGH,MAAM,WAAW,sBACf,SAAQ,eAAe,EACrB,0BAA0B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,oBAAoB;IACpB,IAAI,EAAE,QAAQ,CAAC;IAEf,uCAAuC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,uCAAuC;IACvC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;CAChB;AAGD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,YAuC9D"}

package/dist/src/components/interface/property.js

@@ -1,9 +1,10 @@
-import { memo as _$memo, createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
 import { Block, List, MemberDeclaration, refkey, Scope } from "@alloy-js/core";
 import { computeModifiersPrefix, getAccessModifier, makeModifiers } from "../../modifiers.js";
 import { useCSharpNamePolicy } from "../../name-policy.js";
 import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../../symbols/scopes.js";
+import { DocWhen } from "../doc/comment.js";
 
 /** Method modifiers. Can only be one. */
 
@@ -35,7 +36,11 @@ export function InterfaceProperty(props) {
       return _$createComponent(Scope, {
         value: propertyScope,
         get children() {
-          return [modifiers, _$memo(() => props.type), " ", name, " ", _$createComponent(Block, {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, _$memo(() => props.type), " ", name, " ", _$createComponent(Block, {
             newline: true,
             inline: true,
             get children() {

package/dist/src/components/interface/property.test.js

@@ -138,4 +138,28 @@ it("has getter and setter", () => {
       string TestProp { get; set; }
     }
   `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(InterfaceDeclaration, {
+        name: "Test",
+        get children() {
+          return _$createComponent(InterfaceProperty, {
+            name: "Method",
+            type: "string",
+            get: true,
+            set: true,
+            doc: "This is a test"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      string Method { get; set; }
+    }
+  `);
 });

package/dist/test/class-method.test.js

@@ -137,4 +137,25 @@ it("defines params and return type", () => {
       public string MethodOne(int intParam, string stringParam) {}
     }
   `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(ClassDeclaration, {
+        name: "Test",
+        get children() {
+          return _$createComponent(ClassMethod, {
+            name: "Method",
+            doc: "This is a test"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    class Test
+    {
+      /// This is a test
+      void Method() {}
+    }
+  `);
 });

package/dist/test/class.test.js

@@ -337,4 +337,17 @@ it("declares class with constructor params and assigns values to fields", () =>
         }
     }
   `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(utils.TestNamespace, {
+    get children() {
+      return _$createComponent(ClassDeclaration, {
+        name: "Test",
+        doc: "This is a test"
+      });
+    }
+  })).toRenderTo(`
+    /// This is a test
+    class Test;
+  `);
 });

package/dist/test/vitest.setup.d.ts

@@ -0,0 +1,2 @@
+import "@alloy-js/core/testing";
+//# sourceMappingURL=vitest.setup.d.ts.map

package/dist/test/vitest.setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.setup.d.ts","sourceRoot":"","sources":["../../test/vitest.setup.ts"],"names":[],"mappings":"AAAA,OAAO,wBAAwB,CAAC"}

package/dist/test/vitest.setup.js

@@ -0,0 +1 @@
+import "@alloy-js/core/testing";