feat: Allow multiple types to set #[ts(export_to = "...")] to the same file

[escritorio-gustavo]

Goal

Allow for multiple types to be exported to the same file by editing the target file when it is encountered by the second time
Closes #59

Changes

Created a HashMap mapping file paths to a set of type identifiers and using it to decide whether or not the file should be created from scratch or edited

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.
  • Thanks @martpie for helping test this feature

[arslnb]

+1, looking forward to this!

[escritorio-gustavo]

Hey @arslnb! This feature is pretty much done, but I'd still like to make sure it doesn't break anything. If you have any projects that would benefit from this, would mind testing out this branch and checking if your resulting TypeScript is correct?

[gustavo-shigueo]

Hey @NyxCode! Can you check this one out when you have some time?

[gustavo-shigueo]

if the user has "export type " in the JSDoc, the sorting will unfortunately include that, but there's not much I can do about it

Slightly improved this by getting the last "export type ", now it'll only break if a field's JSDoc has that in it

[gustavo-shigueo]

There also seems to be some line breaks added here and there in the docstrings, but I'm really just nitpicking at this point (left is generated, right is the source)

Did this happen with the version from crates.io? The docs feature was made with /// comments in mind, so maybe it just has a bug dealiing with /** */ comments.

[gustavo-shigueo]

This change does nothing, it was leftover from when I was testing something else

[martpie]

I can confirm the double header issue is fixed :]

[gustavo-shigueo]

@NyxCode I think this PR should be ready for merging, do you have anything you'd like to be changed here beforehand?

[gustavo-shigueo]

There also seems to be some line breaks added here and there in the docstrings, but I'm really just nitpicking at this point (left is generated, right is the source)

This should now be fixed too

[Zerowalker]

Oh this would be neat.
Would be nice to have the option to do this globally as well.

For example I got a ton of types,
so having to do #[ts(export_to = "...")] on all is a bit messy.
So if possible overriding it to say "export all to X" or something would be neat.

Though I understand that might be beyond what this is attempting to do,
but just throwing it in there.

A great feature nonetheless :)

[gustavo-shigueo]

So if possible overriding it to say "export all to X" or something would be neat.

There is the TS_RS_EXPORT_DIR environment variable, which changes the directory the types are exported to. When used, all types will be exported to the given directory, and each type will be its own file, without needing to use #[ts(export_to = "...")].

To use it, create a file at: .cargp/config.toml (note that the .cargo directory must be in the root of your project - besides Cargo.toml) and write the following:

[env]
TS_RS_EXPORT_DIR = { value = "<PATH_RELATIVE_TO_CARGO_TOML>", relative = true }

Development history of TS_RS_EXPORT_DIR if you're curious:

• Feat: add default export directory override #195
• `TS_RS_EXPORT_DIR` quirks #245
• Make #[ts(export_to = "...")] relative to TS_RS_EXPORT_DIR #250
• Alternative handling of output paths #256
• bug: Fix issue with absolute paths #323

Though I understand that might be beyond what this is attempting to do,

If you mean "export everything to the same file", then yeah, it is kinda out of the scope of this PR. It could be possible to have a different environment variable for it, but the CLI being developed in #304 accomplishes this and checks for naming collisions better than would be possible here

[martpie]

Any idea when this will be officially released? I know I can use a pointer to a github commit, but still ;)

[gustavo-shigueo]

I think this feature will go into version 10 due to some breaking changes in other PRs, but I have to check with @NyxCode about that