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

Fix: Incorrect format of PHPCS for *register custom sanitize function* #2286

Conversation

mralaminahamed
Copy link
Member

@mralaminahamed mralaminahamed commented May 29, 2024

All Submissions:

  • My code follow the WordPress' coding standards
  • My code satisfies feature requirements
  • My code is tested
  • My code passes the PHPCS tests
  • My code has proper inline documentation
  • I've included related pull request(s) (optional)
  • I've included developer documentation (optional)
  • I've added proper labels to this pull request

Changes proposed in this Pull Request:

fix: Incorrect format of PHPCS for register custom sanitize function

Related Pull Request(s)

  • Full PR Link

Closes

  • Closes #

Ref

How to test the changes in this Pull Request:

  • Steps or issue link

Changelog entry

Fix: Incorrect format of PHPCS for register custom sanitize function

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

  • Code is not following code style guidelines
  • Bad naming: make sure you would understand your code if you read it a few months from now.
  • KISS: Keep it simple, Sweetie (not stupid!).
  • DRY: Don't Repeat Yourself.
  • Code that is not readable: too many nested 'if's are a bad sign.
  • Performance issues
  • Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
  • Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.
As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

  • Correct — Does the change do what it's supposed to? ie: code 100% fulfilling the requirements?
  • Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
  • Readable — Will your future self be able to understand this change months down the road?
  • Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

  • Chores

    • Updated GitHub Actions configurations for improved performance and compatibility:
      • Upgraded checkout action to v4.
      • Updated PHP version to 7.4.
      • Upgraded composer tool to v2.
      • Enhanced caching mechanism.
      • Improved GitHub API call with authorization.
  • Refactor

    • Improved sanitizing functions configuration for better security and maintainability:
      • Changed customSanitizingFunctions to an array type.
      • Added dokan_sanitize_phone_number and removed wc_clean from sanitizing functions.

Copy link
Contributor

coderabbitai bot commented May 29, 2024

Walkthrough

This update involves modifications to the phpcs.xml.dist and .github/workflows/phpcs.yml files. The phpcs.xml.dist changes include altering the customSanitizingFunctions property from a string to an array, removing wc_clean, and adding dokan_sanitize_phone_number. The .github/workflows/phpcs.yml updates involve upgrading various GitHub Actions and tools, as well as improving the caching and composer installation processes.

Changes

Files Change Summary
phpcs.xml.dist Changed customSanitizingFunctions type from string to array, removed wc_clean, added dokan_sanitize_phone_number.
.github/workflows/phpcs.yml Updated GitHub Actions checkout to v4, PHP version to 7.4, composer to v2, and cache action to v4. Adjusted cache key format, removed unnecessary composer install flags, and enhanced GitHub API call with authorization.

Poem

In the land of code, where functions flow,
A change in sanitizing, we now bestow.
With dokan_sanitize_phone_number in the mix,
And wc_clean gone, we’ve made our fix.
Upgraded tools, Actions anew,
Our workflow’s stronger, through and through.
🐇✨ CodeRabbit hops with glee,
For a cleaner, brighter PHP!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 485d1bc and c46cafc.
Files selected for processing (1)
  • phpcs.xml.dist (1 hunks)
Additional comments not posted (4)
phpcs.xml.dist (4)

Line range hint 1-1: Ensure XML declaration is present and correctly formatted.


Line range hint 1-1: Review the overall structure and formatting of the XML file to ensure it adheres to best practices.


Line range hint 1-1: Check that the file includes all necessary configurations and rules for the WordPress coding standards.


Line range hint 1-1: Verify that the customSanitizingFunctions property update is correctly implemented.

Verification successful

The dokan_sanitize_phone_number function is integrated properly across the codebase, as evidenced by its usage in multiple relevant PHP files.

  • templates/settings/store-form.php
  • templates/account/update-customer-to-vendor.php
  • includes/template-tags.php
  • includes/functions.php
  • includes/Registration.php
  • includes/Frontend/MyAccount/BecomeAVendor.php
  • includes/Dashboard/Templates/Settings.php
  • includes/Admin/UserProfile.php
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the new sanitizing function is integrated properly across the codebase.

# Test: Search for the function usage. Expect: Occurrences of the new function in relevant PHP files.
rg --type php $'dokan_sanitize_phone_number'

Length of output: 1269

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c46cafc and 2440a22.
Files selected for processing (1)
  • phpcs.xml.dist (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • phpcs.xml.dist

update: actions with latest version
added: custom capabilities for vendors and admin from dokan
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 2440a22 and 19e4ba5.
Files selected for processing (2)
  • .github/workflows/phpcs.yml (1 hunks)
  • phpcs.xml.dist (4 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/phpcs.yml
Files skipped from review as they are similar to previous changes (1)
  • phpcs.xml.dist

@mralaminahamed mralaminahamed removed the request for review from shohag121 May 29, 2024 07:38
@mrabbani mrabbani merged commit 5f4a086 into getdokan:develop May 29, 2024
2 checks passed
@mralaminahamed mralaminahamed deleted the fix/phpcs-custom-sanitize-fuction-registration-incorrect-format branch May 29, 2024 13:21
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.

None yet

2 participants