@alloy-js/csharp 0.17.0 → 0.18.0-dev.11

package/dist/src/modifiers.js

@@ -1,34 +1,20 @@
 // the possible C# access modifiers
 // https://learn.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/access-modifiers
 
-// maps the above access modifier value to its C# syntax.
-// note that the C# keyword includes a trailing space
-const accessModifierLookup = {
-  public: "public ",
-  protected: "protected ",
-  private: "private ",
-  internal: "internal ",
-  "protected-internal": "protected internal ",
-  "private-protected": "private protected ",
-  file: "file "
-};
+/** Access modifiers.  */
 
-// returns the C# syntax for the specified access modifier.
-// if no access modifier is specified, the empty string is returned.
-export function getAccessModifier(accessModifier) {
-  return accessModifier ? accessModifierLookup[accessModifier] : "";
+export const getAccessModifier = makeModifiers(["public", "protected", "private", "internal", "file"]);
+export function getAsyncModifier(async) {
+  return async ? "async" : "";
 }
-// maps the above method modifier value to its C# syntax.
-// note that the C# keyword includes a trailing space
-const methodModifierLookup = {
-  abstract: "abstract ",
-  sealed: "sealed ",
-  static: "static ",
-  virtual: "virtual "
-};
 
-// returns the C# syntax for the specified method modifier.
-// if no method modifier is specified, the empty string is returned.
-export function getMethodModifier(methodModifier) {
-  return methodModifier ? methodModifierLookup[methodModifier] : "";
+/** Resolve the modifier prefix */
+export function computeModifiersPrefix(modifiers) {
+  const resolved = modifiers.filter(x => x);
+  return resolved.length > 0 ? resolved.join(" ") + " " : "";
+}
+export function makeModifiers(obj) {
+  return data => {
+    return obj.map(key => data[key] ? key : undefined).filter(x => x).join(" ");
+  };
 }

package/dist/src/name-policy.d.ts

@@ -1,5 +1,5 @@
 import * as core from "@alloy-js/core";
-export type CSharpElements = "class" | "constant" | "enum" | "enum-member" | "function" | "interface" | "class-member-private" | "class-member-public" | "class-method" | "parameter" | "type-parameter";
+export type CSharpElements = "class" | "constant" | "enum" | "enum-member" | "function" | "interface" | "class-member-private" | "class-member-public" | "class-method" | "class-property" | "parameter" | "type-parameter";
 export declare function createCSharpNamePolicy(): core.NamePolicy<CSharpElements>;
 export declare function useCSharpNamePolicy(): core.NamePolicy<CSharpElements>;
 //# sourceMappingURL=name-policy.d.ts.map

package/dist/src/name-policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"name-policy.d.ts","sourceRoot":"","sources":["../../src/name-policy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAIvC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,UAAU,GACV,MAAM,GACN,aAAa,GACb,UAAU,GACV,WAAW,GACX,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,WAAW,GACX,gBAAgB,CAAC;AAGrB,wBAAgB,sBAAsB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAiBxE;AAGD,wBAAgB,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAErE"}
+{"version":3,"file":"name-policy.d.ts","sourceRoot":"","sources":["../../src/name-policy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAIvC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,UAAU,GACV,MAAM,GACN,aAAa,GACb,UAAU,GACV,WAAW,GACX,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,gBAAgB,CAAC;AAGrB,wBAAgB,sBAAsB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAkBxE;AAGD,wBAAgB,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAErE"}

package/dist/src/name-policy.js

@@ -14,6 +14,7 @@ export function createCSharpNamePolicy() {
       case "class-member-public":
       case "class-method":
       case "type-parameter":
+      case "class-property":
         return changecase.pascalCase(name);
       case "constant":
         return changecase.constantCase(name);

package/dist/test/class-declaration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=class-declaration.test.d.ts.map

package/dist/test/class-declaration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-declaration.test.d.ts","sourceRoot":"","sources":["../../test/class-declaration.test.tsx"],"names":[],"mappings":""}

package/dist/test/{class.test.js → class-declaration.test.js}

@@ -1,34 +1,76 @@
-import { createComponent as _$createComponent, createIntrinsic as _$createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { createComponent as _$createComponent, mergeProps as _$mergeProps, createIntrinsic as _$createIntrinsic } from "@alloy-js/core/jsx-runtime";
 import * as core from "@alloy-js/core";
 import * as coretest from "@alloy-js/core/testing";
-import { expect, it } from "vitest";
+import { describe, expect, it } from "vitest";
 import * as csharp from "../src/index.js";
+import { ClassDeclaration, ClassMember } from "../src/index.js";
 import * as utils from "./utils.js";
 it("declares class with no members", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
-    name: "TestClass"
-  }));
-  expect(res).toBe(coretest.d`
-    namespace TestCode
-    {
-        public class TestClass;
+  expect(_$createComponent(utils.TestNamespace, {
+    get children() {
+      return _$createComponent(ClassDeclaration, {
+        name: "TestClass"
+      });
     }
+  })).toRenderTo(`
+      class TestClass;
   `);
 });
+describe("modifiers", () => {
+  it.each(["public", "private"])("%s", mod => {
+    expect(_$createComponent(utils.TestNamespace, {
+      get children() {
+        return _$createComponent(ClassDeclaration, _$mergeProps({
+          [mod]: true
+        }, {
+          name: "TestClass"
+        }));
+      }
+    })).toRenderTo(`
+        ${mod} class TestClass;
+    `);
+  });
+  it.each(["partial", "abstract", "static", "sealed"])("%s", mod => {
+    expect(_$createComponent(utils.TestNamespace, {
+      get children() {
+        return _$createComponent(ClassDeclaration, _$mergeProps({
+          [mod]: true
+        }, {
+          name: "TestClass"
+        }));
+      }
+    })).toRenderTo(`
+        ${mod} class TestClass;
+    `);
+  });
+  it("combines modifiers", () => {
+    expect(_$createComponent(utils.TestNamespace, {
+      get children() {
+        return _$createComponent(ClassDeclaration, {
+          "public": true,
+          abstract: true,
+          partial: true,
+          name: "TestClass"
+        });
+      }
+    })).toRenderTo(`
+        public abstract partial class TestClass;
+    `);
+  });
+});
 it("declares class with some members", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.ClassDeclaration, {
+    "public": true,
     name: "TestClass",
     get children() {
       return _$createComponent(core.StatementList, {
         get children() {
           return [_$createComponent(csharp.ClassMember, {
-            accessModifier: "public",
+            "public": true,
             name: "MemberOne",
             type: "string"
           }), _$createComponent(csharp.ClassMember, {
-            accessModifier: "private",
+            "private": true,
             name: "MemberTwo",
             type: "int"
           })];
@@ -48,18 +90,18 @@ it("declares class with some members", () => {
   `);
 });
 it("declares class with some methods", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.ClassDeclaration, {
+    "public": true,
     name: "TestClass",
     get children() {
       return _$createComponent(core.List, {
         get children() {
           return [_$createComponent(csharp.ClassMethod, {
-            accessModifier: "public",
+            "public": true,
             name: "MethodOne"
           }), _$createComponent(csharp.ClassMethod, {
-            accessModifier: "private",
-            methodModifier: "virtual",
+            "private": true,
+            virtual: true,
             name: "MethodTwo"
           })];
         }
@@ -77,36 +119,6 @@ it("declares class with some methods", () => {
     }
   `);
 });
-it("declares class with params and return type", () => {
-  const params = [{
-    name: "IntParam",
-    type: "int"
-  }, {
-    name: "StringParam",
-    type: "string"
-  }];
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
-    name: "TestClass",
-    get children() {
-      return _$createComponent(csharp.ClassMethod, {
-        accessModifier: "public",
-        name: "MethodOne",
-        parameters: params,
-        returns: "string"
-      });
-    }
-  }));
-  expect(res).toBe(coretest.d`
-    namespace TestCode
-    {
-        public class TestClass
-        {
-            public string MethodOne(int intParam, string stringParam) {}
-        }
-    }
-  `);
-});
 it("uses refkeys for members, params, and return type", () => {
   const inputTypeRefkey = core.refkey();
   const testResultTypeRefkey = core.refkey();
@@ -129,8 +141,8 @@ it("uses refkeys for members, params, and return type", () => {
           return _$createComponent(csharp.SourceFile, {
             path: "Test.cs",
             get children() {
-              return [_$createComponent(csharp.Enum, {
-                accessModifier: "public",
+              return [_$createComponent(csharp.EnumDeclaration, {
+                "public": true,
                 name: "TestEnum",
                 refkey: enumTypeRefkey,
                 get children() {
@@ -146,24 +158,24 @@ it("uses refkeys for members, params, and return type", () => {
                     }
                   });
                 }
-              }), _$createIntrinsic("hbr", {}), _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              }), _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "TestInput",
                 refkey: inputTypeRefkey
-              }), _$createIntrinsic("hbr", {}), _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              }), _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "TestResult",
                 refkey: testResultTypeRefkey
-              }), _$createIntrinsic("hbr", {}), _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              }), _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "TestClass",
                 get children() {
                   return [_$createComponent(csharp.ClassMember, {
-                    accessModifier: "private",
+                    "private": true,
                     name: "MemberOne",
                     type: enumTypeRefkey
                   }), ";", _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassMethod, {
-                    accessModifier: "public",
+                    "public": true,
                     name: "MethodOne",
                     parameters: params,
                     returns: testResultTypeRefkey,
@@ -205,19 +217,19 @@ it("declares class with generic parameters", () => {
     T: core.refkey(),
     U: core.refkey()
   };
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.ClassDeclaration, {
+    "public": true,
     name: "TestClass",
     typeParameters: typeParameters,
     get children() {
       return [_$createComponent(csharp.ClassMember, {
-        accessModifier: "public",
+        "public": true,
         name: "memberOne",
         get type() {
           return typeParameters.T;
         }
       }), ";", _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassMember, {
-        accessModifier: "private",
+        "private": true,
         name: "memberTwo",
         get type() {
           return typeParameters.U;
@@ -237,8 +249,8 @@ it("declares class with generic parameters", () => {
   `);
 });
 it("declares class with invalid members", () => {
-  const decl = _$createComponent(csharp.Class, {
-    accessModifier: "public",
+  const decl = _$createComponent(csharp.ClassDeclaration, {
+    "public": true,
     name: "TestClass",
     get children() {
       return [_$createComponent(csharp.EnumMember, {
@@ -251,12 +263,12 @@ it("declares class with invalid members", () => {
   expect(() => utils.toSourceText(decl)).toThrow("can't define an enum member outside of an enum-decl scope");
 });
 it("declares class with constructor", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.ClassDeclaration, {
+    "public": true,
     name: "TestClass",
     get children() {
       return _$createComponent(csharp.ClassConstructor, {
-        accessModifier: "public"
+        "public": true
       });
     }
   }));
@@ -284,22 +296,22 @@ it("declares class with constructor params and assigns values to fields", () =>
     type: "int",
     refkey: paramSizeRefkey
   }];
-  const res = utils.toSourceText(_$createComponent(csharp.Class, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.ClassDeclaration, {
+    "public": true,
     name: "TestClass",
     get children() {
       return [_$createComponent(csharp.ClassMember, {
-        accessModifier: "private",
+        "private": true,
         name: "name",
         type: "string",
         refkey: thisNameRefkey
       }), ";", _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassMember, {
-        accessModifier: "private",
+        "private": true,
         name: "size",
         type: "int",
         refkey: thisSizeRefkey
       }), ";", _$createIntrinsic("hbr", {}), _$createComponent(csharp.ClassConstructor, {
-        accessModifier: "public",
+        "public": true,
         parameters: ctorParams,
         get children() {
           return [thisNameRefkey, " = ", paramNameRefkey, ";", _$createIntrinsic("hbr", {}), thisSizeRefkey, " = ", paramSizeRefkey, ";"];
@@ -325,4 +337,42 @@ 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;
+  `);
+});
+it("supports class member doc comments", () => {
+  expect(_$createComponent(utils.TestNamespace, {
+    get children() {
+      return _$createComponent(ClassDeclaration, {
+        name: "Test",
+        doc: "This is a test",
+        get children() {
+          return _$createComponent(ClassMember, {
+            name: "Member",
+            "public": true,
+            type: "int",
+            doc: "This is a member"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    /// This is a test
+    class Test
+    {
+      /// This is a member
+      public int Member
+    }
+  `);
 });

package/dist/test/class-method.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=class-method.test.d.ts.map

package/dist/test/class-method.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-method.test.d.ts","sourceRoot":"","sources":["../../test/class-method.test.tsx"],"names":[],"mappings":""}

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

@@ -0,0 +1,161 @@
+import { memo as _$memo, createComponent as _$createComponent, mergeProps as _$mergeProps } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { ClassDeclaration, ClassMethod } from "../src/index.js";
+import { TestNamespace } from "./utils.js";
+const Wrapper = props => _$createComponent(TestNamespace, {
+  get children() {
+    return _$createComponent(ClassDeclaration, {
+      "public": true,
+      name: "TestClass",
+      get children() {
+        return props.children;
+      }
+    });
+  }
+});
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"])("%s", accessModifier => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(ClassMethod, _$mergeProps({
+            [accessModifier]: true
+          }, {
+            name: "MethodOne"
+          }));
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          ${accessModifier} void MethodOne() {}
+        }
+      `);
+    });
+  });
+  describe("method modifiers", () => {
+    it.each(["static", "virtual", "sealed"])("%s", methodModifier => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(ClassMethod, _$mergeProps({
+            [methodModifier]: true
+          }, {
+            name: "MethodOne"
+          }));
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          ${methodModifier} void MethodOne() {}
+        }
+      `);
+    });
+    it("abstract exclude body", () => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(ClassMethod, {
+            abstract: true,
+            name: "MethodOne"
+          });
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          abstract void MethodOne();
+        }
+      `);
+    });
+  });
+  it("mark method async", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(ClassMethod, {
+          async: true,
+          name: "MethodOne"
+        });
+      }
+    })).toRenderTo(`
+        public class TestClass
+        {
+          async Task MethodOne() {}
+        }
+      `);
+  });
+  it("combine modifiers", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(ClassMethod, {
+          async: true,
+          returns: "Task",
+          "public": true,
+          abstract: true,
+          name: "MethodOne"
+        });
+      }
+    })).toRenderTo(`
+        public class TestClass
+        {
+          public abstract async Task MethodOne();
+        }
+      `);
+  });
+});
+it("applies PascalCase naming policy", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassMethod, {
+        name: "method_one"
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      void MethodOne() {}
+    }
+`);
+});
+it("defines params and return type", () => {
+  const params = [{
+    name: "intParam",
+    type: "int"
+  }, {
+    name: "stringParam",
+    type: "string"
+  }];
+  const res = _$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassMethod, {
+        "public": true,
+        name: "MethodOne",
+        parameters: params,
+        returns: "string"
+      });
+    }
+  });
+  expect(res).toRenderTo(`
+    public class TestClass
+    {
+      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/enum.test.js

@@ -5,8 +5,8 @@ import { expect, it } from "vitest";
 import * as csharp from "../src/index.js";
 import * as utils from "./utils.js";
 it("declares enum with no members", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Enum, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.EnumDeclaration, {
+    "public": true,
     name: "TestEnum"
   }));
   expect(res).toBe(coretest.d`
@@ -17,8 +17,8 @@ it("declares enum with no members", () => {
   `);
 });
 it("declares enum with members", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Enum, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.EnumDeclaration, {
+    "public": true,
     name: "TestEnum",
     get children() {
       return [_$createComponent(csharp.EnumMember, {
@@ -40,8 +40,8 @@ it("declares enum with members", () => {
   `);
 });
 it("applies naming policy to enum and members", () => {
-  const res = utils.toSourceText(_$createComponent(csharp.Enum, {
-    accessModifier: "public",
+  const res = utils.toSourceText(_$createComponent(csharp.EnumDeclaration, {
+    "public": true,
     name: "testEnum",
     get children() {
       return [_$createComponent(csharp.EnumMember, {
@@ -73,8 +73,8 @@ it("can reference things by refkey", () => {
           return _$createComponent(csharp.SourceFile, {
             path: "Test.cs",
             get children() {
-              return [_$createComponent(csharp.Enum, {
-                accessModifier: "public",
+              return [_$createComponent(csharp.EnumDeclaration, {
+                "public": true,
                 name: "TestEnum",
                 refkey: enumRK,
                 get children() {
@@ -116,8 +116,8 @@ it("can reference things by refkey across files", () => {
           return [_$createComponent(csharp.SourceFile, {
             path: "Test.cs",
             get children() {
-              return [_$createComponent(csharp.Enum, {
-                accessModifier: "public",
+              return [_$createComponent(csharp.EnumDeclaration, {
+                "public": true,
                 name: "TestEnum",
                 get children() {
                   return [_$createComponent(csharp.EnumMember, {
@@ -131,8 +131,8 @@ it("can reference things by refkey across files", () => {
           }), _$createComponent(csharp.SourceFile, {
             path: "Other.cs",
             get children() {
-              return [_$createComponent(csharp.Enum, {
-                accessModifier: "public",
+              return [_$createComponent(csharp.EnumDeclaration, {
+                "public": true,
                 name: "OtherEnum",
                 refkey: enumRK,
                 get children() {

package/dist/test/namespace.test.js

@@ -12,16 +12,16 @@ it("defines multiple namespaces and source files with unique content", () => {
           return [_$createComponent(csharp.SourceFile, {
             path: "Model1.cs",
             get children() {
-              return _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              return _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "Model1"
               });
             }
           }), _$createComponent(csharp.SourceFile, {
             path: "Model2.cs",
             get children() {
-              return _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              return _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "Model2"
               });
             }
@@ -33,16 +33,16 @@ it("defines multiple namespaces and source files with unique content", () => {
           return [_$createComponent(csharp.SourceFile, {
             path: "Model3.cs",
             get children() {
-              return _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              return _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "Model3"
               });
             }
           }), _$createComponent(csharp.SourceFile, {
             path: "Model4.cs",
             get children() {
-              return _$createComponent(csharp.Class, {
-                accessModifier: "public",
+              return _$createComponent(csharp.ClassDeclaration, {
+                "public": true,
                 name: "Model4"
               });
             }

package/dist/test/project-directory.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=project-directory.test.d.ts.map

package/dist/test/project-directory.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-directory.test.d.ts","sourceRoot":"","sources":["../../test/project-directory.test.tsx"],"names":[],"mappings":""}