@alloy-js/csharp 0.19.0-dev.2 → 0.19.0-dev.5

package/src/components/ClassDeclaration.tsx

@@ -6,13 +6,12 @@ import {
   getAccessModifier,
   makeModifiers,
 } from "../modifiers.js";
-import { CSharpElements, useCSharpNamePolicy } from "../name-policy.js";
+import { useCSharpNamePolicy } from "../name-policy.js";
 import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
-import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
+import { CSharpMemberScope } from "../symbols/scopes.js";
 import { AttributeList, AttributesProp } from "./attributes/attributes.jsx";
 import { DocWhen } from "./doc/comment.jsx";
 import { Name } from "./Name.jsx";
-import { ParameterProps, Parameters } from "./parameters/parameters.jsx";
 import { TypeParameterConstraints } from "./type-parameters/type-parameter-constraints.jsx";
 import { TypeParameterProps } from "./type-parameters/type-parameter.jsx";
 import { TypeParameters } from "./type-parameters/type-parameters.jsx";
@@ -150,84 +149,3 @@ export function ClassDeclaration(props: ClassDeclarationProps) {
     </core.Declaration>
   );
 }
-
-export interface ClassConstructorProps extends AccessModifiers {
-  parameters?: Array<ParameterProps>;
-  refkey?: core.Refkey;
-  symbol?: core.OutputSymbol;
-  children?: core.Children;
-}
-
-// a C# class constructor
-export function ClassConstructor(props: ClassConstructorProps) {
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "class-decl") {
-    throw new Error(
-      "can't define a class constructor outside of a class-decl scope",
-    );
-  }
-
-  // fetch the class name from the scope
-  const name = useCSharpNamePolicy().getName(scope.owner!.name, "class-method");
-  const ctorSymbol = new CSharpOutputSymbol(name, {
-    scope,
-    refkeys: props.refkey ?? core.refkey(name),
-  });
-
-  // scope for ctor declaration
-  const ctorDeclScope = new CSharpMemberScope("constructor-decl", {
-    owner: ctorSymbol,
-  });
-
-  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
-
-  // note that scope wraps the ctor decl so that the params get the correct scope
-  return (
-    <core.Declaration symbol={ctorSymbol}>
-      <core.Scope value={ctorDeclScope}>
-        {modifiers}
-        <Name />
-        <Parameters parameters={props.parameters} />
-        <core.Block newline>{props.children}</core.Block>
-      </core.Scope>
-    </core.Declaration>
-  );
-}
-
-// properties for creating a class member
-export interface ClassMemberProps extends AccessModifiers {
-  name: string;
-  type: core.Children;
-  refkey?: core.Refkey;
-  /** Doc comment */
-  doc?: core.Children;
-}
-
-// a C# class member (i.e. a field within a class like "private int count")
-export function ClassMember(props: ClassMemberProps) {
-  let nameElement: CSharpElements = "class-member-private";
-  if (props.public) {
-    nameElement = "class-member-public";
-  }
-  const name = useCSharpNamePolicy().getName(props.name, nameElement);
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "class-decl") {
-    throw new Error(
-      "can't define a class member outside of a class-decl scope",
-    );
-  }
-
-  const memberSymbol = new CSharpOutputSymbol(name, {
-    scope,
-    refkeys: props.refkey ?? core.refkey(props.name),
-  });
-
-  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
-  return (
-    <core.Declaration symbol={memberSymbol}>
-      <DocWhen doc={props.doc} />
-      {modifiers}
-      {props.type} <Name />
-    </core.Declaration>
-  );
-}

package/src/components/constructor/constructor.test.tsx

