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

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

@@ -1,24 +1,122 @@
-import { StatementList } from "@alloy-js/core";
-import { expect, it } from "vitest";
+import { List } from "@alloy-js/core";
+import { describe, 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(
+function Wrapper(props: { children: any }) {
+  return (
     <TestNamespace>
       <ClassDeclaration public name="TestClass">
-        <StatementList>
-          <Field public name="MemberOne" type="string" />
-          <Field private name="MemberTwo" type="int" />
-        </StatementList>
+        {props.children}
       </ClassDeclaration>
-    </TestNamespace>,
+    </TestNamespace>
+  );
+}
+it("declares multiple fields", () => {
+  expect(
+    <Wrapper>
+      <List>
+        <Field public name="MemberOne" type="string" />
+        <Field public name="MemberTwo" type="int" />
+      </List>
+    </Wrapper>,
   ).toRenderTo(`
     public class TestClass
     {
       public string MemberOne;
-      private int memberTwo;
+      public int MemberTwo;
+    }
+  `);
+});
+
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"] as const)(
+      "%s",
+      (accessModifier) => {
+        expect(
+          <Wrapper>
+            <Field
+              {...{ [accessModifier]: true }}
+              name="TestProp"
+              type="string"
+            />
+          </Wrapper>,
+        ).toRenderTo(`
+        public class TestClass
+        {
+          ${accessModifier} string ${accessModifier === "private" ? "_testProp" : "TestProp"};
+        }
+      `);
+      },
+    );
+  });
+
+  describe("modifiers", () => {
+    it.each(["new", "static", "readonly", "volatile"] as const)(
+      "%s",
+      (methodModifier) => {
+        expect(
+          <Wrapper>
+            <Field
+              {...{ [methodModifier]: true }}
+              name="TestField"
+              type="string"
+            />
+          </Wrapper>,
+        ).toRenderTo(`
+        public class TestClass
+        {
+          ${methodModifier} string _testField;
+        }
+      `);
+      },
+    );
+  });
+
+  it("combine modifiers", () => {
+    expect(
+      <Wrapper>
+        <Field public new name="TestField" type="string" />
+      </Wrapper>,
+    ).toRenderTo(`
+        public class TestClass
+        {
+          public new string TestField;
+        }
+      `);
+  });
+});
+
+describe("naming", () => {
+  it("public field are PascalCase", () => {
+    expect(
+      <Wrapper>
+        <List>
+          <Field public name="member_one" type="string" />
+        </List>
+      </Wrapper>,
+    ).toRenderTo(`
+      public class TestClass
+      {
+        public string MemberOne;
+      }
+    `);
+  });
+
+  it("private field are camelCase with _ prefix", () => {
+    expect(
+      <Wrapper>
+        <List>
+          <Field private name="member_one" type="string" />
+        </List>
+      </Wrapper>,
+    ).toRenderTo(`
+    public class TestClass
+    {
+      private string _memberOne;
     }
   `);
+  });
 });

package/src/components/field/field.tsx

@@ -3,13 +3,29 @@ import {
   AccessModifiers,
   computeModifiersPrefix,
   getAccessModifier,
+  makeModifiers,
 } 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 {
+/** Field modifiers. */
+export interface FieldModifiers {
+  readonly new?: boolean;
+  readonly static?: boolean;
+  readonly readonly?: boolean;
+  readonly volatile?: boolean;
+}
+
+const getModifiers = makeModifiers<FieldModifiers>([
+  "new",
+  "static",
+  "readonly",
+  "volatile",
+]);
+
+export interface FieldProps extends AccessModifiers, FieldModifiers {
   name: string;
   type: Children;
   refkey?: Refkey;
@@ -20,7 +36,7 @@ export interface FieldProps extends AccessModifiers {
 /** Render a c# field */
 export function Field(props: FieldProps) {
   let nameElement: CSharpElements = "class-member-private";
-  if (props.public) {
+  if (props.public || props.protected || props.internal) {
     nameElement = "class-member-public";
   }
   const name = useCSharpNamePolicy().getName(props.name, nameElement);
@@ -39,12 +55,16 @@ export function Field(props: FieldProps) {
     refkeys: props.refkey ?? refkey(props.name),
   });
 
-  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getModifiers(props),
+  ]);
+
   return (
     <Declaration symbol={memberSymbol}>
       <DocWhen doc={props.doc} />
       {modifiers}
-      {props.type} <Name />
+      {props.type} <Name />;
     </Declaration>
   );
 }

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

@@ -1,4 +1,4 @@
-import { List, refkey, StatementList } from "@alloy-js/core";
+import { List, refkey } from "@alloy-js/core";
 import { describe, expect, it } from "vitest";
 import { TestNamespace } from "../../../test/utils.jsx";
 import { Attribute } from "../attributes/attributes.jsx";
@@ -173,17 +173,17 @@ it("defines fields", () => {
   expect(
     <TestNamespace>
       <StructDeclaration public name="TestClass">
-        <StatementList>
+        <List>
           <Field public name="MemberOne" type="string" />
-          <Field private name="MemberTwo" type="int" />
-        </StatementList>
+          <Field public name="MemberTwo" type="int" />
+        </List>
       </StructDeclaration>
     </TestNamespace>,
   ).toRenderTo(`
     public struct TestClass
     {
       public string MemberOne;
-      private int memberTwo;
+      public int MemberTwo;
     }
   `);
 });

package/src/name-policy.ts

@@ -36,6 +36,8 @@ export function createCSharpNamePolicy(): core.NamePolicy<CSharpElements> {
         return changecase.pascalCase(name);
       case "constant":
         return changecase.constantCase(name);
+      case "class-member-private":
+        return `_${changecase.camelCase(name)}`;
       default:
         return changecase.camelCase(name);
     }

package/temp/api.json

@@ -4096,6 +4096,132 @@
           ],
           "name": "Field"
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/csharp!FieldModifiers:interface",
+          "docComment": "/**\n * Field modifiers.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface FieldModifiers "
+            }
+          ],
+          "fileUrlPath": "src/components/field/field.tsx",
+          "releaseTag": "Public",
+          "name": "FieldModifiers",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldModifiers#new:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly new?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "new",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldModifiers#readonly:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly readonly?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "readonly",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldModifiers#static:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly static?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "static",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!FieldModifiers#volatile:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly volatile?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "volatile",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@alloy-js/csharp!FieldProps:interface",
@@ -4110,6 +4236,15 @@
               "text": "AccessModifiers",
               "canonicalReference": "@alloy-js/csharp!AccessModifiers:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "FieldModifiers",
+              "canonicalReference": "@alloy-js/csharp!FieldModifiers:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -4236,6 +4371,10 @@
             {
               "startIndex": 1,
               "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 4
             }
           ]
         },

package/test/class-declaration.test.tsx

@@ -94,10 +94,10 @@ describe("base", () => {
 it("declares class with some members", () => {
   const res = utils.toSourceText(
     <csharp.ClassDeclaration public name="TestClass">
-      <core.StatementList>
+      <List>
         <Field public name="MemberOne" type="string" />
-        <Field private name="MemberTwo" type="int" />
-      </core.StatementList>
+        <Field public name="MemberTwo" type="int" />
+      </List>
     </csharp.ClassDeclaration>,
   );
 
@@ -107,7 +107,7 @@ it("declares class with some members", () => {
         public class TestClass
         {
             public string MemberOne;
-            private int memberTwo;
+            public int MemberTwo;
         }
     }
   `);
@@ -180,7 +180,6 @@ it("uses refkeys for members, params, and return type", () => {
           <hbr />
           <csharp.ClassDeclaration public name="TestClass">
             <Field private name="MemberOne" type={enumTypeRefkey} />
-            ;
             <hbr />
             <csharp.Method
               public
@@ -208,7 +207,7 @@ it("uses refkeys for members, params, and return type", () => {
         public class TestResult;
         public class TestClass
         {
-            private TestEnum memberOne;
+            private TestEnum _memberOne;
             public TestResult MethodOne(int intParam, TestInput bodyParam)
             {
                 return new TestResult();
@@ -344,9 +343,9 @@ it("declares class with constructor params and assigns values to fields", () =>
   const res = utils.toSourceText(
     <csharp.ClassDeclaration public name="TestClass">
       <Field private name="name" type="string" refkey={thisNameRefkey} />
-      ;<hbr />
+      <hbr />
       <Field private name="size" type="int" refkey={thisSizeRefkey} />
-      ;<hbr />
+      <hbr />
       <Constructor public parameters={ctorParams}>
         {thisNameRefkey} = {paramNameRefkey};<hbr />
         {thisSizeRefkey} = {paramSizeRefkey};
@@ -361,12 +360,12 @@ it("declares class with constructor params and assigns values to fields", () =>
     {
         public class TestClass
         {
-            private string name;
-            private int size;
+            private string _name;
+            private int _size;
             public TestClass(string name, int size)
             {
-                name = name;
-                size = size;
+                _name = name;
+                _size = size;
             }
         }
     }
@@ -396,7 +395,7 @@ it("supports class member doc comments", () => {
     class Test
     {
       /// This is a member
-      public int Member
+      public int Member;
     }
   `);
 });