New cli command npx typia patch for hacking defaultJSDocParsingMode value
#883
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If `ts-patch` update be delayed for a long time, `typia` will hack the `jsDocParsingMode` by itself. Of course, this is beta plan that would be discarded if `ts-patch` supports TypeScript v5.3 in near time.
samchon
commented
Nov 26, 2023
|
Also, need to update |
samchon
added a commit
to samchon/nestia
that referenced
this pull request
Nov 26, 2023
Since TypeScript v5.3 update, `tsc` no more parses `JSDocComment`s. Therefore, Therefore, `typia` and `@nestia/core` also cannot utilize those `JSDocComment` related features too, especially "Comment Tags" and "JSON schema generator". However, in relation to this, the upgrade of `ts-patch` continues to be delayed, and I still don't know how long the delay would be continue. Furthermore, there're some `typia`/`nestia` users urging to resolve the `peerDependencies` of `typia`/`nestia` that blocking the TypeScript v5.3 update. Therefore, before the `ts-patch` being prepared, I've decoded to provide `typia`'s own solution for a while. It is the new CLI command `npx typia patch`, and `nestia` also adapts it (`npx nestia setup` command performs it). Also, if the `defaultJSDocParsingMode` value not being patched, `typia` will generate an warning message of TypeScript compiler API. For reference, as it is an warning message, it does not interrupt the TypeScript compilation like the compilation error case. If there're some `typia`/`nestia` users never using "Comment Tags" or "JSON schema generator" at all, they don't need to run the CLI command. This is not mandatory command, but just optional command. Of course, when `ts-patch` being updated, this CLI command would be disabled immediately, if the installed `ts-patch` version is the latest one. Related issues: - samchon/typia#883 - microsoft/TypeScript#55739 - nonara/ts-patch#134
samchon
added a commit
to samchon/payments
that referenced
this pull request
Nov 28, 2023
samchon
added a commit
that referenced
this pull request
Dec 6, 2023
Since TypeScript v5.3 update, `tsc` no more parses `JSDocComment`s. Therefore, `typia` also cannot utilize those `JSDocComment` related features too, especially "Comment Tags" and "JSON schema generator". To reflect such TypeScript v5.3 update, `typia` has newly added a temporary CLI command `npx typia patch` that is hacking the TypeScript module to turning on the `JSDocComment` parsing. - #883 In today, `ts-patch` has started supporting the TypeScript v5.3 update by reading `package.json` of transformer libraries. Therefore, the temporary CLI command no more required. Following the `ts-patch` guide, this PR has configured the `package.json` file for `ts-patch`, and `JSDocComment` parsing would be turned on by the `ts-patch`. For reference, the temporary CLI command `npx typia patch` would be kept for a while, due to there can be some users using previous version of `ts-patch`. It would be deprecated after the next major update.
samchon
added a commit
to samchon/nestia
that referenced
this pull request
Dec 6, 2023
Since TypeScript v5.3 update, `tsc` no more parses `JSDocComment`s. Therefore, `typia` also cannot utilize those `JSDocComment` related features too, especially "Comment Tags" and "JSON schema generator". To reflect such TypeScript v5.3 update, `typia` has newly added a temporary CLI command `npx typia patch` that is hacking the TypeScript module to turning on the `JSDocComment` parsing. Also, `nestia` has adopted the CLI when running the `npx nestia setup` command. - samchon/typia#883 - #696 In today, `ts-patch` has started supporting the TypeScript v5.3 update by reading `package.json` of transformer libraries. Therefore, the temporary CLI command no more required. Following the `ts-patch` guide, this PR has configured the `package.json` file for `ts-patch`, and `JSDocComment` parsing would be turned on by the `ts-patch`. For reference, the temporary CLI command `npx typia patch` would be kept for a while, due to there can be some users using previous version of `ts-patch`. It would be deprecated after the next major update.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since TypeScript v5.3 update,
tscno more parsesJSDocComments. Therefore, Therefore,typiaalso cannot utilize thoseJSDocCommentrelated features too, especially "Comment Tags" and "JSON schema generator".However, in relation to this, the upgrade of
ts-patchcontinues to be delayed, and I still don't know how long the delay would be continue. Furthermore, there're somenestiausers urging to resolve thepeerDependenciesoftypiathat blocking the TypeScript v5.3 update. Therefore, before thets-patchbeing prepared, I've decoded to providetypia's own solution for a while. It is the new CLI command,npx typia patch(npx typia setupcommand also performs the same behavior).Also, if the
defaultJSDocParsingModevalue not being patched,typiawill generate an warning message of TypeScript compiler API. For reference, as it is an warning message, it does not interrupt the TypeScript compilation like the compilation error case. If there're sometypiausers never using "Comment Tags" or "JSON schema generator" at all, they don't need to run the CLI command. This is not mandatory command, but just optional command.Of course, when
ts-patchbeing updated, this CLI command would be disabled immediately, if the installedts-patchversion is the latest one.Related issues:
defaultJSDocParsingModeof TypeScript v5.3 nonara/ts-patch#134