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

escritorio-gustavo · 2024-05-10T14:13:59Z

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

…not generate an import statement

arslnb · 2024-06-05T19:42:19Z

+1, looking forward to this!

escritorio-gustavo · 2024-06-05T20:33:26Z

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 · 2024-07-02T16:54:05Z

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

martpie · 2024-07-25T10:43:18Z

The sorting seems to be fixed, but I still see the header generated comment twice. Not a big deal, I'm just sharing what I see ;)

martpie · 2024-07-25T10:47:12Z

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)

gustavo-shigueo · 2024-07-25T12:20:50Z

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 · 2024-07-25T12:31:40Z

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 · 2024-07-25T13:21:39Z

ts-rs/src/export.rs

-    let file_len = file.metadata()?.len() as usize;
+    let file_len = file.metadata()?.len();

-    let mut original_contents = String::with_capacity(file_len);
+    let mut original_contents = String::with_capacity(file_len as usize);


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

martpie · 2024-07-25T13:40:51Z

I can confirm the double header issue is fixed :]

gustavo-shigueo · 2024-07-25T14:10:55Z

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

…ile be reused

gustavo-shigueo · 2024-07-25T18:37:43Z

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 · 2024-08-01T05:08:57Z

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 · 2024-08-01T19:49:12Z

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:

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 · 2024-08-26T13:24:33Z

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

gustavo-shigueo · 2024-08-27T10:30:45Z

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

escritorio-gustavo added 4 commits May 10, 2024 10:54

Allow for multiple types to be exported to the same file

dfaa802

Allow for multiple types to be exported to the same file

784eecd

Merge remote-tracking branch 'refs/remotes/origin/export_same_file'

f4f59e9

Prevent duplication

294126c

escritorio-gustavo requested a review from NyxCode May 10, 2024 14:14

escritorio-gustavo mentioned this pull request May 10, 2024

CLI initial concept #304

Open

12 tasks

escritorio-gustavo added 4 commits May 10, 2024 14:19

If types exported to the same file depend on each other, they should …

7312fa1

…not generate an import statement

Fix import-esm case

4dc1c17

Fix import-esm case

892b11b

Change read_exact for seek

27832ee

This was referenced May 10, 2024

Combine exports into single file #59

Closed

Feature request: How to export multiple types to the same file #314

Closed

escritorio-gustavo changed the title ~~Export same file~~ Allow multiple types to set #[ts(export_to = "...")] to the same file May 10, 2024

escritorio-gustavo and others added 6 commits May 10, 2024 15:01

Remove unneded clone

c7b170e

Merge branch 'main' into export_same_file

8d32a0e

Merge branch 'main' into export_same_file

fbe8e72

Remove duplicate declaration

939041e

Reduce amount of syscalls and memory allocations

a3ed6d8

Replace negated condition with guard clause

121ac37

escritorio-gustavo added the enhancement New feature or request label May 27, 2024

escritorio-gustavo changed the title ~~Allow multiple types to set #[ts(export_to = "...")] to the same file~~ feat: Allow multiple types to set #[ts(export_to = "...")] to the same file May 27, 2024

escritorio-gustavo added 2 commits June 5, 2024 17:28

Merge branch 'main' into export_same_file

70a3c12

Fix compiler error

8e3e59f

This was referenced Jun 28, 2024

Allow for flattening of generic parameters #336

Merged

Feature request: Export in the same file #296

Closed

gustavo-shigueo mentioned this pull request Jul 24, 2024

☂️ Tauri Umbrella issue martpie/museeks#774

Open

80 tasks

Merge branch 'main' into export_same_file

5f41c0d

This comment was marked as resolved.

Sign in to view

Fix double header error

ad1b46e

gustavo-shigueo reviewed Jul 25, 2024

View reviewed changes

This comment was marked as resolved.

Sign in to view

gustavo-shigueo mentioned this pull request Jul 25, 2024

parse_docs doesn't handle block doc comments properly #341

Closed

gustavo-shigueo added 3 commits July 25, 2024 11:19

Allocate less space for buffer by having the note from the original f…

d124d7b

…ile be reused

Merge branch 'main' into export_same_file

6ec0871

Merge branch 'main' into export_same_file

a107e97

Merge branch 'main' into export_same_file

5c889c9

Revert rename to avoid conflicts with other branches

5374370

gustavo-shigueo merged commit 5cbc740 into main Aug 1, 2024
16 checks passed

gustavo-shigueo deleted the export_same_file branch August 1, 2024 21:15

CatMe0w mentioned this pull request Aug 12, 2024

Initial draft of adding TypeScript types stadiamaps/ferrostar#181

Merged

gschier mentioned this pull request Sep 17, 2024

New release? #356

Closed

NyxCode mentioned this pull request Sep 19, 2024

Release v10.0.0 #357

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

escritorio-gustavo commented May 10, 2024 •

edited by gustavo-shigueo

Loading

arslnb commented Jun 5, 2024 •

edited by gustavo-shigueo

Loading

escritorio-gustavo commented Jun 5, 2024 •

edited

Loading

gustavo-shigueo commented Jul 2, 2024

martpie commented Jul 25, 2024

martpie commented Jul 25, 2024

gustavo-shigueo commented Jul 25, 2024

gustavo-shigueo commented Jul 25, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

gustavo-shigueo Jul 25, 2024

martpie commented Jul 25, 2024

This comment was marked as resolved.

This comment was marked as resolved.

gustavo-shigueo commented Jul 25, 2024

gustavo-shigueo commented Jul 25, 2024

Zerowalker commented Aug 1, 2024

gustavo-shigueo commented Aug 1, 2024 •

edited

Loading

martpie commented Aug 26, 2024

gustavo-shigueo commented Aug 27, 2024

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

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

Conversation

escritorio-gustavo commented May 10, 2024 • edited by gustavo-shigueo Loading

Goal

Changes

Checklist

arslnb commented Jun 5, 2024 • edited by gustavo-shigueo Loading

escritorio-gustavo commented Jun 5, 2024 • edited Loading

gustavo-shigueo commented Jul 2, 2024

martpie commented Jul 25, 2024

martpie commented Jul 25, 2024

gustavo-shigueo commented Jul 25, 2024

gustavo-shigueo commented Jul 25, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

gustavo-shigueo Jul 25, 2024

Choose a reason for hiding this comment

martpie commented Jul 25, 2024

This comment was marked as resolved.

This comment was marked as resolved.

gustavo-shigueo commented Jul 25, 2024

gustavo-shigueo commented Jul 25, 2024

Zerowalker commented Aug 1, 2024

gustavo-shigueo commented Aug 1, 2024 • edited Loading

martpie commented Aug 26, 2024

gustavo-shigueo commented Aug 27, 2024

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

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

escritorio-gustavo commented May 10, 2024 •

edited by gustavo-shigueo

Loading

arslnb commented Jun 5, 2024 •

edited by gustavo-shigueo

Loading

escritorio-gustavo commented Jun 5, 2024 •

edited

Loading

gustavo-shigueo commented Aug 1, 2024 •

edited

Loading