Fixed: Prevent invalid JSDoc names when generating service methods, see

#870
protobufjs · Nov 27, 2017 · db2dd49 · db2dd49
1 parent 6229799
commit db2dd49
Show file tree

Hide file tree

Showing 7 changed files with 521 additions and 3 deletions.
diff --git a/cli/targets/static.js b/cli/targets/static.js
@@ -645,7 +645,7 @@ function buildService(ref, service) {
         push("");
         pushComment([
             method.comment || "Calls " + method.name + ".",
-            "@function " + util.safeProp(lcName),
+            "@function " + lcName,
             "@memberof " + exportName(service),
             "@instance",
             "@param {" + exportName(method.resolvedRequestType, !config.forceMessage) + "} request " + method.resolvedRequestType.name + " message or plain object",

diff --git a/scripts/gentests.js b/scripts/gentests.js
@@ -11,6 +11,7 @@ var fs   = require("fs"),
     { file: "tests/data/package.proto", flags: [] },
     { file: "tests/data/rpc.proto", flags: [ "es6" ] },
     { file: "tests/data/rpc.proto", flags: [] },
+    { file: "tests/data/rpc-reserved.proto", flags: [] },
     { file: "tests/data/test.proto", flags: [] },
     { file: "bench/data/bench.proto", flags: ["no-create", "no-verify", "no-delimited", "no-convert", "no-comments"], out: "bench/data/static_pbjs.js" }
 ]
@@ -50,6 +51,7 @@ process.stdout.write("\n");
     { file: "tests/data/package.js" },
     { file: "tests/data/rpc.js" },
     { file: "tests/data/rpc-es6.js" },
+    { file: "tests/data/rpc-reserved.js" },
     { file: "tests/data/test.js" },
     { file: "ext/descriptor/index.js", ext: true }
 ]

diff --git a/tests/data/rpc-es6.js b/tests/data/rpc-es6.js
@@ -50,7 +50,7 @@ export const MyService = $root.MyService = (() => {
 
     /**
      * Calls MyMethod.
-     * @function .myMethod
+     * @function myMethod
      * @memberof MyService
      * @instance
      * @param {IMyRequest} request MyRequest message or plain object

diff --git a/tests/data/rpc-reserved.d.ts b/tests/data/rpc-reserved.d.ts
@@ -0,0 +1,49 @@
+import * as $protobuf from "../..";
+
+export class MyService extends $protobuf.rpc.Service {
+    constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
+    public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): MyService;
+    public delete(request: IMyRequest, callback: MyService.DeleteCallback): void;
+    public delete(request: IMyRequest): Promise<MyResponse>;
+}
+
+export namespace MyService {
+
+    type DeleteCallback = (error: (Error|null), response?: MyResponse) => void;
+}
+
+export interface IMyRequest {
+    path?: (string|null);
+}
+
+export class MyRequest implements IMyRequest {
+    constructor(properties?: IMyRequest);
+    public path: string;
+    public static create(properties?: IMyRequest): MyRequest;
+    public static encode(message: IMyRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IMyRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): MyRequest;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): MyRequest;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): MyRequest;
+    public static toObject(message: MyRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+}
+
+export interface IMyResponse {
+    status?: (number|null);
+}
+
+export class MyResponse implements IMyResponse {
+    constructor(properties?: IMyResponse);
+    public status: number;
+    public static create(properties?: IMyResponse): MyResponse;
+    public static encode(message: IMyResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static encodeDelimited(message: IMyResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): MyResponse;
+    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): MyResponse;
+    public static verify(message: { [k: string]: any }): (string|null);
+    public static fromObject(object: { [k: string]: any }): MyResponse;
+    public static toObject(message: MyResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
+    public toJSON(): { [k: string]: any };
+}