CLI

[gustavo-shigueo]

I'm copying the original cli PR into a new one for a couple of reasons:

• The thread on the old one is VERY long and is getting hard to follow
• Whoever is using the account that opened that PR (if anyone) probably doesn't wanna receive notifications about it

Closes #133
Closes #54
Closes #408

Todo

• Find a way to only run ts-rs tests through this CLI
  • Done by gating the generation of tests
    • Added a feature flag called export to ts-rs that re-enables test generation.
    • This feature is always enabled when using this CLI
• Explore a way of generating an index.ts file to reexport all the generated types
  • During export, generate a metadata file to list all types and where they are exported to
    • In the CLI, use the metadata file to create the index.ts file
    • Gate the generation of this file behind a feature flag named generate-metadata
• A configuration file so the user doesn't have to pass the flags every time
  • Add config flag to pass the path to the file?
  • Add init subcommand to help create the config file
• Discuss other features of the CLI
• When we consider it ready, it would be interesting to also make it available through cargo binstall

Feature wishlist

• Customize representations (e.g number vs bigint) (@NyxCode) (being worked on in proof-of-concept of type overrides using the CLI #334)
• Load configuration from configfile (@NyxCode) (being worked on in proof-of-concept of type overrides using the CLI #334)
• (maybe) Combine multiple types in one file? (@NyxCode) (feat: Allow multiple types to set #[ts(export_to = "...")] to the same file #316)
• (maybe) generate index.ts file, re-exporting types (@NyxCode) (See explanation above)

Checklist

• I have followed the steps listed in the Contributing guide.
• If necessary, I have added documentation related to the changes made.
• I have added or updated the tests related to the changes made.

[gustavo-shigueo]

I believe that the combination of #316 and #399 has made this flag obsolete, as the user can create a const and use it on all export_to attributes to get the same effect

[gustavo-shigueo]

The implementation of the CLI is a breaking change for anyone who uses --no-default-features to disable serde-compat as that will also disable the new export feature, preventing the test functions that export the types from being generated

[gustavo-shigueo]

Hey @NyxCode, I merged #334 into the CLI and added a command to generate a default config file. I also removed the --merge flag, as I believe that #316 already does that well enough, especially when combined with #399.

What do you think of the current state of the CLI? Are there other features you want to include?

[gustavo-shigueo]

I'm thinking this isn't proper behavior for merging booleans when it comes to CLI vs Config file. I think the CLI should override the config file, but if the config file has no_warnings=true and the CLI has --no-warnings=false the config file would win due to the OR operator. Maybe the flags should be Option<bool> so the merging would look like self.no_warnings.or(other.no_warnings), then, instead of if args.no_warnings { /*...*/ }, we'd have if args.no_warnings == Some(true) { /*...*/ } (or is_some_and(|x| x) or unwrap_or(false), etc)

[CriusNyx]

Is there some work that I could contribute to this to help this PR get merged? I'm needing a way to generate barrel files (those index.ts files that reexport everything).

PS: NyxCode. Nice name. :3

[gustavo-shigueo]

Hello @CriusNyx , I'm not quite sure if/when this might be merged, as there are a few possible concerns about it:

• @NyxCode has raised some concerns in Coordinate macro invocations #382
• This PR is a breaking change for anyone using --no-default-features to disable serde-compat
• We are not yet sure if there are more features we want to add
• We haven't documented or tested the CLI very thoroughly yet - we did have someone use it and report good results in Feature request: export all types from a single entry point #408 though

All that being said, you can install it with the following command:
cargo install --git https://github.com/Aleph-Alpha/ts-rs --branch feat/cli ts-rs-cli and then use a ts-rs export --index to achieve the behavior you need

[gustavo-shigueo]

Hey @NyxCode, what do you think about merging this into the next branch (or main after we merge next)? We just had someone make another PR (#459) about not wanting cargo test to emit the types unless explicitly asked to and their implementation was pretty similar to what this PR is doing (feature flag, enabled by default which, when disabled, does not emit the types. Then running cargo test export_bindings_ with the feature flag) with major difference being that the cargo test command would still be written manually