Giter Site home page Giter Site logo

Comments (5)

stephenh avatar stephenh commented on May 16, 2024

@dteirney sure, that makes a lot of sense. The ts-poet code generator library that ts-proto uses supports outputting comments, I just hadn't bothered hooking that up yet. If you'd like to take a crack at it, that'd be great.

Most of the ts-poet addFunction/addProperty calls take builders that accept a "javaDoc" parameter for outputting comments, and the incoming CodeGenerationRequest (forget the exact name) protos from the protoc compiler should have .comment-type fields that are easily accessible.

(Somewhat of a small disclaimer, the latest ts-poet release, v3, doesn't use this same builder api anymore, so if you dig too much into ts-poet, just note that ts-proto is still on the v2 ts-poet api.)

I can probably sneak this in to at some point too.

from ts-proto.

n3rdyme avatar n3rdyme commented on May 16, 2024

@dteirney see #31

from ts-proto.

stephenh avatar stephenh commented on May 16, 2024

This is merged to master and will go out in the next release, which will be next-day-ish or so. Going to go ahead and close. Thanks @n3rdyme ! That was actually more involved than I thought it was going to be, with the index-based/etc. encoding of the comments in the protobuf file.

from ts-proto.

dteirney avatar dteirney commented on May 16, 2024

@n3rdyme thanks! Will test once the next release goes out.

from ts-proto.

stephenh avatar stephenh commented on May 16, 2024

@dteirney version 1.11.0 is out with this change. :-)

from ts-proto.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.