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

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

@@ -5,6 +5,7 @@ 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";

package/src/components/stc/index.ts

@@ -3,7 +3,7 @@ import * as base from "../index.js";
 
 export const ClassDeclaration = core.stc(base.ClassDeclaration);
 export const Constructor = core.stc(base.Constructor);
-export const ClassMember = core.stc(base.ClassMember);
+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);

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

@@ -1,8 +1,9 @@
-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";
@@ -167,3 +168,32 @@ it("define constructor", () => {
     }
   `);
 });
+
+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} />
       )}

package/temp/api.json

@@ -1078,196 +1078,6 @@
             }
           ]
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@alloy-js/csharp!ClassMember:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function ClassMember(props: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ClassMemberProps",
-              "canonicalReference": "@alloy-js/csharp!ClassMemberProps:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Reference",
-              "text": "core.Children",
-              "canonicalReference": "@alloy-js/core!Children:type"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/components/ClassDeclaration.tsx",
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "props",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "ClassMember"
-        },
-        {
-          "kind": "Interface",
-          "canonicalReference": "@alloy-js/csharp!ClassMemberProps:interface",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface ClassMemberProps extends "
-            },
-            {
-              "kind": "Reference",
-              "text": "AccessModifiers",
-              "canonicalReference": "@alloy-js/csharp!AccessModifiers:interface"
-            },
-            {
-              "kind": "Content",
-              "text": " "
-            }
-          ],
-          "fileUrlPath": "src/components/ClassDeclaration.tsx",
-          "releaseTag": "Public",
-          "name": "ClassMemberProps",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@alloy-js/csharp!ClassMemberProps#doc:member",
-              "docComment": "/**\n * Doc comment\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "doc?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "core.Children",
-                  "canonicalReference": "@alloy-js/core!Children:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "doc",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@alloy-js/csharp!ClassMemberProps#name:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "name: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "name",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@alloy-js/csharp!ClassMemberProps#refkey:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "refkey?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "core.Refkey",
-                  "canonicalReference": "@alloy-js/core!Refkey:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "refkey",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@alloy-js/csharp!ClassMemberProps#type:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "type: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "core.Children",
-                  "canonicalReference": "@alloy-js/core!Children:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "type",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "extendsTokenRanges": [
-            {
-              "startIndex": 1,
-              "endIndex": 2
-            }
-          ]
-        },
         {
           "kind": "Interface",
           "canonicalReference": "@alloy-js/csharp!ClassModifiers:interface",
@@ -4239,6 +4049,196 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/csharp!Field:function(1)",
+          "docComment": "/**\n * Render a c# field\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function Field(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "FieldProps",
+              "canonicalReference": "@alloy-js/csharp!FieldProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!Children:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/components/field/field.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "Field"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/csharp!FieldProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface FieldProps extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "AccessModifiers",
+              "canonicalReference": "@alloy-js/csharp!AccessModifiers:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/components/field/field.tsx",
+          "releaseTag": "Public",
+          "name": "FieldProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldProps#doc:member",
+              "docComment": "/**\n * Doc comment\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "doc?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "doc",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldProps#name:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "name",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldProps#refkey:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "refkey?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Refkey",
+                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "refkey",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldProps#type:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "type",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/csharp!getAccessModifier:function(1)",
@@ -8270,6 +8270,38 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!StructDeclarationProps#interfaceTypes:member",
+              "docComment": "/**\n * Interfaces this struct implements\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "interfaceTypes?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "core.Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "interfaceTypes",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!StructDeclarationProps#name:member",

package/test/class-declaration.test.tsx

@@ -3,15 +3,11 @@ import { List, refkey } from "@alloy-js/core";
 import * as coretest from "@alloy-js/core/testing";
 import { describe, expect, it } from "vitest";
 import { Attribute } from "../src/components/attributes/attributes.jsx";
+import { Field } from "../src/components/field/field.jsx";
 import { Constructor } from "../src/components/stc/index.js";
 import { TypeParameterProps } from "../src/components/type-parameters/type-parameter.jsx";
 import * as csharp from "../src/index.js";
-import {
-  ClassDeclaration,
-  ClassMember,
-  Property,
-  SourceFile,
-} from "../src/index.js";
+import { ClassDeclaration, Property, SourceFile } from "../src/index.js";
 import * as utils from "./utils.jsx";
 
 it("declares class with no members", () => {
@@ -99,8 +95,8 @@ it("declares class with some members", () => {
   const res = utils.toSourceText(
     <csharp.ClassDeclaration public name="TestClass">
       <core.StatementList>
-        <csharp.ClassMember public name="MemberOne" type="string" />
-        <csharp.ClassMember private name="MemberTwo" type="int" />
+        <Field public name="MemberOne" type="string" />
+        <Field private name="MemberTwo" type="int" />
       </core.StatementList>
     </csharp.ClassDeclaration>,
   );
@@ -183,11 +179,7 @@ it("uses refkeys for members, params, and return type", () => {
           />
           <hbr />
           <csharp.ClassDeclaration public name="TestClass">
-            <csharp.ClassMember
-              private
-              name="MemberOne"
-              type={enumTypeRefkey}
-            />
+            <Field private name="MemberOne" type={enumTypeRefkey} />
             ;
             <hbr />
             <csharp.Method
@@ -351,19 +343,9 @@ it("declares class with constructor params and assigns values to fields", () =>
 
   const res = utils.toSourceText(
     <csharp.ClassDeclaration public name="TestClass">
-      <csharp.ClassMember
-        private
-        name="name"
-        type="string"
-        refkey={thisNameRefkey}
-      />
+      <Field private name="name" type="string" refkey={thisNameRefkey} />
       ;<hbr />
-      <csharp.ClassMember
-        private
-        name="size"
-        type="int"
-        refkey={thisSizeRefkey}
-      />
+      <Field private name="size" type="int" refkey={thisSizeRefkey} />
       ;<hbr />
       <Constructor public parameters={ctorParams}>
         {thisNameRefkey} = {paramNameRefkey};<hbr />
@@ -406,7 +388,7 @@ it("supports class member doc comments", () => {
   expect(
     <utils.TestNamespace>
       <ClassDeclaration name="Test" doc="This is a test">
-        <ClassMember name="Member" public type="int" doc="This is a member" />
+        <Field name="Member" public type="int" doc="This is a member" />
       </ClassDeclaration>
     </utils.TestNamespace>,
   ).toRenderTo(`