@@ -0,0 +1,41 @@
+import { refkey } from "@alloy-js/core";
+import { expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { ClassDeclaration } from "../ClassDeclaration.jsx";
+import { SourceFile } from "../SourceFile.jsx";
+import { Constructor } from "./constructor.jsx";
+
+it("reference constructor parameters in body", () => {
+  const paramNameRefkey = refkey();
+  const paramSizeRefkey = refkey();
+
+  const ctorParams = [
+    { name: "name", type: "string", refkey: paramNameRefkey },
+    { name: "size", type: "int", refkey: paramSizeRefkey },
+  ];
+
+  expect(
+    <TestNamespace>
+      <SourceFile path="Test.cs">
+        <ClassDeclaration public name="TestClass">
+          <Constructor public parameters={ctorParams}>
+            {paramNameRefkey};<hbr />
+            {paramSizeRefkey};
+          </Constructor>
+        </ClassDeclaration>
+      </SourceFile>
+    </TestNamespace>,
+  ).toRenderTo(`
+    namespace TestCode
+    {
+        public class TestClass
+        {
+            public TestClass(string name, int size)
+            {
+                name;
+                size;
+            }
+        }
+    }
+  `);
+});

package/src/components/constructor/constructor.tsx

@@ -0,0 +1,67 @@
+import {
+  Block,
+  Declaration,
+  Name,
+  Refkey,
+  refkey,
+  Scope,
+} from "@alloy-js/core";
+import { Children } from "@alloy-js/core/jsx-runtime";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+} 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 { ParameterProps, Parameters } from "../parameters/parameters.jsx";
+
+/**
+ * Properties for {@link Constructor} component.
+ */
+export interface ConstructorProps extends AccessModifiers {
+  /** Constructor parameters */
+  parameters?: ParameterProps[];
+
+  /** Refkey */
+  refkey?: Refkey;
+
+  /** Constructor body */
+  children?: Children;
+}
+
+export function Constructor(props: ConstructorProps) {
+  const scope = useCSharpScope();
+  if (
+    scope.kind !== "member" ||
+    (scope.name !== "class-decl" && scope.name !== "struct-decl")
+  ) {
+    throw new Error(
+      "can't define a class method outside of a class or struct scope",
+    );
+  }
+
+  const name = useCSharpNamePolicy().getName(scope.owner!.name, "class-method");
+  const ctorSymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(name),
+  });
+
+  const ctorDeclScope = new CSharpMemberScope("constructor-decl", {
+    owner: ctorSymbol,
+  });
+
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
+
+  return (
+    <Declaration symbol={ctorSymbol}>
+      <Scope value={ctorDeclScope}>
+        {modifiers}
+        <Name />
+        <Parameters parameters={props.parameters} />
+        <Block newline>{props.children}</Block>
+      </Scope>
+    </Declaration>
+  );
+}

package/src/components/field/field.test.tsx

