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.

Sign up for GitHub

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

Jump to bottom

feat(setup.md): added how to integrate with typia w/ unplugin-typia #1074

Merged
merged 6 commits into from
Jun 5, 2024
Merged

feat(setup.md): added how to integrate with typia w/ unplugin-typia #1074

merged 6 commits into from
Jun 5, 2024

Conversation

ryoppippi
Copy link
Contributor

@ryoppippi ryoppippi commented Jun 5, 2024 •
edited
Loading

related ryoppippi/unplugin-typia#1

I added the guide using typia and unplugin-typia

If you need more information to add the setup.mdx, let me know!

Cheers!!

@ryoppippi ryoppippi changed the title style(website): change ESBuild to esbuild in docs feat(setup.md) Jun 5, 2024
@ryoppippi ryoppippi changed the title feat(setup.md) feat(setup.md): added how to integrate with typia/unplugin-typia Jun 5, 2024
@ryoppippi ryoppippi changed the title feat(setup.md): added how to integrate with typia/unplugin-typia feat(setup.md): added how to integrate with typia w/ unplugin-typia Jun 5, 2024
@ryoppippi ryoppippi changed the title feat(setup.md): added how to integrate with typia w/ unplugin-typia feat(setup.md): added how to integrate with typia w/ unplugin-typia Jun 5, 2024
@ryoppippi
refactor(website/setup.mdx): change ESBuild to esbuild in docs
13da35b 
This commit changes the capitalization of "ESBuild" to "esbuild" in the
setup.mdx document. This change is made to match the official casing of
the esbuild project.
@ryoppippi
refactor(webxite/setup.mdx): change Webpack to webpack in docs
9cc580c 
This commit changes the casing of 'Webpack' to 'webpack' in the
documentation. This is to adhere to the official casing of the
webpack project.
@ryoppippi
feat(website/setup.mdx): add unplugin-typia guide
66ba4cf 
This commit introduces a guide for using unplugin-typia, an experimental
plugin for integrating typia into various bundlers. The guide includes
installation instructions and examples for Vite, Next.js, and esbuild.
@ryoppippi
Copy link
Contributor Author

I force-pushed the commits because the commit messages are odd.
Finally, please review it!!

@samchon
Copy link
Owner

samchon commented Jun 5, 2024

Is there special reason not to configure compilerOptions.plugins property of tsconfig.json file?

@ryoppippi
Copy link
Contributor Author

ryoppippi commented Jun 5, 2024 •
edited
Loading

There is no special reason.
However, even if you don't configure it, it works!

Also, I don't think this might happens, but if you configure it in tsconfig.json the transformer runs twice( I haven't check this out ..., and I don't think that happens, but maybe..)

@samchon
Copy link
Owner

samchon commented Jun 5, 2024

Thanks for your contribution.

I did little bit emend on your content. If my way is not right, it is okay to rolling back.

After the unplugin-typia becomes stable, then please tell me. I'll make the unplugin-typia section to be directly under the Transformation section. The other sections Generation, Webpack and NX would be after of yours.

@samchon
Copy link
Owner

samchon commented Jun 5, 2024

There is no special reason. However, even if you don't configure it, it works!

Also, I don't think this might happens, but if you configure it in tsconfig.json the transformer runs twice( I haven't check this out ..., and I don't think that happens, but maybe..)

Then may I guide just to use the npx typia setup command?

It is because even when developing frontend project, I think some developers may run independent ts file in the NodeJS environment for miscellaneous reasons.

@ryoppippi
Copy link
Contributor Author

ryoppippi commented Jun 5, 2024 •
edited
Loading

After the unplugin-typia becomes stable, then please tell me. I'll make the unplugin-typia section to be directly under the Transformation section.

Yes! Thank you
I tested it with several bundlers and it works fine rn.
For me it is stable...
But idk, I don't have confidence for this new plugin because no one hasn't try this one.
It may takes a couple of months maybe

Then may I guide just to use the npx typia setup command?

You are right!!
I had not considered using it in conjunction with generation mode.
npx typia setup is fine.

So should I fix the document? or will you do?

@samchon
Copy link
Owner

samchon commented Jun 5, 2024

I'll change it and will get review from you.

By the way, if unplugin-typia is enough stable for you, then I'll make your section to be upper after two weeks later.

If there be some issue in the two weeks, just tell me please.

And when you want to change the setup guide content, just send me a PR anytime when you want.

@ryoppippi
Copy link
Contributor Author

Nice! Thanks!!

@samchon
Copy link
Owner

samchon commented Jun 5, 2024

@ryoppippi Finished changing your content. Can you take a review? As I'm not familiar with English, there can be some errors.

@samchon samchon self-requested a review June 5, 2024 12:57
@ryoppippi
Copy link
Contributor Author

Also, if unplugin-typia is enough stable, we can delete the previous guide for webpack and vite

@samchon samchon added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jun 5, 2024
@samchon
Copy link
Owner

samchon commented Jun 5, 2024

https://nestia.io/docs/setup/#webpack

Only about the webpack chapter, I'm careful about it due to backend case like above.

The other sections, if you feel confidence, it is okay to remove and make your content to be upper even now.

@samchon
Copy link
Owner

samchon commented Jun 5, 2024

For reference, if you accept my change and this PR me merged, the website would be automatically published by pipeline

@ryoppippi
Copy link
Contributor Author

@samchon
I checked your modification.

LGTM

@samchon samchon merged commit 2965bea into samchon:master Jun 5, 2024
@ryoppippi
Copy link
Contributor Author

Only about the webpack chapter, I'm careful about it due to backend case like above.

Nice Thanks!

@ryoppippi ryoppippi deleted the feature/add-docs branch June 5, 2024 13:06
@samchon
Copy link
Owner

samchon commented Jun 5, 2024

I'll prepare a new PR that making unplugin-typia section to be upper at Saturday or Sunday of this week.

Thanks for interseting and greating plugin.

@ryoppippi ryoppippi mentioned this pull request Jun 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samchon samchon Awaiting requested review from samchon

Assignees

@ryoppippi ryoppippi

@samchon samchon

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ryoppippi @samchon