Add lint:jsdoc grunt task to precommit:js task. - #13336
Conversation
|
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
64beb5f to
e654681
Compare
|
Now that all the remaining improvements to the Customizer JS documentation have been committed in Core-40831 running Further improvements to the JavaScript inline documentation and the JSDoc configuration will be addressed in Core-66033 for the WordPress 7.2 release cycle. |
e654681 to
08d8e08
Compare
…flow. This changeset adds a `lint:jsdoc` Grunt task and includes it in the `precommit:js` task list. The existing `lint:jsdoc` NPM script was restored to a working configuration in #65939. It broke with the upgrade of ESLint to version 10 in the `@wordpress/scripts` package in the Gutenberg repository. See WordPress/gutenberg#76654. By including `lint:jsdoc` into CI, future potential breakages will be detected soon. Also, this change aims to reinforce the long-term goal of improving the JavaScript inline documentation that was started years ago in the WordPress JavaScript Docs Coding Standards initiative. See https://make.wordpress.org/core/handbook/docs/inline/js/. Future improvements will be part of ongoing maintenance work. See for example #66033. Developed in #13336 Props afercia, westonruter. See #65939, #65950, #66033. git-svn-id: https://develop.svn.wordpress.org/trunk@63464 602fd350-edb4-49c9-b593-d223f7449a82
…flow. This changeset adds a `lint:jsdoc` Grunt task and includes it in the `precommit:js` task list. The existing `lint:jsdoc` NPM script was restored to a working configuration in #65939. It broke with the upgrade of ESLint to version 10 in the `@wordpress/scripts` package in the Gutenberg repository. See WordPress/gutenberg#76654. By including `lint:jsdoc` into CI, future potential breakages will be detected soon. Also, this change aims to reinforce the long-term goal of improving the JavaScript inline documentation that was started years ago in the WordPress JavaScript Docs Coding Standards initiative. See https://make.wordpress.org/core/handbook/docs/inline/js/. Future improvements will be part of ongoing maintenance work. See for example #66033. Developed in WordPress/wordpress-develop#13336 Props afercia, westonruter. See #65939, #65950, #66033. Built from https://develop.svn.wordpress.org/trunk@63464 git-svn-id: http://core.svn.wordpress.org/trunk@62644 1a063a9b-81f0-0310-95a4-ce76da25c4cd
|
Committed in https://core.trac.wordpress.org/changeset/63464 |
2 participants
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:jsdocas part of the precommit task.Needs #10743 to be merged first.
Test instructions:
grunt precommit.precommit:js.lint:jsdocruns as part ofprecommit:js..lint:jsdocwill 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.