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

Build/Test Tools: Update wp-prettier to 3.0.3 and refine ESLint ignore patterns #8295

Conversation

Infinite-Null
Copy link

Trac ticket: #62935

Description

This PR updates the wp-prettier dependency from version 2.6.2 to 3.0.3 and refines the ESLint ignore patterns for better build management. The changes aim to fix the issues with lint:jsdoc and lint:jsdoc:fix scripts.

Changes proposed in this Pull Request

  • Upgrade wp-prettier from 2.6.2 to 3.0.3 to resolve JS linting issues
  • Update .eslintignore patterns to be more specific:
    • Add build-module and build-types directories
    • Replace /build with build for consistency
    • Add *.min.js pattern to ignore minified files
    • Update wp-includes JS ignore pattern

Testing Instructions

  1. Run npm install to update dependencies
  2. Run npm run lint:jsdoc to verify linting works
  3. Run npm run lint:jsdoc:fix to verify auto-fixing works
  4. Verify that build directories are properly ignored

Screenshots

image

Copy link

github-actions bot commented Feb 11, 2025

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 ankitkumarshah, jorbin.

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

Copy link

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

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • 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.

@aaronjorbin
Copy link
Member

@Infinite-Null Taking a look at this, the update of wp-prettier seems to be the only thing necessary. Can you explain why you think we also need to "Update .eslintignore patterns to be more specific"

@Infinite-Null
Copy link
Author

Hi @aaronjorbin,

Thank you for your feedback! I added those ignore rules because when I ran npm run lint:jsdoc -- --debug, I noticed that it was also running for .min.js files and build directories like src/wp-content/plugins/gutenberg/build. Since these files are not meant for linting, I believed excluding them would be appropriate.

Please guide me if I am wrong.

@aaronjorbin
Copy link
Member

Thanks for the quick response and explanation.

I think bringing .eslintignore more inline with .gitignore will make more sense. For example, the # Files and folders that get created in wp-content section can be used to block any plugins code from being scanned.

# Files and folders related to build/test tools
contains a number of folders worth excluding as well since those aren't being directly edited as a part of core development.

@Infinite-Null
Copy link
Author

Hi @aaronjorbin,
Thanks for the feedback! I’ve updated .eslintignore to better align with .gitignore. Please review the changes and let me know if any further adjustments are needed.

Copy link
Member

@aaronjorbin aaronjorbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking better, thanks. I see a couple of spots where there could be some more consistency.

.eslintignore Outdated
@@ -1,15 +1,31 @@
# Files and folders related to build/test tools
/build
/node_modules
build
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
build
/build

Keep it similiar to https://github.com/WordPress/wordpress-develop/blob/trunk/.gitignore#L22

.eslintignore Outdated
Comment on lines 3 to 4
build-module
build-types
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
build-module
build-types

Core does not generate folders with this name

.eslintignore Outdated
build
build-module
build-types
node_modules
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
node_modules
/node_modules

Same as https://github.com/WordPress/wordpress-develop/blob/trunk/.gitignore#L20

.eslintignore Outdated
/jsdoc
/artifacts
/coverage
/.cache
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.eslintignore Outdated

# Excluded files and folders based on `jsdoc.conf.json` exclusions
/src/js/_enqueues/vendor

# Webpack built files
/src/wp-includes/js/media-*
/src/wp-includes/js
*.min.js
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*.min.js

I think this is no longer necessary based on the other changes.

@Infinite-Null
Copy link
Author

Hi @aaronjorbin,
Thank you for the feedback!
I have made the changes, please review it at your convenience.

@aaronjorbin
Copy link
Member

Committed in https://core.trac.wordpress.org/changeset/59848

Thanks @Infinite-Null !

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.

2 participants