@@ -0,0 +1,24 @@
+import { StatementList } from "@alloy-js/core";
+import { expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { ClassDeclaration } from "../ClassDeclaration.jsx";
+import { Field } from "./field.jsx";
+
+it("declares some field", () => {
+  expect(
+    <TestNamespace>
+      <ClassDeclaration public name="TestClass">
+        <StatementList>
+          <Field public name="MemberOne" type="string" />
+          <Field private name="MemberTwo" type="int" />
+        </StatementList>
+      </ClassDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      public string MemberOne;
+      private int memberTwo;
+    }
+  `);
+});

package/src/components/field/field.tsx

@@ -0,0 +1,50 @@
+import { Children, Declaration, Name, refkey, Refkey } from "@alloy-js/core";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+} from "../../modifiers.js";
+import { CSharpElements, useCSharpNamePolicy } from "../../name-policy.js";
+import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
+import { useCSharpScope } from "../../symbols/scopes.js";
+import { DocWhen } from "../doc/comment.jsx";
+
+export interface FieldProps extends AccessModifiers {
+  name: string;
+  type: Children;
+  refkey?: Refkey;
+  /** Doc comment */
+  doc?: Children;
+}
+
+/** Render a c# field */
+export function Field(props: FieldProps) {
+  let nameElement: CSharpElements = "class-member-private";
+  if (props.public) {
+    nameElement = "class-member-public";
+  }
+  const name = useCSharpNamePolicy().getName(props.name, nameElement);
+  const scope = useCSharpScope();
+  if (
+    scope.kind !== "member" ||
+    (scope.name !== "class-decl" && scope.name !== "struct-decl")
+  ) {
+    throw new Error(
+      "can't define a class member outside of a class or struct scope",
+    );
+  }
+
+  const memberSymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name),
+  });
+
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
+  return (
+    <Declaration symbol={memberSymbol}>
+      <DocWhen doc={props.doc} />
+      {modifiers}
+      {props.type} <Name />
+    </Declaration>
+  );
+}

package/src/components/index.ts

@@ -1,13 +1,15 @@
 export * from "./attributes/attributes.jsx";
 export * from "./ClassDeclaration.jsx";
-export * from "./ClassMethod.jsx";
+export * from "./constructor/constructor.jsx";
 export * from "./Declaration.js";
 export * from "./doc/comment.jsx";
 export * from "./doc/from-markdown.jsx";
 export * from "./EnumDeclaration.jsx";
+export * from "./field/field.jsx";
 export * from "./interface/declaration.js";
 export * from "./interface/method.js";
 export * from "./interface/property.js";
+export * from "./method/method.jsx";
 export * from "./Name.js";
 export * from "./Namespace.js";
 export * from "./parameters/parameters.jsx";

package/{test/class-method.test.tsx → src/components/method/method.test.tsx}

@@ -1,7 +1,7 @@
 import { Children } from "@alloy-js/core/jsx-runtime";
 import { describe, expect, it } from "vitest";
-import { ClassDeclaration, ClassMethod } from "../src/index.js";
-import { TestNamespace } from "./utils.jsx";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { ClassDeclaration, Method } from "../../index.js";
 
 const Wrapper = (props: { children: Children }) => (
   <TestNamespace>
@@ -18,7 +18,7 @@ describe("modifiers", () => {
       (accessModifier) => {
         expect(
           <Wrapper>
-            <ClassMethod {...{ [accessModifier]: true }} name="MethodOne" />
+            <Method {...{ [accessModifier]: true }} name="MethodOne" />
           </Wrapper>,
         ).toRenderTo(`
         public class TestClass
@@ -36,7 +36,7 @@ describe("modifiers", () => {
       (methodModifier) => {
         expect(
           <Wrapper>
-            <ClassMethod {...{ [methodModifier]: true }} name="MethodOne" />
+            <Method {...{ [methodModifier]: true }} name="MethodOne" />
           </Wrapper>,
         ).toRenderTo(`
         public class TestClass
@@ -50,7 +50,7 @@ describe("modifiers", () => {
     it("abstract exclude body", () => {
       expect(
         <Wrapper>
-          <ClassMethod abstract name="MethodOne" />
+          <Method abstract name="MethodOne" />
         </Wrapper>,
       ).toRenderTo(`
         public class TestClass
@@ -64,7 +64,7 @@ describe("modifiers", () => {
   it("mark method async", () => {
     expect(
       <Wrapper>
-        <ClassMethod async name="MethodOne" />
+        <Method async name="MethodOne" />
       </Wrapper>,
     ).toRenderTo(`
         public class TestClass
@@ -77,7 +77,7 @@ describe("modifiers", () => {
   it("combine modifiers", () => {
     expect(
       <Wrapper>
-        <ClassMethod async returns="Task" public abstract name="MethodOne" />
+        <Method async returns="Task" public abstract name="MethodOne" />
       </Wrapper>,
     ).toRenderTo(`
         public class TestClass
@@ -91,7 +91,7 @@ describe("modifiers", () => {
 it("applies PascalCase naming policy", () => {
   expect(
     <Wrapper>
-      <ClassMethod name="method_one" />
+      <Method name="method_one" />
     </Wrapper>,
   ).toRenderTo(`
     public class TestClass
@@ -113,12 +113,7 @@ it("defines params and return type", () => {
   ];
   const res = (
     <Wrapper>
-      <ClassMethod
-        public
-        name="MethodOne"
-        parameters={params}
-        returns="string"
-      />
+      <Method public name="MethodOne" parameters={params} returns="string" />
     </Wrapper>
   );
 
@@ -134,7 +129,7 @@ it("specify doc comment", () => {
   expect(
     <TestNamespace>
       <ClassDeclaration name="Test">
-        <ClassMethod name="Method" doc="This is a test" />
+        <Method name="Method" doc="This is a test" />
       </ClassDeclaration>
     </TestNamespace>,
   ).toRenderTo(`
@@ -150,9 +145,9 @@ it("use expression body form", () => {
   expect(
     <TestNamespace>
       <ClassDeclaration name="Test">
-        <ClassMethod name="Method" doc="This is a test" expression>
+        <Method name="Method" doc="This is a test" expression>
           this.MyProperty.Value;
-        </ClassMethod>
+        </Method>
       </ClassDeclaration>
     </TestNamespace>,
   ).toRenderTo(`

package/src/components/{ClassMethod.tsx → method/method.tsx}

@@ -12,26 +12,26 @@ import {
   getAccessModifier,
   getAsyncModifier,
   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 { AttributeList, AttributesProp } from "./attributes/attributes.jsx";
-import { DocWhen } from "./doc/comment.jsx";
-import { ParameterProps, Parameters } from "./parameters/parameters.jsx";
-import { TypeParameterConstraints } from "./type-parameters/type-parameter-constraints.jsx";
-import { TypeParameterProps } from "./type-parameters/type-parameter.jsx";
-import { TypeParameters } from "./type-parameters/type-parameters.jsx";
+} 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 { AttributeList, AttributesProp } from "../attributes/attributes.jsx";
+import { DocWhen } from "../doc/comment.jsx";
+import { ParameterProps, Parameters } from "../parameters/parameters.jsx";
+import { TypeParameterConstraints } from "../type-parameters/type-parameter-constraints.jsx";
+import { TypeParameterProps } from "../type-parameters/type-parameter.jsx";
+import { TypeParameters } from "../type-parameters/type-parameters.jsx";
 
 /** Method modifiers. Can only be one. */
-export interface ClassMethodModifiers {
+export interface MethodModifiers {
   readonly abstract?: boolean;
   readonly sealed?: boolean;
   readonly static?: boolean;
   readonly virtual?: boolean;
 }
 
-const getMethodModifier = makeModifiers<ClassMethodModifiers>([
+const getMethodModifier = makeModifiers<MethodModifiers>([
   "abstract",
   "sealed",
   "static",
@@ -39,9 +39,7 @@ const getMethodModifier = makeModifiers<ClassMethodModifiers>([
 ]);
 
 // properties for creating a method
-export interface ClassMethodProps
-  extends AccessModifiers,
-    ClassMethodModifiers {
+export interface MethodProps extends AccessModifiers, MethodModifiers {
   name: string;
   refkey?: Refkey;
   children?: Children;
@@ -105,11 +103,16 @@ export interface ClassMethodProps
 }
 
 // a C# class method
-export function ClassMethod(props: ClassMethodProps) {
+export function Method(props: MethodProps) {
   const name = useCSharpNamePolicy().getName(props.name, "class-method");
   const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "class-decl") {
-    throw new Error("can't define a class method outside of a class scope");
+  if (
+    scope.kind !== "member" ||
+    (scope.name !== "class-decl" && scope.name !== "struct-decl")
+  ) {
+    throw new Error(
+      "can't define a class method outside of a class or struct scope",
+    );
   }
 
   const methodSymbol = new CSharpOutputSymbol(name, {

package/src/components/stc/index.ts

@@ -2,9 +2,9 @@ import * as core from "@alloy-js/core";
 import * as base from "../index.js";
 
 export const ClassDeclaration = core.stc(base.ClassDeclaration);
-export const ClassConstructor = core.stc(base.ClassConstructor);
-export const ClassMember = core.stc(base.ClassMember);
-export const ClassMethod = core.stc(base.ClassMethod);
+export const Constructor = core.stc(base.Constructor);
+export const Field = core.stc(base.Field);
+export const ClassMethod = core.stc(base.Method);
 export const EnumDeclaration = core.stc(base.EnumDeclaration);
 export const EnumMember = core.stc(base.EnumMember);
 export const Parameter = core.stc(base.Parameter);

package/src/components/struct/declaration.test.tsx

@@ -1,7 +1,10 @@
-import { List, refkey } from "@alloy-js/core";
+import { List, refkey, StatementList } from "@alloy-js/core";
 import { describe, expect, it } from "vitest";
 import { TestNamespace } from "../../../test/utils.jsx";
 import { Attribute } from "../attributes/attributes.jsx";
+import { Constructor } from "../constructor/constructor.jsx";
+import { Field } from "../field/field.jsx";
+import { Method } from "../method/method.jsx";
 import { Property } from "../property/property.jsx";
 import { SourceFile } from "../SourceFile.jsx";
 import { TypeParameterProps } from "../type-parameters/type-parameter.jsx";
@@ -135,3 +138,62 @@ it("specify attributes", () => {
     struct Test;
   `);
 });
+
+it("define methods", () => {
+  expect(
+    <TestNamespace>
+      <StructDeclaration name="Test">
+        <Method name="MethodOne" />
+      </StructDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    struct Test
+    {
+      void MethodOne() {}
+    }
+  `);
+});
+
+it("define constructor", () => {
+  expect(
+    <TestNamespace>
+      <StructDeclaration name="Test">
+        <Constructor public />
+      </StructDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    struct Test
+    {
+      public Test() {}
+    }
+  `);
+});
+
+it("defines fields", () => {
+  expect(
+    <TestNamespace>
+      <StructDeclaration public name="TestClass">
+        <StatementList>
+          <Field public name="MemberOne" type="string" />
+          <Field private name="MemberTwo" type="int" />
+        </StatementList>
+      </StructDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    public struct TestClass
+    {
+      public string MemberOne;
+      private int memberTwo;
+    }
+  `);
+});
+
+it("define multiple interface types", () => {
+  expect(
+    <TestNamespace>
+      <StructDeclaration name="Test" interfaceTypes={["Foo", "Bar"]} />
+    </TestNamespace>,
+  ).toRenderTo(`
+      struct Test : Foo, Bar;
+  `);
+});

package/src/components/struct/declaration.tsx

@@ -1,4 +1,5 @@
 import * as core from "@alloy-js/core";
+import { join } from "@alloy-js/core";
 import {
   AccessModifiers,
   computeModifiersPrefix,
@@ -71,6 +72,9 @@ export interface StructDeclarationProps
    * ```
    */
   attributes?: AttributesProp;
+
+  /** Interfaces this struct implements */
+  interfaceTypes?: core.Children[];
 }
 
 /**
@@ -108,6 +112,12 @@ export function StructDeclaration(props: StructDeclarationProps) {
     getAccessModifier(props),
     getStructModifiers(props),
   ]);
+
+  const base =
+    props.interfaceTypes && props.interfaceTypes.length > 0 ?
+      <> : {join(props.interfaceTypes, { joiner: ", " })}</>
+    : null;
+
   return (
     <core.Declaration symbol={thisStructSymbol}>
       <DocWhen doc={props.doc} />
@@ -116,6 +126,7 @@ export function StructDeclaration(props: StructDeclarationProps) {
       {props.typeParameters && (
         <TypeParameters parameters={props.typeParameters} />
       )}
+      {base}
       {props.typeParameters && (
         <TypeParameterConstraints parameters={props.typeParameters} />
       )}