Skip to content

Add lint:jsdoc grunt task to precommit:js task. - #13336

Open
afercia wants to merge 1 commit into
WordPress:trunkfrom
afercia:lint-jsdoc-grunt-task
Open

Add lint:jsdoc grunt task to precommit:js task.#13336
afercia wants to merge 1 commit into
WordPress:trunkfrom
afercia:lint-jsdoc-grunt-task

Conversation

@afercia

@afercia afercia commented Aug 31, 2026

Copy link
Copy Markdown
Member

Trac ticket: https://core.trac.wordpress.org/ticket/65950

Important

Do not merge before #10743 otherwise the tests on CI will fail for any pull request.

Adds a Grunt task to run the lint:jsdoc as part of the precommit task.

Needs #10743 to be merged first.

Test instructions:

  • Make a temporary change to any admin JS file.
  • From the terminal, run grunt precommit.
  • The task should detect that only JS files have been modified and only run the JS tests and sub-tasks, see precommit:js.
  • Observe lint:jsdoc runs as part of precommit:js..
  • Note that until Improve Customizer JSDoc #10743 isn't merged yet, lint:jsdoc will report several violations.

Use of AI Tools


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props afercia.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant