@alloy-js/csharp 0.18.0-dev.20 → 0.18.0-dev.22

package/src/components/interface/method.test.tsx

@@ -248,3 +248,31 @@ describe("with type parameters", () => {
     `);
   });
 });
+
+describe("formatting", () => {
+  it("Split parameters before type parameters", () => {
+    expect(
+      <Wrapper>
+        <InterfaceMethod
+          public
+          name="Handle"
+          parameters={[
+            {
+              name: "message",
+              type: "Some.Quite.Long.Type.That.Will.Split",
+            },
+          ]}
+          typeParameters={["T"]}
+          returns="Some.Quite.Long.Type.That.Will.Split"
+        />
+      </Wrapper>,
+    ).toRenderTo(`
+      public interface TestInterface
+      {
+        public Some.Quite.Long.Type.That.Will.Split Handle<T>(
+          Some.Quite.Long.Type.That.Will.Split message
+        );
+      }
+    `);
+  });
+});

package/src/components/interface/method.tsx

@@ -15,8 +15,8 @@ import {
 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.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";
@@ -75,9 +75,6 @@ export function InterfaceMethod(props: InterfaceMethodProps) {
     owner: methodSymbol,
   });
 
-  const params =
-    props.parameters ? <Parameters parameters={props.parameters} /> : "";
-
   const modifiers = computeModifiersPrefix([
     getAccessModifier(props),
     getMethodModifier(props),
@@ -92,7 +89,7 @@ export function InterfaceMethod(props: InterfaceMethodProps) {
         {props.typeParameters && (
           <TypeParameters parameters={props.typeParameters} />
         )}
-        ({params})
+        <Parameters parameters={props.parameters} />
         {props.typeParameters && (
           <TypeParameterConstraints parameters={props.typeParameters} />
         )}

package/src/components/{Parameters.tsx → parameters/parameters.tsx}

@@ -1,19 +1,27 @@
-import * as core from "@alloy-js/core";
-import { code } from "@alloy-js/core";
-import { useCSharpNamePolicy } from "../name-policy.js";
-import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
-import { useCSharpScope } from "../symbols/scopes.js";
-import { Name } from "./Name.js";
+import {
+  Children,
+  code,
+  Declaration,
+  For,
+  Indent,
+  OutputSymbol,
+  refkey,
+  Refkey,
+} from "@alloy-js/core";
+import { useCSharpNamePolicy } from "../../name-policy.js";
+import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
+import { useCSharpScope } from "../../symbols/scopes.js";
+import { Name } from "../Name.jsx";
 
 export interface ParameterProps {
   name: string;
-  type: core.Children;
+  type: Children;
   /** If the parmaeter is optional(without default value) */
   optional?: boolean;
   /** Default value for the parameter */
-  default?: core.Children;
-  refkey?: core.Refkey;
-  symbol?: core.OutputSymbol;
+  default?: Children;
+  refkey?: Refkey;
+  symbol?: OutputSymbol;
 }
 
 /** Define a parameter to be used in class or interface method. */
@@ -31,28 +39,36 @@ export function Parameter(props: ParameterProps) {
 
   const memberSymbol = new CSharpOutputSymbol(name, {
     scope,
-    refkeys: props.refkey ?? core.refkey(props.name),
+    refkeys: props.refkey ?? refkey(props.name),
   });
 
   return (
-    <core.Declaration symbol={memberSymbol}>
+    <Declaration symbol={memberSymbol}>
       {props.type}
       {props.optional ? "?" : ""} <Name />
       {props.default ? code` = ${props.default}` : ""}
-    </core.Declaration>
+    </Declaration>
   );
 }
 
 export interface ParametersProps {
-  // param name and type
-  parameters: ParameterProps[];
+  parameters: ParameterProps[] | undefined;
 }
 
-// a collection of parameters
+/** Render a collection of parameters */
 export function Parameters(props: ParametersProps) {
   return (
-    <core.For each={props.parameters} joiner={", "}>
-      {(param) => <Parameter {...param} />}
-    </core.For>
+    <group>
+      {"("}
+      {props.parameters && (
+        <Indent softline>
+          <For each={props.parameters} joiner={", "}>
+            {(param) => <Parameter {...param} />}
+          </For>
+        </Indent>
+      )}
+      <softline />
+      {")"}
+    </group>
   );
 }

package/src/components/property/property.test.tsx

@@ -46,6 +46,7 @@ describe("modifiers", () => {
       "abstract",
       "extern",
       "readonly",
+      "required",
     ] as const)("%s", (methodModifier) => {
       expect(
         <Wrapper>

package/src/components/property/property.tsx

@@ -29,6 +29,11 @@ export interface PropertyModifiers {
   readonly abstract?: boolean;
   readonly extern?: boolean;
   readonly readonly?: boolean;
+  /**
+   * Set required modifier on property
+   * https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/required
+   */
+  readonly required?: boolean;
 }
 
 const getModifiers = makeModifiers<PropertyModifiers>([
@@ -40,6 +45,7 @@ const getModifiers = makeModifiers<PropertyModifiers>([
   "abstract",
   "extern",
   "readonly",
+  "required",
 ]);
 
 /** Properties for {@link Property} component */

package/temp/api.json

@@ -5722,7 +5722,7 @@
             },
             {
               "kind": "Reference",
-              "text": "core.Children",
+              "text": "Children",
               "canonicalReference": "@alloy-js/core!Children:type"
             },
             {
@@ -5730,7 +5730,7 @@
               "text": ";"
             }
           ],
-          "fileUrlPath": "src/components/Parameters.tsx",
+          "fileUrlPath": "src/components/parameters/parameters.tsx",
           "returnTypeTokenRange": {
             "startIndex": 3,
             "endIndex": 4
@@ -5759,7 +5759,7 @@
               "text": "export interface ParameterProps "
             }
           ],
-          "fileUrlPath": "src/components/Parameters.tsx",
+          "fileUrlPath": "src/components/parameters/parameters.tsx",
           "releaseTag": "Public",
           "name": "ParameterProps",
           "preserveMemberOrder": false,
@@ -5775,7 +5775,7 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "core.Children",
+                  "text": "Children",
                   "canonicalReference": "@alloy-js/core!Children:type"
                 },
                 {
@@ -5857,7 +5857,7 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "core.Refkey",
+                  "text": "Refkey",
                   "canonicalReference": "@alloy-js/core!Refkey:type"
                 },
                 {
@@ -5885,7 +5885,7 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "core.OutputSymbol",
+                  "text": "OutputSymbol",
                   "canonicalReference": "@alloy-js/core!OutputSymbol:class"
                 },
                 {
@@ -5913,7 +5913,7 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "core.Children",
+                  "text": "Children",
                   "canonicalReference": "@alloy-js/core!Children:type"
                 },
                 {
@@ -5936,7 +5936,7 @@
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/csharp!Parameters_2:function(1)",
-          "docComment": "",
+          "docComment": "/**\n * Render a collection of parameters\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -5953,7 +5953,7 @@
             },
             {
               "kind": "Reference",
-              "text": "core.Children",
+              "text": "Children",
               "canonicalReference": "@alloy-js/core!Children:type"
             },
             {
@@ -5961,7 +5961,7 @@
               "text": ";"
             }
           ],
-          "fileUrlPath": "src/components/Parameters.tsx",
+          "fileUrlPath": "src/components/parameters/parameters.tsx",
           "returnTypeTokenRange": {
             "startIndex": 3,
             "endIndex": 4
@@ -5990,7 +5990,7 @@
               "text": "export interface ParametersProps "
             }
           ],
-          "fileUrlPath": "src/components/Parameters.tsx",
+          "fileUrlPath": "src/components/parameters/parameters.tsx",
           "releaseTag": "Public",
           "name": "ParametersProps",
           "preserveMemberOrder": false,
@@ -6011,7 +6011,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "[]"
+                  "text": "[] | undefined"
                 },
                 {
                   "kind": "Content",
@@ -6482,6 +6482,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!PropertyModifiers#required:member",
+              "docComment": "/**\n * Set required modifier on property\n * https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/required\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly required?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "required",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!PropertyModifiers#sealed:member",

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

@@ -1,18 +0,0 @@
-import * as core from "@alloy-js/core";
-export interface ParameterProps {
-    name: string;
-    type: core.Children;
-    /** If the parmaeter is optional(without default value) */
-    optional?: boolean;
-    /** Default value for the parameter */
-    default?: core.Children;
-    refkey?: core.Refkey;
-    symbol?: core.OutputSymbol;
-}
-/** Define a parameter to be used in class or interface method. */
-export declare function Parameter(props: ParameterProps): core.Children;
-export interface ParametersProps {
-    parameters: ParameterProps[];
-}
-export declare function Parameters(props: ParametersProps): core.Children;
-//# sourceMappingURL=Parameters.d.ts.map

package/dist/src/components/Parameters.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Parameters.d.ts","sourceRoot":"","sources":["../../../src/components/Parameters.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAOvC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sCAAsC;IACtC,OAAO,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACxB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CAC5B;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,iBAwB9C;AAED,MAAM,WAAW,eAAe;IAE9B,UAAU,EAAE,cAAc,EAAE,CAAC;CAC9B;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,iBAMhD"}

package/dist/src/components/Parameters.js

@@ -1,35 +0,0 @@
-import { memo as _$memo, createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
-import * as core from "@alloy-js/core";
-import { code } from "@alloy-js/core";
-import { useCSharpNamePolicy } from "../name-policy.js";
-import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
-import { useCSharpScope } from "../symbols/scopes.js";
-import { Name } from "./Name.js";
-/** Define a parameter to be used in class or interface method. */
-export function Parameter(props) {
-  const name = useCSharpNamePolicy().getName(props.name, "parameter");
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "constructor-decl" && scope.name !== "method-decl") {
-    throw new Error("can't define a parameter outside of a constructor-decl or method-decl scope");
-  }
-  const memberSymbol = new CSharpOutputSymbol(name, {
-    scope,
-    refkeys: props.refkey ?? core.refkey(props.name)
-  });
-  return _$createComponent(core.Declaration, {
-    symbol: memberSymbol,
-    get children() {
-      return [_$memo(() => props.type), _$memo(() => props.optional ? "?" : ""), " ", _$createComponent(Name, {}), _$memo(() => props.default ? code` = ${props.default}` : "")];
-    }
-  });
-}
-// a collection of parameters
-export function Parameters(props) {
-  return _$createComponent(core.For, {
-    get each() {
-      return props.parameters;
-    },
-    joiner: ", ",
-    children: param => _$createComponent(Parameter, param)
-  });
-}