feat: generate basic jsdocs

Author: pi0

.prettierignore

@@ -7,3 +7,4 @@ playground/*.ts
 playground/*.d.ts
 playground/*.js
 
+src/capnp/_capnp/*.ts

README.md

@@ -77,6 +77,7 @@ This project is a rework of [jdiaz5513/capnp-ts](https://github.com/jdiaz5513/ca
 - RPC level-1 merged from [jdiaz5513/capnp-ts#169](https://github.com/jdiaz5513/capnp-ts/pull/169).
 - List interface implements [`Array` object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) (custom methods removed).
 - Pointers had been improved to feel (inspected and serialized) like native JS values as much as possible.
+- Basic JSDocs generated for class and getter
 
 </details>
 

eslint.config.mjs

@@ -1,7 +1,7 @@
 import unjs from "eslint-config-unjs";
 
 export default unjs({
-  ignores: ["test/fixtures/*.*"],
+  ignores: ["test/fixtures/*.*", "src/capnp/_capnp/*.ts"],
   rules: {
     "unicorn/prefer-code-point": 0,
     "unicorn/no-null": 0,

src/capnp/_capnp/.gitignore

@@ -0,0 +1 @@
+*.ts

src/capnp/_capnp/cpp.capnp

@@ -21,7 +21,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-@0xbdf87d7bb8304e81;
+@0xbdf87d7bb8304e82;
+# original: @0xbdf87d7bb8304e81;
 $namespace("capnp::annotations");
 
 annotation namespace(file): Text;

src/capnp/persistent.ts

@@ -1,5 +1,8 @@
-import * as $ from "../serialization";
+import * as $ from "..";
 export const _capnpFileId = BigInt("0xb8630836983feed7");
+/**
+ * Schema for member of an enum.
+ * */
 export class Persistent_SaveParams extends $.Struct {
   static readonly _capnp = {
     displayName: "SaveParams",
@@ -50,9 +53,74 @@ export class Persistent_SaveResults extends $.Struct {
     return "Persistent_SaveResults_" + super.toString();
   }
 }
-export class Persistent extends $.Struct {
+export class Persistent_SaveResults$Promise {
+  pipeline: $.Pipeline<any, any, Persistent_SaveResults>;
+  constructor(pipeline: $.Pipeline<any, any, Persistent_SaveResults>) {
+    this.pipeline = pipeline;
+  }
+  async promise(): Promise<Persistent_SaveResults> {
+    return await this.pipeline.struct();
+  }
+}
+export class Persistent$Client {
+  client: $.Client;
+  static readonly interfaceId: bigint = BigInt("0xc8cb212fcd9f5691");
+  constructor(client: $.Client) {
+    this.client = client;
+  }
+  static readonly methods: [
+    $.Method<Persistent_SaveParams, Persistent_SaveResults>,
+  ] = [
+    {
+      ParamsClass: Persistent_SaveParams,
+      ResultsClass: Persistent_SaveResults,
+      interfaceId: Persistent$Client.interfaceId,
+      methodId: 0,
+      interfaceName: "src/capnp/_capnp/persistent.capnp:Persistent",
+      methodName: "save",
+    },
+  ];
+  save(
+    paramsFunc?: (params: Persistent_SaveParams) => void,
+  ): Persistent_SaveResults$Promise {
+    const answer = this.client.call({
+      method: Persistent$Client.methods[0],
+      paramsFunc: paramsFunc,
+    });
+    const pipeline = new $.Pipeline(Persistent_SaveResults, answer);
+    return new Persistent_SaveResults$Promise(pipeline);
+  }
+}
+$.Registry.register(Persistent$Client.interfaceId, Persistent$Client);
+export interface Persistent$Server$Target {
+  save(
+    params: Persistent_SaveParams,
+    results: Persistent_SaveResults,
+  ): Promise<void>;
+}
+export class Persistent$Server extends $.Server {
+  readonly target: Persistent$Server$Target;
+  constructor(target: Persistent$Server$Target) {
+    super(target, [
+      {
+        ...Persistent$Client.methods[0],
+        impl: target.save,
+      },
+    ]);
+    this.target = target;
+  }
+  client(): Persistent$Client {
+    return new Persistent$Client(this);
+  }
+}
+/**
+ * A group.
+ * */
+export class Persistent extends $.Interface {
   static readonly SaveParams = Persistent_SaveParams;
   static readonly SaveResults = Persistent_SaveResults;
+  static readonly Client = Persistent$Client;
+  static readonly Server = Persistent$Server;
   static readonly _capnp = {
     displayName: "Persistent",
     id: "c8cb212fcd9f5691",

src/capnp/rpc-twoparty.ts

@@ -5,6 +5,9 @@ export const Side = {
   CLIENT: 1,
 } as const;
 export type Side = (typeof Side)[keyof typeof Side];
+/**
+ * Schema for a field of a struct.
+ * */
 export class VatId extends $.Struct {
   static readonly _capnp = {
     displayName: "VatId",
@@ -21,12 +24,19 @@ export class VatId extends $.Struct {
     return "VatId_" + super.toString();
   }
 }
+/**
+ * Describes an annotation applied to a declaration.  Note AnnotationNode describes the
+ * annotation's declaration, while this describes a use of the annotation.
+ * */
 export class ProvisionId extends $.Struct {
   static readonly _capnp = {
     displayName: "ProvisionId",
     id: "b88d09a9c5f39817",
     size: new $.ObjectSize(8, 0),
   };
+  /**
+   * ID of the annotation node.
+   * */
   get joinId(): number {
     return $.utils.getUint32(0, this);
   }
@@ -37,6 +47,10 @@ export class ProvisionId extends $.Struct {
     return "ProvisionId_" + super.toString();
   }
 }
+/**
+ * Specifies bindings for parameters of generics. Since these bindings turn a generic into a
+ * non-generic, we call it the "brand".
+ * */
 export class RecipientId extends $.Struct {
   static readonly _capnp = {
     displayName: "RecipientId",
@@ -57,6 +71,10 @@ export class ThirdPartyCapId extends $.Struct {
     return "ThirdPartyCapId_" + super.toString();
   }
 }
+/**
+ * This is actually a reference to an implicit (generic) parameter of a method. The only
+ * legal context for this type to appear is inside Method.paramBrand or Method.resultBrand.
+ * */
 export class JoinKeyPart extends $.Struct {
   static readonly _capnp = {
     displayName: "JoinKeyPart",
@@ -85,12 +103,19 @@ export class JoinKeyPart extends $.Struct {
     return "JoinKeyPart_" + super.toString();
   }
 }
+/**
+ * Possible element sizes for encoded lists.  These correspond exactly to the possible values of
+ * the 3-bit element size component of a list pointer.
+ * */
 export class JoinResult extends $.Struct {
   static readonly _capnp = {
     displayName: "JoinResult",
     id: "9d263a3630b7ebee",
     size: new $.ObjectSize(8, 1),
   };
+  /**
+   * aka "void", but that's a keyword.
+   * */
   get joinId(): number {
     return $.utils.getUint32(0, this);
   }