Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make a table of all available arguments in readme #1088

Open
atassis opened this issue Aug 12, 2024 · 5 comments
Open

docs: make a table of all available arguments in readme #1088

atassis opened this issue Aug 12, 2024 · 5 comments

Comments

@atassis
Copy link
Contributor

atassis commented Aug 12, 2024

It is a lot going on in supported options section of readme. It might be easier to read all available options if they are rewritten as a table. Providing an example

Flag Default Description
--ts_proto_opt=globalThisPolyfill=true false ts-proto will include a polyfill for globalThis.
--ts_proto_opt=context=true false the services will have a Go-style ctx parameter, which is useful for tracing/logging/etc. if you're not using node's async_hooks api due to performance reasons.

I can try to make a PR for this later if agreed

@stephenh
Copy link
Owner

Hi @atassis ! Definitely agreed "there is a lot going on" in the readme. :-) Any refactoring / clean-up you'd like to do would be amazing; thank you!

@atassis
Copy link
Contributor Author

atassis commented Aug 12, 2024

https://github.com/atassis/ts-proto/blob/docs/readable-format/docs/supported-options-new.md

  1. Created a table. Default values TBD
  2. Removed --ts_proto_opt as it is meant to be used everywhere anyway
  3. Sorted alphabetically without looking if flag is meant to be paired to another flag. Right now it easier for a new user of a package to read through everything anyway, all options are made chaotically (so to say), so later, with breaking change or not, options can be grouped in a proper way. So my final decision is to make options alphabetically sorted.

I already see that we can make another column with which values can be provided to the flag (bool, string, enum, etc.)

@stephenh
Copy link
Owner

@atassis this looks great!

Are you thinking we'd just swap your supported-options-new for the READMEs current options section?

Happy to do that, when you're ready

@atassis
Copy link
Contributor Author

atassis commented Aug 13, 2024

I want to make a docs/supported-options.md file and leave a link to it in the readme. I think, main page is too bloated with different info, that's why I moved options out (and yes, it is a bit easier to work in separate file with them)

@stephenh
Copy link
Owner

@atassis cool, that sounds fine to me as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants