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

Testing: Transition away from ESLint valid-jsdoc rule #13741

Closed
aduth opened this issue Feb 7, 2019 · 2 comments · Fixed by #16869
Closed

Testing: Transition away from ESLint valid-jsdoc rule #13741

aduth opened this issue Feb 7, 2019 · 2 comments · Fixed by #16869
Assignees
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Package] ESLint plugin /packages/eslint-plugin [Status] In Progress Tracking issues with work in progress [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Build Tooling Issues or PRs related to build tooling [Type] Task Issues or PRs that have been broken down into an individual action to take

Comments

@aduth
Copy link
Member

aduth commented Feb 7, 2019

Related: eslint/eslint#11145
Related: https://eslint.org/blog/2018/11/jsdoc-end-of-life

Per the above links, ESLint is undergoing a deprecation of built-in support for JSDoc. As such, we should consider preemptively switching to another plugin, such as eslint-plugin-jsdoc. As a side-effect, this could greatly expand the specific enforcement we'd like to see, in order to more closely align with JavaScript Documentation Standards.

I came across the discovery of the deprecation as a result of its buggy behavior (example), which can be further motivation for expediting a transition.

@aduth aduth added [Type] Task Issues or PRs that have been broken down into an individual action to take [Type] Build Tooling Issues or PRs related to build tooling [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Package] ESLint plugin /packages/eslint-plugin labels Feb 7, 2019
@aduth
Copy link
Member Author

aduth commented Feb 7, 2019

Perhaps of interest to you @nosolosw , given your work at #13329.

@oandregal
Copy link
Member

oandregal commented Feb 8, 2019

Just noting that as doctrine will be no longer developed, we also need to update docs/tool, where it is used to create this handbook section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Package] ESLint plugin /packages/eslint-plugin [Status] In Progress Tracking issues with work in progress [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Build Tooling Issues or PRs related to build tooling [Type] Task Issues or PRs that have been broken down into an individual action to take
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants