@alloy-js/csharp 0.18.0-dev.6 → 0.18.0-dev.8

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

@@ -0,0 +1,120 @@
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { InterfaceDeclaration } from "./declaration.jsx";
+import { InterfaceMethod } from "./method.jsx";
+
+const Wrapper = (props: { children: Children }) => (
+  <TestNamespace>
+    <InterfaceDeclaration public name="TestInterface">
+      {props.children}
+    </InterfaceDeclaration>
+  </TestNamespace>
+);
+
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"] as const)(
+      "%s",
+      (accessModifier) => {
+        expect(
+          <Wrapper>
+            <InterfaceMethod {...{ [accessModifier]: true }} name="MethodOne" />
+          </Wrapper>,
+        ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${accessModifier} void MethodOne();
+        }
+      `);
+      },
+    );
+  });
+
+  describe("method modifiers", () => {
+    it.each(["new"] as const)("%s", (methodModifier) => {
+      expect(
+        <Wrapper>
+          <InterfaceMethod {...{ [methodModifier]: true }} name="MethodOne" />
+        </Wrapper>,
+      ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${methodModifier} void MethodOne();
+        }
+      `);
+    });
+  });
+
+  it("combine modifiers", () => {
+    expect(
+      <Wrapper>
+        <InterfaceMethod returns="Task" public new name="MethodOne" />
+      </Wrapper>,
+    ).toRenderTo(`
+        public interface TestInterface
+        {
+          public new Task MethodOne();
+        }
+      `);
+  });
+});
+
+it("applies PascalCase naming policy", () => {
+  expect(
+    <Wrapper>
+      <InterfaceMethod name="method_one" />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      void MethodOne();
+    }
+`);
+});
+
+it("defines params and return type", () => {
+  const params = [
+    {
+      name: "intParam",
+      type: "int",
+    },
+    {
+      name: "stringParam",
+      type: "string",
+    },
+  ];
+  const res = (
+    <Wrapper>
+      <InterfaceMethod
+        public
+        name="MethodOne"
+        parameters={params}
+        returns="string"
+      />
+    </Wrapper>
+  );
+
+  expect(res).toRenderTo(`
+    public interface TestInterface
+    {
+      public string MethodOne(int intParam, string stringParam);
+    }
+  `);
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <InterfaceDeclaration name="Test">
+        <InterfaceMethod name="Method" doc="This is a test" />
+      </InterfaceDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      void Method();
+    }
+  `);
+});

package/src/components/interface/method.tsx

@@ -0,0 +1,82 @@
+import {
+  Block,
+  Children,
+  MemberDeclaration,
+  refkey,
+  Refkey,
+  Scope,
+} from "@alloy-js/core";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+  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 { ParameterProps, Parameters } from "../Parameters.jsx";
+import { DocWhen } from "../doc/comment.jsx";
+
+/** Method modifiers. Can only be one. */
+export interface InterfaceMethodModifiers {
+  readonly new?: boolean;
+}
+
+const getMethodModifier = makeModifiers<InterfaceMethodModifiers>(["new"]);
+
+// properties for creating a method
+export interface InterfaceMethodProps
+  extends AccessModifiers,
+    InterfaceMethodModifiers {
+  name: string;
+  refkey?: Refkey;
+  children?: Children;
+  parameters?: Array<ParameterProps>;
+  returns?: Children;
+
+  /** Doc comment */
+  doc?: Children;
+}
+
+// a C# interface method
+export function InterfaceMethod(props: InterfaceMethodProps) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-method");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "interface-decl") {
+    throw new Error(
+      "can't define an interface method outside of an interface scope",
+    );
+  }
+
+  const methodSymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name),
+  });
+
+  // scope for method declaration
+  const methodScope = new CSharpMemberScope("method-decl", {
+    owner: methodSymbol,
+  });
+
+  const params =
+    props.parameters ? <Parameters parameters={props.parameters} /> : "";
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getMethodModifier(props),
+  ]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return (
+    <MemberDeclaration symbol={methodSymbol}>
+      <Scope value={methodScope}>
+        <DocWhen doc={props.doc} />
+        {modifiers}
+        {props.returns ?? "void"} {name}({params})
+        {props.children ?
+          <Block newline>{props.children}</Block>
+        : ";"}
+      </Scope>
+    </MemberDeclaration>
+  );
+}

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

@@ -0,0 +1,144 @@
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { InterfaceDeclaration } from "./declaration.jsx";
+import { InterfaceProperty } from "./property.jsx";
+
+const Wrapper = (props: { children: Children }) => (
+  <TestNamespace>
+    <InterfaceDeclaration public name="TestInterface">
+      {props.children}
+    </InterfaceDeclaration>
+  </TestNamespace>
+);
+
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"] as const)(
+      "%s",
+      (accessModifier) => {
+        expect(
+          <Wrapper>
+            <InterfaceProperty
+              {...{ [accessModifier]: true }}
+              name="TestProp"
+              type="string"
+              get
+            />
+          </Wrapper>,
+        ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${accessModifier} string TestProp { get; }
+        }
+      `);
+      },
+    );
+  });
+
+  describe("method modifiers", () => {
+    it.each(["new"] as const)("%s", (methodModifier) => {
+      expect(
+        <Wrapper>
+          <InterfaceProperty
+            {...{ [methodModifier]: true }}
+            name="TestProp"
+            type="string"
+            get
+          />
+        </Wrapper>,
+      ).toRenderTo(`
+        public interface TestInterface
+        {
+          ${methodModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+
+  it("combine modifiers", () => {
+    expect(
+      <Wrapper>
+        <InterfaceProperty public new name="TestProp" type="string" get />
+      </Wrapper>,
+    ).toRenderTo(`
+        public interface TestInterface
+        {
+          public new string TestProp { get; }
+        }
+      `);
+  });
+});
+
+it("applies PascalCase naming policy", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="test_prop" type="string" get />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { get; }
+    }
+`);
+});
+
+it("has getter only", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="TestProp" type="string" get />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { get; }
+    }
+  `);
+});
+
+it("has setter only", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="TestProp" type="string" set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { set; }
+    }
+  `);
+});
+it("has getter and setter", () => {
+  expect(
+    <Wrapper>
+      <InterfaceProperty name="TestProp" type="string" get set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public interface TestInterface
+    {
+      string TestProp { get; set; }
+    }
+  `);
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <InterfaceDeclaration name="Test">
+        <InterfaceProperty
+          name="Method"
+          type="string"
+          get
+          set
+          doc="This is a test"
+        />
+      </InterfaceDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    interface Test
+    {
+      /// This is a test
+      string Method { get; set; }
+    }
+  `);
+});

package/src/components/interface/property.tsx

@@ -0,0 +1,90 @@
+import {
+  Block,
+  Children,
+  List,
+  MemberDeclaration,
+  refkey,
+  Refkey,
+  Scope,
+} from "@alloy-js/core";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+  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 { DocWhen } from "../doc/comment.jsx";
+
+/** Method modifiers. Can only be one. */
+export interface InterfacePropertyModifiers {
+  readonly new?: boolean;
+}
+
+export const getMethodModifier = makeModifiers<InterfacePropertyModifiers>([
+  "new",
+]);
+
+// properties for creating a method
+export interface InterfacePropertyProps
+  extends AccessModifiers,
+    InterfacePropertyModifiers {
+  name: string;
+  refkey?: Refkey;
+
+  /** Property type */
+  type: Children;
+
+  /** If property should have a getter */
+  get?: boolean;
+
+  /** If property should have a setter */
+  set?: boolean;
+
+  /** Doc comment */
+  doc?: Children;
+}
+
+// a C# interface property
+export function InterfaceProperty(props: InterfacePropertyProps) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-property");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "interface-decl") {
+    throw new Error(
+      "can't define an interface method outside of an interface scope",
+    );
+  }
+
+  const propertySymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name),
+  });
+
+  // scope for property declaration
+  const propertyScope = new CSharpMemberScope("property-decl", {
+    owner: propertySymbol,
+  });
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getMethodModifier(props),
+  ]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return (
+    <MemberDeclaration symbol={propertySymbol}>
+      <Scope value={propertyScope}>
+        <DocWhen doc={props.doc} />
+        {modifiers}
+        {props.type} {name}{" "}
+        <Block newline inline>
+          <List joiner=" ">
+            {props.get && "get;"}
+            {props.set && "set;"}
+          </List>
+        </Block>
+      </Scope>
+    </MemberDeclaration>
+  );
+}

package/src/modifiers.ts

@@ -18,21 +18,6 @@ export const getAccessModifier = makeModifiers<AccessModifiers>([
   "file",
 ]);
 
-/** Method modifiers. Can only be one. */
-export interface MethodModifiers {
-  readonly abstract?: boolean;
-  readonly sealed?: boolean;
-  readonly static?: boolean;
-  readonly virtual?: boolean;
-}
-
-export const getMethodModifier = makeModifiers<MethodModifiers>([
-  "abstract",
-  "sealed",
-  "static",
-  "virtual",
-]);
-
 export function getAsyncModifier(async?: boolean): string {
   return async ? "async" : "";
 }

package/src/name-policy.ts

@@ -12,6 +12,7 @@ export type CSharpElements =
   | "class-member-private"
   | "class-member-public"
   | "class-method"
+  | "class-property"
   | "parameter"
   | "type-parameter";
 
@@ -26,6 +27,7 @@ export function createCSharpNamePolicy(): core.NamePolicy<CSharpElements> {
       case "class-member-public":
       case "class-method":
       case "type-parameter":
+      case "class-property":
         return changecase.pascalCase(name);
       case "constant":
         return changecase.constantCase(name);