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

Add JSDoc ESLint script #6341

Closed
wants to merge 1 commit into from
Closed

Add JSDoc ESLint script #6341

wants to merge 1 commit into from

Conversation

ntwb
Copy link
Member

@ntwb ntwb commented Apr 22, 2018

Description

This PR replaces #4506 due to unresolvable merge conflicts

How has this been tested?

Running npm run lint:jsdoc in a terminal.

Notes:

  • This script is separate from the default ESLint task as including causes too many errors and noise when run
  • The script does not run at all in any Travis CI job
  • The configuration has been added as a standalone dedicated JSDoc configuration in the eslint/ folder, although this is a temporary folder for ESLint configuration it wil suffice for the time being.
  • A WordPeess Core ticket #WP43828 has also been created to add the same script to core which will add the ongoing ''JavaScript Inline Docs Initiative''

Screenshots

Types of changes

JSDoc ESLint code linting

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.

@ntwb ntwb added the [Type] Build Tooling Issues or PRs related to build tooling label Apr 22, 2018
@ntwb ntwb self-assigned this Apr 22, 2018
@ntwb ntwb requested a review from aduth April 22, 2018 09:26
@aduth
Copy link
Member

aduth commented Apr 24, 2018

Like in #4245, could we consider integrating eslines to mark changed lines as offending errors?

These rules will not be respected if they're not enforced.

@ntwb ntwb changed the title Add JSDcc ESLint script Add JSDoc ESLint script Jun 15, 2018
@aduth
Copy link
Member

aduth commented Aug 11, 2018

What needs to happen to revive this pull request? Or should we close and start anew?

@aduth
Copy link
Member

aduth commented Oct 26, 2018

Closing as stale without response.

@aduth aduth closed this Oct 26, 2018
@aduth aduth deleted the try/jsdoc-the-third branch October 26, 2018 12:53
@aduth aduth mentioned this pull request Jan 24, 2019
5 tasks
@aduth
Copy link
Member

aduth commented Apr 25, 2019

I'd still like to see this at some point. I opened #15193 as a task issue after trying (and failing) to implement it again in the current codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Build Tooling Issues or PRs related to build tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants