fix(documentation): do not remove JSDoc types in Vue JS files#995
Merged
fix(documentation): do not remove JSDoc types in Vue JS files#995
Conversation
ShGKme
force-pushed
the
fix/jsdoc-in-mixed-ts
branch
from
d71ce12 to
062ad14
Compare
Contributor
Author
|
I'll add tests if the idea is fine |
susnux
reviewed
Apr 24, 2025
Contributor
susnux
left a comment
susnux
left a comment
There was a problem hiding this comment.
I like the idea! Did not check yet!
Contributor
|
what is missing here @ShGKme ? |
Signed-off-by: Grigorii K. Shartsev <[email protected]>
Contributor
Author
My willing to add tests here with all the cases. Oh, and a general dislike of the solution, as it is a half-solution. For example, it just disables |
ShGKme
force-pushed
the
fix/jsdoc-in-mixed-ts
branch
from
062ad14 to
3ad54d6
Compare
ShGKme
force-pushed
the
fix/jsdoc-in-mixed-ts
branch
from
3ad54d6 to
c461e0a
Compare
Signed-off-by: Grigorii K. Shartsev <[email protected]>
ShGKme
force-pushed
the
fix/jsdoc-in-mixed-ts
branch
from
c461e0a to
e1587f3
Compare
Contributor
Author
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
.vuewhen there it has nolang="ts"#980npm run lintbreaks many Vue + JS files if TS config is usedHalf-working solution
jsdoc/require-property-typemakes no harm in TS, there are no@property.vuefiles (that can be both TS and JS):jsdoc/no-typesonly if there are TS typesjsdoc/require-param-typeonly if there are no TS typesjsdoc/require-returns-type(because a return type is often inferred, not specified)jsdoc/check-tag-names(because it can be used in a JS component)So it doesn't break existing JS components (like before).
But it applies only ~half of JSDoc + TS rules in TS components.
Alternative
Generate
fileson the fly by checking<script lang>to distinguish between JS and TS Vue files.