pbts generates invalid typescript when used on Windows

[oceanusxiv]

protobuf.js version: 6.8.8

When on Windows, pbts generates invalid typescript even though pbjs is outputting the correct annotated js file.

Using the test proto from the protobufjs repo here.

The expected typescript file would contain

public static verify(message: { [k: string]: any }): (string|null);

as seen here.

Instead the type file contains

public static verify(message: [ 'object' ].<string, any>): (string|null);

which is invalid typescript code.

The commands I ran for the conversion were

yarn run pbjs -t static-module -w commonjs -o protobufjs/comments.js protos/comments.proto
yarn run pbts -o protobufjs/comments.d.ts protobufjs/comments.js

[medns]

I have the same issue

[FrobtheBuilder]

This happens to me too.

[FrobtheBuilder]

By the way, I think this is a compatibility issue with the latest version of Node. I'm using 12.4.0, and pbts hasn't really been updated at all in a year or so. The dependencies that it installs aren't at all related to parsing the actual jsdocs, so I don't think that's it either. I'm going to try on some previous versions and see which one works in a bit.

[JiangJie]

By the way, I think this is a compatibility issue with the latest version of Node. I'm using 12.4.0, and pbts hasn't really been updated at all in a year or so. The dependencies that it installs aren't at all related to parsing the actual jsdocs, so I don't think that's it either. I'm going to try on some previous versions and see which one works in a bit.

Waiting for your good news.

[sw-clough]

I was getting the same error when using node 12.8.0. I've now rolled-back to the latest LTS release, 10.16.3, and now my files are correct.

[chris-grabcad]

I'm using protobuf.js in an electron app - which we're currently upgrading to v5 of electron, which has a fixed compatible version of node 12.0.0 (electron v7 uses 12.4.0).

So workarounds like using an older version of node don't really work for us.

I took a look at the way pbts works and it seems to rely heavily on jsdoc to do most of the heavy lifting, by upgrading the version of jsdoc used by this module to use v3.6.3 of jsdoc seemed to work just fine for me. (I made a local clone of this repo and referred to it via ../protobuf.js in my package.json.

I will make a PR into this repo when I've finished my current thread.

[chris-grabcad]

PR is here #1338