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

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

@@ -0,0 +1,55 @@
+import { Children, Refkey } from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+/** Method modifiers. Can only be one. */
+export interface ClassPropertyModifiers {
+    readonly new?: boolean;
+    readonly static?: boolean;
+    readonly virtual?: boolean;
+    readonly sealed?: boolean;
+    readonly override?: boolean;
+    readonly abstract?: boolean;
+    readonly extern?: boolean;
+    readonly readonly?: boolean;
+}
+/** Properties for {@link ClassProperty} component */
+export interface ClassPropertyProps extends AccessModifiers, ClassPropertyModifiers {
+    name: string;
+    refkey?: Refkey;
+    /** Property type */
+    type: Children;
+    /** If property should have a getter */
+    get?: boolean;
+    /** If property should have a setter */
+    set?: boolean;
+    /** Doc comment */
+    doc?: Children;
+    /**
+     * Property initializer
+     * @example `<ClassProperty name="My" get set nullable />`
+     *
+     * ```cs
+     * int? My { get; set; };
+     * ```
+     */
+    nullable?: boolean;
+    /**
+     * Property initializer
+     * @example `<ClassProperty name="My" get set init={42} />`
+     *
+     * ```cs
+     * int My { get; set; } = 42;
+     * ```
+     */
+    init?: Children;
+}
+/**
+ * Render a C# class property.
+ *
+ * @example `<ClassProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+export declare function ClassProperty(props: ClassPropertyProps): Children;
+//# sourceMappingURL=property.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"property.d.ts","sourceRoot":"","sources":["../../../../src/components/class/property.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAKR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAM5B,yCAAyC;AACzC,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAaD,qDAAqD;AACrD,MAAM,WAAW,kBACf,SAAQ,eAAe,EACrB,sBAAsB;IACxB,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;IAEf;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,YAyCtD"}

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

@@ -0,0 +1,67 @@
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { Block, code, 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. */
+
+const getModifiers = makeModifiers(["new", "static", "virtual", "sealed", "override", "abstract", "extern", "readonly"]);
+
+/** Properties for {@link ClassProperty} component */
+
+/**
+ * Render a C# class property.
+ *
+ * @example `<ClassProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+export function ClassProperty(props) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-property");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "class-decl") {
+    throw new Error("can't define an interface method outside of an interface scope");
+  }
+  const propertySymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name)
+  });
+
+  // scope for property declaration
+  const propertyScope = new CSharpMemberScope("property-decl", {
+    owner: propertySymbol
+  });
+  const modifiers = computeModifiersPrefix([getAccessModifier(props), getModifiers(props)]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return _$createComponent(MemberDeclaration, {
+    symbol: propertySymbol,
+    get children() {
+      return _$createComponent(Scope, {
+        value: propertyScope,
+        get children() {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, _$memo(() => props.type), _$memo(() => props.nullable && "?"), " ", name, " ", _$createComponent(Block, {
+            newline: true,
+            inline: true,
+            get children() {
+              return _$createComponent(List, {
+                joiner: " ",
+                get children() {
+                  return [_$memo(() => props.get && "get;"), _$memo(() => props.set && "set;")];
+                }
+              });
+            }
+          }), _$memo(() => props.init && code` = ${props.init};`)];
+        }
+      });
+    }
+  });
+}

package/dist/src/components/class/property.test.d.ts

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

package/dist/src/components/class/property.test.d.ts.map

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

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

@@ -0,0 +1,201 @@
+import { memo as _$memo, createComponent as _$createComponent, mergeProps as _$mergeProps } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.js";
+import { ClassDeclaration } from "../ClassDeclaration.js";
+import { ClassProperty } from "./property.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(ClassProperty, _$mergeProps({
+            [accessModifier]: true
+          }, {
+            name: "TestProp",
+            type: "string",
+            get: true
+          }));
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          ${accessModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+  describe("property modifiers", () => {
+    it.each(["new", "static", "virtual", "sealed", "override", "abstract", "extern", "readonly"])("%s", methodModifier => {
+      expect(_$createComponent(Wrapper, {
+        get children() {
+          return _$createComponent(ClassProperty, _$mergeProps({
+            [methodModifier]: true
+          }, {
+            name: "TestProp",
+            type: "string",
+            get: true
+          }));
+        }
+      })).toRenderTo(`
+        public class TestClass
+        {
+          ${methodModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+  it("combine modifiers", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(ClassProperty, {
+          "public": true,
+          "new": true,
+          name: "TestProp",
+          type: "string",
+          get: true
+        });
+      }
+    })).toRenderTo(`
+        public class TestClass
+        {
+          public new string TestProp { get; }
+        }
+      `);
+  });
+});
+it("applies PascalCase naming policy", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassProperty, {
+        name: "test_prop",
+        type: "string",
+        get: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; }
+    }
+`);
+});
+it("has getter only", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassProperty, {
+        name: "TestProp",
+        type: "string",
+        get: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; }
+    }
+  `);
+});
+it("has setter only", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassProperty, {
+        name: "TestProp",
+        type: "string",
+        set: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { set; }
+    }
+  `);
+});
+it("has getter and setter", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassProperty, {
+        name: "TestProp",
+        type: "string",
+        get: true,
+        set: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; set; }
+    }
+  `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestNamespace, {
+    get children() {
+      return _$createComponent(ClassDeclaration, {
+        name: "Test",
+        get children() {
+          return _$createComponent(ClassProperty, {
+            name: "Method",
+            type: "string",
+            get: true,
+            set: true,
+            doc: "This is a test"
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    class Test
+    {
+      /// This is a test
+      string Method { get; set; }
+    }
+  `);
+});
+it("specify nullable property", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassProperty, {
+        name: "TestProp",
+        type: "string",
+        nullable: true,
+        get: true,
+        set: true
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string? TestProp { get; set; }
+    }
+  `);
+});
+it("specify initializer", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(ClassProperty, {
+        name: "TestProp",
+        type: "string",
+        get: true,
+        set: true,
+        init: `"abc"`
+      });
+    }
+  })).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; set; } = "abc";
+    }
+  `);
+});

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

@@ -1,3 +1,4 @@
+export * from "./class/property.js";
 export * from "./ClassDeclaration.jsx";
 export * from "./ClassMethod.jsx";
 export * from "./Declaration.js";
@@ -6,6 +7,7 @@ export * from "./doc/from-markdown.jsx";
 export * from "./EnumDeclaration.jsx";
 export * from "./interface/declaration.js";
 export * from "./interface/method.js";
+export * from "./interface/property.js";
 export * from "./Name.js";
 export * from "./Namespace.js";
 export * from "./Parameters.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,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,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,yBAAyB,CAAC;AACxC,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,3 +1,4 @@
+export * from "./class/property.js";
 export * from "./ClassDeclaration.js";
 export * from "./ClassMethod.js";
 export * from "./Declaration.js";
@@ -6,6 +7,7 @@ export * from "./doc/from-markdown.js";
 export * from "./EnumDeclaration.js";
 export * from "./interface/declaration.js";
 export * from "./interface/method.js";
+export * from "./interface/property.js";
 export * from "./Name.js";
 export * from "./Namespace.js";
 export * from "./Parameters.js";

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

@@ -4,7 +4,6 @@ import { AccessModifiers } from "../../modifiers.js";
 export interface InterfacePropertyModifiers {
     readonly new?: boolean;
 }
-export declare const getMethodModifier: (data: InterfacePropertyModifiers) => string;
 export interface InterfacePropertyProps extends AccessModifiers, InterfacePropertyModifiers {
     name: string;
     refkey?: Refkey;
@@ -16,6 +15,24 @@ export interface InterfacePropertyProps extends AccessModifiers, InterfaceProper
     set?: boolean;
     /** Doc comment */
     doc?: Children;
