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

Allow TypeScript syntax in JSDoc comments #413

Merged
merged 1 commit into from Nov 3, 2022
Merged

Conversation

Pytal
Copy link
Contributor

@Pytal Pytal commented Nov 3, 2022

Allow usage of TypeScript syntax e.g.

/**
 * @type {import('vue').Component}
 */
const component = new Vue()

Documentation https://github.com/gajus/eslint-plugin-jsdoc/blob/v39.2.1/README.md#mode

Signed-off-by: Christopher Ng <chrng8@gmail.com>
@Pytal Pytal added the enhancement New feature or request label Nov 3, 2022
@Pytal Pytal self-assigned this Nov 3, 2022
@skjnldsv
Copy link
Contributor

skjnldsv commented Nov 3, 2022

Maybe also add @typescript-eslint ?

@skjnldsv skjnldsv merged commit 4cc89e0 into master Nov 3, 2022
@skjnldsv skjnldsv deleted the enh/jsdoc-typescript branch November 3, 2022 17:55
@Pytal
Copy link
Contributor Author

Pytal commented Nov 3, 2022

Maybe also add @typescript-eslint ?

Our ecosystem is far from 100% TypeScript so it seems simpler to only apply parsing to JSDoc comments for now

@typescript-eslint/parser could be added once a larger effort towards TypeScript adoption has begun at which point we could also fix any issues that come from that

@Pytal Pytal mentioned this pull request Nov 3, 2022
@skjnldsv
Copy link
Contributor

skjnldsv commented Nov 4, 2022

@typescript-eslint/parser could be added once a larger effort towards TypeScript adoption has begun at which point we could also fix any issues that come from that

Nice! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants