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

Adds base ESLint configuration to the wpcomsh plugin. #39275

Merged
merged 20 commits into from
Sep 23, 2024

Conversation

zinigor
Copy link
Member

@zinigor zinigor commented Sep 6, 2024

Fixes ESLint errors when used with base JS ESlint configuration for the Jetpack Monorepo.

Proposed changes:

  • Brings in ESLint base config to wpcomsh.
  • Fixes ESlint warnings and errors.
  • Adds some files to ESLint ignore file.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Go to '..'

@zinigor zinigor requested a review from a team September 6, 2024 17:45
Copy link
Contributor

github-actions bot commented Sep 6, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • 🔴 Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Sep 6, 2024
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

🎉 Thanks!

A few things inline, although some of them probably don't need any action.

@@ -0,0 +1,5 @@
# Not loaded by default eslint, but we use tools/js-tools/load-eslint-ignore.js in .eslintrc to pull it in.

/tests/e2e
Copy link
Contributor

Choose a reason for hiding this comment

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

Eventually we probably should lint this, but OK with me if we do that as a followup.

Comment on lines +4 to +5
/custom-colors/js/jquery.spin.js
/custom-colors/js/spin.js
Copy link
Contributor

Choose a reason for hiding this comment

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

If we get around to setting up a webpack build for the scripts here in some future PR, we could also look at whether there's an npm package we could use instead of copy-pasting these in.

The spin.js looks like it's probably an old version of https://www.npmjs.com/package/spin.js.

projects/plugins/wpcomsh/.eslintrc.js Outdated Show resolved Hide resolved
projects/plugins/wpcomsh/custom-colors/js/color.js Outdated Show resolved Hide resolved
projects/plugins/wpcomsh/logo-tool/js/customizer.js Outdated Show resolved Hide resolved
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

LGTM other than the one remaining lint error.

projects/plugins/wpcomsh/custom-colors/js/color.js Outdated Show resolved Hide resolved
@anomiex anomiex merged commit e594b48 into trunk Sep 23, 2024
54 checks passed
@anomiex anomiex deleted the add/wpcomsh-eslint-base-config branch September 23, 2024 18:11
@github-actions github-actions bot removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Sep 23, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Added a base JS eslint config.

* ESLint fixes for classic-background-stats.js

* Color.js fixes for eslint.

* Eslint fixes for colors-control-beta.js.

* Eslint fixes for colors-control.js.

* Eslint fixes for colors-theme-preview.js

* Eslint auto-fixes for customizer-labels-site-not-launched.js.

* Eslint auto-fixes for footer-credit control.js.

* Eslint auto-fixes for gifting-banner.js

* Eslint fixes for logo tool customizer JS.

* Adding eslintignore.

* Eslint fixes for music-player.js.

* Eslint fixes for tlkio.js

* Changeloge.

* Properly using ESLintrc file

* Update projects/plugins/wpcomsh/custom-colors/js/color.js

* Removed unused function, added URI component encoding.

* Update projects/plugins/wpcomsh/custom-colors/js/color.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants