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

Add a 'quote' attribute to generate quoted TS properties #46

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

samkearney
Copy link

@samkearney samkearney commented Jan 14, 2024

In TypeScript it is possible to have interfaces with fields that are not valid JS identifiers, if they are enclosed in quotes. If you use the current version of tsify with #[serde(rename)], it can produce interfaces with these properties, but in most cases it does not enclose them with quotes (unless they contain a -, with current logic).

One approach to fixing this is to enhance the logic for automatically detecting whether a property is a valid JS identifier. Since this is defined with a relatively large category of Unicode characters, the easiest way to do this would be to take a dependency on a crate such as unicode-ident.

I figured a simpler way was to give the crate user an escape hatch in the form of a new attribute quote which will enclose the resulting TS field in quotes.

Closes #37

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

Successfully merging this pull request may close these issues.

Bug: Fields starting with numeric literal need to be quoted
1 participant