+    /**
+     * Property initializer
+     * @example `<ClassProperty name="My" get set nullable />`
+     *
+     * ```cs
+     * int? My { get; set; };
+     * ```
+     */
+    nullable?: boolean;
 }
+/**
+ * Render a C# interface property.
+ *
+ * @example `<InterfaceProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
 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;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"}
+{"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;AAKD,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;IAEf;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,YAwC9D"}

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

@@ -8,11 +8,19 @@ import { DocWhen } from "../doc/comment.js";
 
 /** Method modifiers. Can only be one. */
 
-export const getMethodModifier = makeModifiers(["new"]);
+const getModifiers = makeModifiers(["new"]);
 
 // properties for creating a method
 
-// a C# interface property
+/**
+ * Render a C# interface property.
+ *
+ * @example `<InterfaceProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
 export function InterfaceProperty(props) {
   const name = useCSharpNamePolicy().getName(props.name, "class-property");
   const scope = useCSharpScope();
@@ -28,7 +36,7 @@ export function InterfaceProperty(props) {
   const propertyScope = new CSharpMemberScope("property-decl", {
     owner: propertySymbol
   });
-  const modifiers = computeModifiersPrefix([getAccessModifier(props), getMethodModifier(props)]);
+  const modifiers = computeModifiersPrefix([getAccessModifier(props), getModifiers(props)]);
   // note that scope wraps the method decl so that the params get the correct scope
   return _$createComponent(MemberDeclaration, {
     symbol: propertySymbol,
@@ -40,7 +48,7 @@ export function InterfaceProperty(props) {
             get doc() {
               return props.doc;
             }
-          }), modifiers, _$memo(() => props.type), " ", name, " ", _$createComponent(Block, {
+          }), modifiers, _$memo(() => props.type), _$memo(() => props.nullable && "?"), " ", name, " ", _$createComponent(Block, {
             newline: true,
             inline: true,
             get children() {