tsdoc
Protobuf
Our great sponsors
tsdoc | Protobuf | |
---|---|---|
15 | 171 | |
4,655 | 63,657 | |
1.1% | 1.1% | |
6.1 | 10.0 | |
18 days ago | 2 days ago | |
TypeScript | C++ | |
MIT License | GNU General Public License v3.0 or later |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
tsdoc
-
Jsdoc Cheatsheet
For what it’s worth, there’s also TSDoc[1] which is TypeScript’s sorta-equivalent spiritual successor, and notably uses the same format as JSDoc. Inline type annotation is great—and I vastly prefer it to JSDoc as a type annotation mechanism—but supporting the breadth of documentation capability in an inline code position would probably be unwieldy no matter how you try to accommodate it.
1: https://tsdoc.org/
-
What am I Missing (or Could Benefit From Using) For My Stack?
Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL
-
Complete rewrite of ESLint (GitHub discussion by the creator)
Nope, they look the same, at a glance, but they're not the same. JSDoc and TSDoc are different standards, developed by different teams.
- tsc doesn't convert jsdoc types into real typescript
-
How to properly document components
JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool.
-
Using @microsoft/tsdoc for documenting functions
I am trying to use the @microsoft/tsdoc package to generate documentation for a given file. I followed the demo that hey have provided https://github.com/microsoft/tsdoc/tree/main/api-demo and it works for the sample input they provided, shown below.
-
Is it better to use the JSDoc return type or TypeScript return type?
Maybe this is of interest? https://tsdoc.org/
- TSDoc – Documentation Your TypeScript in Code
-
Neogen - The annotation toolkit you never knew you needed
Awesome, thank you! Would you be willing to support TSDoc ?
- Do you use JSdocs with TypeScript?
Protobuf
-
Reverse Engineering Protobuf Definitions from Compiled Binaries
For at least 4 years protobuf has had decent support for self-describing messages (very similar to avro) as well as reflection
https://github.com/protocolbuffers/protobuf/blob/main/src/go...
Xgooglers trying to make do on the cheap will just create a Union of all their messages and include the message def in a self-describing message pattern. Super-sensitive network I/O can elide the message def (empty buffer) and any for RecordIO clone well file compression takes care of the definition.
Definitely useful to be able to dig out old defs but protobuf maintainers have surprisingly added useful features so you don’t have to.
Bonus points tho for extracting the protobuf defs that e.g. Apple bakes into their binaries.
- Show HN: AuthWin – Authenticator App for Windows
-
Create Production-Ready SDKs With gRPC Gateway
gRPC Gateway is a protoc plugin that reads gRPC service definitions and generates a reverse proxy server that translates a RESTful JSON API into gRPC.
-
Create Production-Ready SDKs with Goa
To use more recent versions of protoc in future applications, you can download them from the Protobuf repository.
-
Roll your own auth with Rust and Protobuf
Use the Protobuf CLI protoc and the plugin protoc-gen-tonic.
-
Add extra stuff to a “standard” encoding? Sure, why not
> didn’t find any standard for separating protobuf messages
The fact that protobufs are not self-delimiting is an endless source of frustration, but I know of 2 standards:
- SerializeDelimited* is part of the protobuf library: https://github.com/protocolbuffers/protobuf/blob/main/src/go...
- Riegeli is "a file format for storing a sequence of string records, typically serialized protocol buffers. It supports dense compression, fast decoding, seeking, detection and optional skipping of data corruption, filtering of proto message fields for even faster decoding, and parallel encoding": https://github.com/google/riegeli
-
Block YouTube Ads on AppleTV by Decrypting and Stripping Ads from Profobuf
It looks like it is in fact universal. Just glancing at the code here, it looks like the tool searches any arbitrary file for bytes that look like encoded protobuf descriptors, specifically looking for bytes that are plausibly the beginning of a FileDescriptorProto message defined here:
https://github.com/protocolbuffers/protobuf/blob/main/src/go...
This takes advantage of the fact that such descriptors are commonly compiled into programs that use protobuf. The descriptors are usually embedded as constant byte arrays. That said, not all protobuf implementations embed the descriptors and those that do often have an option to inhibit such embedding (at the expense of losing some dynamic introspection features).
- How to learn to use protoc in 21 easily infuriating steps
-
What's involved in protobuf encoding?
Not much. You can check the source code in https://github.com/protocolbuffers/protobuf. For example, for serializing a boolean in C#: https://github.com/protocolbuffers/protobuf/blob/main/csharp/src/Google.Protobuf/WritingPrimitives.cs#L165. Strings and objects are a bit more complicated, but it is all about turning the data into its byte representation.
-
Trying To Solve The Confusion of Choice Between gRPC vs REST🕵
One of the key feature of gRPC is protobuf .proto file(nothing but just a contract for me between two communicator code components) This file and protobuff compiler is so mature, then it generates a direct client implementation using protoccompiler. ref
What are some alternatives?
typedoc - Documentation generator for TypeScript projects.
FlatBuffers - FlatBuffers: Memory Efficient Serialization Library
vscode-docthis - JSDoc generator extension for Visual Studio Code.
SBE - Simple Binary Encoding (SBE) - High Performance Message Codec
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
MessagePack - MessagePack implementation for C and C++ / msgpack.org[C/C++]
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
cereal - A C++11 library for serialization
vim-doge - (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
Apache Parquet - Apache Parquet
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
Bond - Bond is a cross-platform framework for working with schematized data. It supports cross-language de/serialization and powerful generic mechanisms for efficiently manipulating data. Bond is broadly used at Microsoft in high scale services.