Add `#[ts(optional)]` to struct #366

gustavo-shigueo · 2024-11-09T20:17:29Z

Goal

Allow the use of #[ts(optional)] on struct definitions
Closes #364

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.

NyxCode · 2024-11-09T20:45:53Z

Love the idea. Would also like to hear what @Nutomic and @dessalines think.

I'm not yet sure if re-using the same #[ts(optional)] on a struct is a good idea syntax-wise, but maybe it'll grow on me.

dessalines · 2024-11-10T15:23:13Z

Excellent! Yep this would really gonna clean up our structs. Thx!

NyxCode · 2024-11-10T18:46:50Z

@gustavo-shigueo A problem I see with this implementation is that all fields have to be Option<T>, otherwise this error is emitted: error: 'optional' can only be used on an Option<T> type.

We could fix that by trying to figure out if a field is an Option, and if it isn't, using the default behaviour. But like the current handling of #[ts(optional)], that's fragile, and breaks with type aliases.

Maybe we can move that logic from the macro to the runtime, where we actually know if a type is an Option or not.

gustavo-shigueo · 2024-11-10T21:25:23Z

@gustavo-shigueo A problem I see with this implementation is that all fields have to be Option<T>, otherwise this error is emitted: error: 'optional' can only be used on an Option<T> type.

Damn, I forgot about that

We could fix that by trying to figure out if a field is an Option, and if it isn't, using the default behaviour. But like the current handling of #[ts(optional)], that's fragile, and breaks with type aliases.

Yeah, that would probably not be a great idea

gustavo-shigueo · 2024-11-10T21:35:46Z

I implemented a band-aid fix for the problem, but we should probably look into a better way to detect the Option type

gustavo-shigueo · 2024-11-10T21:47:53Z

Maybe we can move that logic from the macro to the runtime, where we actually know if a type is an Option or not.

We could add a const IS_OPTION: bool = false to the TS trait and set it to true in our impl<T: TS> TS for Option<T>. That shouldn't even be a breaking change since the trait provides a default value

gustavo-shigueo · 2024-11-10T22:43:44Z

@NyxCode I have implemented this idea for you to take a look, I also change Optional into an enum, this way it is impossible to represent the invalid Optional { optional: false, nullable: true }

gustavo-shigueo · 2024-11-10T22:46:58Z

The downside of this implementation is that there is no compile time error for

#[derive(TS)]
struct Foo {
    #[ts(optional)]
    foo: i32
}

Instead, this will panic when the user attempts to export their types. I don't quite like this because ts-rs usually works in a "If it compiles, you're good" way, but here we get something that compiles and doesn't work.

NyxCode · 2024-11-10T22:59:06Z

Nice work! I have an idea how to get this compile-time checked, lemme see if that actually works though..

gustavo-shigueo · 2024-11-10T23:04:28Z

macros/src/types/named.rs

+    let optional_annotation = if let Optional::Optional { .. } = field_attr.optional {
+        quote! {
+            if <#ty as #crate_rename::TS>::IS_OPTION {
+                #optional_annotation
+            } else {
+                panic!("`#[ts(optional)]` can only be used with the Option type")
            }
        }
-        Optional {
-            optional: false, ..
-        } => (&parsed_ty, ""),
+    } else {
+        optional_annotation


Another option is just remove this whole thing, this way there'll be no panic (still, no compiler error). What will happen is that #[ts(optional)] will just do nothing when not using an Option type

gustavo-shigueo · 2024-11-10T23:09:30Z

I'm not yet sure if re-using the same #[ts(optional)] on a struct is a good idea syntax-wise, but maybe it'll grow on me.

Good point, maybe at the struct level we should call it something like optional_fields

NyxCode

Hey @gustavo-shigueo! I am - and have been - very busy lately. Sorry for being less active here.
Thank you for keeping an eye on everything!

Nonetheless, I'd like to get this merged, and release a new version in a new PR.

The only thing missing here is a note in the changelog, I think. Is there something else you'd like to change/note/add?

gustavo-shigueo · 2025-02-21T01:59:52Z

Hey @gustavo-shigueo! I am - and have been - very busy lately. Sorry for being less active here.
Thank you for keeping an eye on everything!

Hey @NyxCode, I hope you're doing well! No problem, I've also been pretty busy lately, I've been keeping an eye on the issues but haven't written any code in a while.

Nonetheless, I'd like to get this merged, and release a new version in a new PR.

The only thing missing here is a note in the changelog, I think.

Awesome! I'll make sure to add it tomorrow morning, thanks!

gustavo-shigueo · 2025-02-21T12:09:31Z

Updated the changelog, I also ran cargo msrv verify to check if our rust-version was correct and it turns out the MSRV is now 1.78.0

gustavo-shigueo · 2025-02-21T12:10:45Z

Updated the changelog, I also ran cargo msrv verify to check if our rust-version was correct and it turns out the MSRV is now 1.78.0

I'll see if I can make a GH workflow this weekend to check that for us in the future

dessalines · 2025-04-16T15:50:00Z

Would it be possible to do a minor release sometime soon (that has this)?

gustavo-shigueo · 2025-04-16T16:20:23Z

This is a breaking change for anyone manually implementing TS, so this must be in a major release

gustavo-shigueo · 2025-04-16T16:23:26Z

I think it could be possible to have a major release about now, the only PR that I think is worth looking into before hand is #376, which is waiting for @NyxCode's review, and maaaaybe we could look into having a pre-release version of the CLI, but that's unlikely, due to the concerns raised in #382 and the fact that I'm currently unable to push commits to the CLI branch

NyxCode · 2025-04-19T11:53:04Z

@gustavo-shigueo I've raised the permissions issue with the org. They reshuffled the management of it, but I hope they'll finally get around to it after the easter holidays. Again, sorry about that.

I'll merge the deno PR & cut a release early next week.

gustavo-shigueo · 2025-04-19T12:51:30Z

@gustavo-shigueo I've raised the permissions issue with the org. They reshuffled the management of it, but I hope they'll finally get around to it after the easter holidays. Again, sorry about that.

Thanks for looking into it! No need to apologize, though. This isn't on you at all

I'll merge the deno PR & cut a release early next week.

Awesome!

gustavo-shigueo · 2025-05-21T12:01:49Z

I hope they'll finally get around to it after the easter holidays

Hey @NyxCode, just checking if have you've heard anything from them

NyxCode · 2025-05-29T22:16:45Z

Hey @gustavo-shigueo!
I've just checked again, and I think they've fixed it! You should have gotten an invitation, probably per email?

gustavo-shigueo · 2025-05-29T22:50:36Z

Hey @NyxCode, yeah, I just received it, thanks!

NyxCode · 2025-05-29T22:52:58Z

Yay! Man, that was a journey. Sorry that it took so long.

gustavo-shigueo · 2025-05-29T23:15:06Z

Don't worry about it

dessalines · 2025-06-12T00:36:24Z

Happy to say we'll be using this feature soon in lemmy: LemmyNet/lemmy#5777

Thx again!

gustavo-shigueo added 3 commits November 9, 2024 17:15

Fix clippy warning

8e8fc64

Add test

6692151

Parse #[ts(optional)] on structs

2b7a95a

gustavo-shigueo added the enhancement New feature or request label Nov 9, 2024

gustavo-shigueo requested a review from NyxCode November 9, 2024 20:17

gustavo-shigueo added 2 commits November 10, 2024 18:26

Add non Option<T> field to test

1a13390

Fix struct optional non-optional field

0aa63ea

gustavo-shigueo added 3 commits November 10, 2024 19:31

Add runtime validation for #[ts(optional)]

69e9987

Turn Optional into an enum

a562561

Remove invalid optional attribute from test

6f064f5

Remove extra methods for option inner type

ad4f024

gustavo-shigueo commented Nov 10, 2024

View reviewed changes

Remove panic

ade6a2f

NyxCode mentioned this pull request Nov 11, 2024

compile-time checked #[ts(optional)] #367

Merged

NyxCode and others added 6 commits November 10, 2024 22:19

compile-time checked #[ts(optional)] (#367)

dcc7a46

Remove invalid optional from test

95e0401

Fix doc comment

4d1a6d4

Show error message on the compiler's ascii graphic too

0d51986

Remove invalid optional from test - again, oops

c7d2c4a

Rename struct level attribute

033d096

gustavo-shigueo linked an issue Feb 20, 2025 that may be closed by this pull request

bug: #[ts(optional)] does not work with Option type alias #380

Closed

NyxCode approved these changes Feb 21, 2025

View reviewed changes

gustavo-shigueo added 4 commits February 21, 2025 08:45

Update CHANGELOG

6fef0a0

Merge branch 'main' into add_ts_optional_to_struct

625ab54

Fix CHANGELOG merge

5a48627

Update MSRV

768eb3d

Update README

e98966d

Fix clippy warning

09cb5de

gustavo-shigueo merged commit ad0f229 into main Feb 21, 2025
18 checks passed

gustavo-shigueo deleted the add_ts_optional_to_struct branch February 21, 2025 12:19

dessalines mentioned this pull request Feb 21, 2025

Add ts_optional to structs, rather than on individual struct fields LemmyNet/lemmy#5448

Closed

5 tasks

gustavo-shigueo mentioned this pull request Feb 22, 2025

remove lazy_static #373

Merged

3 tasks

gustavo-shigueo mentioned this pull request Apr 3, 2025

skip_serializing_if assumes that object’s field may not exist #394

Closed

This was referenced Jun 3, 2025

Feature request: Container level #[ts(optional)]equivalent to mark any Option<_> fields as optional #412

Closed

release v11.0.0 #413

Merged

NyxCode mentioned this pull request Jun 4, 2025

Regression: #[ts(optional)] with #[ts(type)] #416

Merged

3 tasks

Add #[ts(optional)] to struct #366

Add #[ts(optional)] to struct #366

Uh oh!

Conversation

gustavo-shigueo commented Nov 9, 2024

Goal

Checklist

Uh oh!

NyxCode commented Nov 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dessalines commented Nov 10, 2024

Uh oh!

NyxCode commented Nov 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gustavo-shigueo commented Nov 10, 2024

Uh oh!

gustavo-shigueo commented Nov 10, 2024

Uh oh!

gustavo-shigueo commented Nov 10, 2024

Uh oh!

gustavo-shigueo commented Nov 10, 2024

Uh oh!

gustavo-shigueo commented Nov 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NyxCode commented Nov 10, 2024

Uh oh!

gustavo-shigueo Nov 10, 2024

Choose a reason for hiding this comment

Uh oh!

gustavo-shigueo commented Nov 10, 2024

Uh oh!

NyxCode left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gustavo-shigueo commented Feb 21, 2025

Uh oh!

gustavo-shigueo commented Feb 21, 2025

Uh oh!

gustavo-shigueo commented Feb 21, 2025

Uh oh!

Uh oh!

dessalines commented Apr 16, 2025

Uh oh!

gustavo-shigueo commented Apr 16, 2025

Uh oh!

gustavo-shigueo commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NyxCode commented Apr 19, 2025

Uh oh!

gustavo-shigueo commented Apr 19, 2025

Uh oh!

gustavo-shigueo commented May 21, 2025

Uh oh!

NyxCode commented May 29, 2025

Uh oh!

gustavo-shigueo commented May 29, 2025

Uh oh!

NyxCode commented May 29, 2025

Uh oh!

gustavo-shigueo commented May 29, 2025

Uh oh!

dessalines commented Jun 12, 2025

Uh oh!

Uh oh!

Add `#[ts(optional)]` to struct #366

Add `#[ts(optional)]` to struct #366

NyxCode commented Nov 9, 2024 •

edited

Loading

NyxCode commented Nov 10, 2024 •

edited

Loading

gustavo-shigueo commented Nov 10, 2024 •

edited

Loading

NyxCode left a comment •

edited

Loading

gustavo-shigueo commented Apr 16, 2025 •

edited

Loading