@alloy-js/csharp 0.21.0-dev.17 → 0.21.0-dev.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alloy-js/csharp",
-  "version": "0.21.0-dev.17",
+  "version": "0.21.0-dev.18",
   "description": "Alloy components for CSharp language.",
   "exports": {
     ".": {

package/src/components/attributes/attributes.test.tsx

@@ -1,3 +1,4 @@
+import { namekey } from "@alloy-js/core";
 import { expect, it } from "vitest";
 import { Attribute, AttributeList } from "./attributes.jsx";
 
@@ -7,6 +8,15 @@ it("define attribute", () => {
   `);
 });
 
+it("define attribute whose name ending with 'Attribute'", () => {
+  expect(<Attribute name="TestAttribute" />).toRenderTo(`
+      [Test]
+  `);
+  expect(<Attribute name={namekey("TestAttribute")} />).toRenderTo(`
+      [Test]
+  `);
+});
+
 it("define attribute with single arg", () => {
   expect(<Attribute name="Test" args={[`"abc"`]} />).toRenderTo(`
       [Test("abc")]

package/src/components/attributes/attributes.tsx

@@ -3,6 +3,7 @@ import {
   findKeyedChildren,
   For,
   Indent,
+  Refkey,
   taggedComponent,
 } from "@alloy-js/core";
 
@@ -54,7 +55,7 @@ function renderAttribute(attr: string | AttributeProps | Children): Children {
 
 export interface AttributeProps {
   /** Attribute name */
-  name: Children;
+  name: string | Refkey;
 
   /** Argument */
   args?: Children[];
@@ -81,7 +82,7 @@ export const Attribute = taggedComponent(
   (props: AttributeProps) => {
     return (
       <group>
-        [{props.name}
+        [{normalizeAttributeName(props.name)}
         {props.args && props.args.length > 0 && (
           <>
             (
@@ -98,3 +99,15 @@ export const Attribute = taggedComponent(
     );
   },
 );
+
+function normalizeAttributeName(name: string | Refkey) {
+  const nameStr =
+    typeof name === "string" ? name
+    : typeof name === "object" && "name" in name ? name.name
+    : undefined;
+
+  if (nameStr !== undefined && nameStr.endsWith("Attribute")) {
+    return nameStr.substring(0, nameStr.length - "Attribute".length);
+  }
+  return name;
+}

package/src/components/parameters/parameters.test.tsx

@@ -148,3 +148,40 @@ it("can attach attributes", () => {
     }
   `);
 });
+
+it("can add modifiers: in | out | ref", () => {
+  expect(
+    <Wrapper>
+      <Method
+        name="MethodOne"
+        parameters={[
+          {
+            name: "param1",
+            type: "T1",
+            ref: true,
+          },
+          {
+            name: "param2",
+            type: "T2",
+            in: true,
+          },
+          {
+            name: "param3",
+            type: "T3",
+            out: true,
+          },
+          {
+            name: "param4",
+            type: "T4",
+            refReadonly: true,
+          },
+        ]}
+      />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+        void MethodOne(ref T1 param1, in T2 param2, out T3 param3, ref readonly T4 param4) {}
+    }
+  `);
+});

package/src/components/parameters/parameters.tsx

@@ -22,6 +22,27 @@ export interface ParameterProps {
 
   refkey?: Refkey;
 
+  /**
+   * Parameter modifier: The argument must be initialized before calling the method. The method can't assign a new value to the parameter. The compiler might create a temporary variable to hold a copy of the argument to in parameters.
+   * @see https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#in-parameter-modifier
+   * */
+  in?: boolean;
+  /**
+   * Parameter modifier: The calling method isn't required to initialize the argument before calling the method. The method must assign a value to the parameter.
+   * @see https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#out-parameter-modifier
+   * */
+  out?: boolean;
+  /**
+   * Parameter modifier: The argument must be initialized before calling the method. The method can assign a new value to the parameter, but isn't required to do so.
+   * @see https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#ref-parameter-modifier
+   */
+  ref?: boolean;
+  /**
+   * Parameter modifier: The argument must be initialized before calling the method. The method can't assign a new value to the parameter.
+   * @see https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#ref-readonly-modifier
+   */
+  refReadonly?: boolean;
+
   /**
    * Define attributes to attach
    * @example
@@ -48,9 +69,26 @@ export function Parameter(props: ParameterProps) {
     isNullable: props.optional,
   });
 
+  // Only one of in, out, ref, ref readonly can be specified
+  const modifiers: (keyof ParameterProps)[] = (
+    ["in", "out", "ref", "refReadonly"] as (keyof ParameterProps)[]
+  ).filter((k) => props[k]);
+
+  if (modifiers.length > 1) {
+    throw new Error(
+      `Only one of 'in', 'out', 'ref', 'ref readonly' can be specified for parameter '${
+        typeof props.name === "string" ? props.name : props.name.name
+      }'`,
+    );
+  }
+  const modifier =
+    modifiers.length === 0 ? ""
+    : modifiers[0] === "refReadonly" ? "ref readonly "
+    : modifiers[0] + " ";
   return (
     <Declaration symbol={memberSymbol}>
       <AttributeList attributes={props.attributes} endline />
+      <>{modifier}</>
       <TypeSlot>{props.type}</TypeSlot>
       {props.optional ? "?" : ""} <Name />
       {props.default ? code` = ${props.default}` : ""}

package/src/create-library.ts

@@ -1,6 +1,7 @@
 import {
   Binder,
   LibrarySymbolReference,
+  namekey,
   refkey,
   REFKEYABLE,
   TO_SYMBOL,
@@ -123,7 +124,7 @@ export function createLibrary<T extends Record<string, Descriptor>>(
                 name,
               )! as NamespaceSymbol;
             } else {
-              ownerSymbol = new NamespaceSymbol(name, ownerSymbol!, {
+              ownerSymbol = new NamespaceSymbol(namekey(name), ownerSymbol!, {
                 binder,
                 refkeys: refkey(),
               });
@@ -213,24 +214,33 @@ function createSymbolFromDescriptor(
       if (ownerSymbol.members.symbolNames.has(name)) {
         return ownerSymbol.members.symbolNames.get(name)! as NamespaceSymbol;
       }
-      return new NamespaceSymbol(name, ownerSymbol as NamespaceSymbol, {
-        binder,
-        refkeys: refkey(),
-        lazyMemberInitializer,
-      });
+      return new NamespaceSymbol(
+        namekey(name),
+        ownerSymbol as NamespaceSymbol,
+        {
+          binder,
+          refkeys: refkey(),
+          lazyMemberInitializer,
+        },
+      );
     case "class":
     case "enum":
     case "interface":
     case "struct":
     case "record":
-      return new NamedTypeSymbol(name, ownerSymbol.members, descriptor.kind, {
-        binder,
-        refkeys: refkey(),
-        lazyMemberInitializer,
-      });
+      return new NamedTypeSymbol(
+        namekey(name),
+        ownerSymbol.members,
+        descriptor.kind,
+        {
+          binder,
+          refkeys: refkey(),
+          lazyMemberInitializer,
+        },
+      );
     case "method":
       return new MethodSymbol(
-        name,
+        namekey(name),
         ownerSymbol.members,
         descriptor.methodKind,
         {
@@ -240,7 +250,7 @@ function createSymbolFromDescriptor(
       );
     case "field":
     case "property":
-      return new CSharpSymbol(name, ownerSymbol.members, {
+      return new CSharpSymbol(namekey(name), ownerSymbol.members, {
         binder,
         refkeys: refkey(),
         type:
@@ -252,7 +262,7 @@ function createSymbolFromDescriptor(
         lazyMemberInitializer,
       });
     case "generic":
-      return new CSharpSymbol(name, ownerSymbol.members, {
+      return new CSharpSymbol(namekey(name), ownerSymbol.members, {
         binder,
         refkeys: refkey(),
       });

package/temp/api.json

@@ -1857,10 +1857,14 @@
                   "kind": "Content",
                   "text": "name: "
                 },
+                {
+                  "kind": "Content",
+                  "text": "string | "
+                },
                 {
                   "kind": "Reference",
-                  "text": "Children",
-                  "canonicalReference": "@alloy-js/core!Children:type"
+                  "text": "Refkey",
+                  "canonicalReference": "@alloy-js/core!Refkey:type"
                 },
                 {
                   "kind": "Content",
@@ -1873,7 +1877,7 @@
               "name": "name",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               }
             }
           ],
@@ -13690,6 +13694,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ParameterProps#in:member",
+              "docComment": "/**\n * Parameter modifier: The argument must be initialized before calling the method. The method can't assign a new value to the parameter. The compiler might create a temporary variable to hold a copy of the argument to in parameters.\n *\n * @see\n *\n *  https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#in-parameter-modifier\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "in?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "in",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!ParameterProps#name:member",
@@ -13749,6 +13780,60 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ParameterProps#out:member",
+              "docComment": "/**\n * Parameter modifier: The calling method isn't required to initialize the argument before calling the method. The method must assign a value to the parameter.\n *\n * @see\n *\n *  https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#out-parameter-modifier\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "out?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "out",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ParameterProps#ref:member",
+              "docComment": "/**\n * Parameter modifier: The argument must be initialized before calling the method. The method can assign a new value to the parameter, but isn't required to do so.\n *\n * @see\n *\n *  https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#ref-parameter-modifier\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "ref?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "ref",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!ParameterProps#refkey:member",
@@ -13777,6 +13862,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ParameterProps#refReadonly:member",
+              "docComment": "/**\n * Parameter modifier: The argument must be initialized before calling the method. The method can't assign a new value to the parameter.\n *\n * @see\n *\n *  https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/method-parameters#ref-readonly-modifier\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "refReadonly?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "refReadonly",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!ParameterProps#type:member",