Rename Vendor

[widoz]

Summary by CodeRabbit

• Documentation

  • Updated GitHub badges, documentation links, and repository URLs to reflect the new owner, spaghetti-dojo.

• Chores

  • Changed package name in composer.json and updated PSR-4 autoload namespace to match the new repository owner.
  • Updated namespace declarations across various files to SpaghettiDojo\Wp\EntitiesSearch.

[coderabbitai]

Walkthrough

The updates span multiple files related to a WordPress package for searching entities, primarily reflecting a change in the repository ownership from widoz to spaghetti-dojo. The changes include updating URLs in documentation and badges, modifying the namespace declarations, and adjusting the package name in configuration files. These modifications ensure that the new repository ownership is correctly referenced throughout the project's codebase and documentation.

Changes

File / Path	Change Summary
README.md	Updated GitHub badges URLs and documentation link to reflect the new repository owner spaghetti-dojo.
composer.json	Changed the package name and PSR-4 autoload namespace from widoz to spaghetti-dojo.
docs/_config.yml	Updated URLs related to the new GitHub repository and website URL.
docs/development.md	Changed the repository URL to git@github.com:spaghetti-dojo/wp-entities-search.git.
docs/installation.md	Updated the composer installation command to reflect the new package name spaghetti-dojo/wp-entities-search.
plugin.php	Modified the namespace and import declarations from Widoz\Wp\EntitiesSearch to SpaghettiDojo\Wp\EntitiesSearch.
sources/server/src/...	Updated namespace declarations in various Module.php and Library.php files to reflect new ownership.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 49bc83c and cbc5957.

Files selected for processing (10)

• README.md (2 hunks)
• composer.json (1 hunks)
• docs/_config.yml (1 hunks)
• docs/development.md (1 hunks)
• docs/installation.md (1 hunks)
• plugin.php (1 hunks)
• sources/server/src/Library.php (1 hunks)
• sources/server/src/Modules/BlockEditor/Module.php (1 hunks)
• sources/server/src/Modules/E2e/Module.php (1 hunks)
• sources/server/src/Modules/Logging/Module.php (1 hunks)

Files skipped from review due to trivial changes (3)

• composer.json
• docs/_config.yml
• sources/server/src/Modules/E2e/Module.php

Additional context used

Markdownlint

docs/installation.md

7-7: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document

docs/development.md

12-12: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

13-13: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

14-14: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

15-15: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

21-21: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

27-27: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

37-37: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

7-7: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document

LanguageTool

README.md

[uncategorized] ~10-~10: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...ntities searching and storage. At it's core it permits to build components and reus...

docs/development.md

[typographical] ~18-~18: Consider inserting a comma for improved readability. (INITIAL_ADVP_COMMA)
Context: ...After we have installed the dependencies we need to build the assets: ```bash $ ya...

---

[typographical] ~24-~24: Consider adding a comma after ‘alternatively’ for more clarity. (RB_LY_COMMA)
Context: ...e assets: bash $ yarn build or alternatively we can run the dev script to compile th...

---

[typographical] ~34-~34: It seems that a comma is missing. (IN_ORDER_TO_VB_COMMA)
Context: ... to develop the solution. To start the environment we need to run the following command: ...

---

[uncategorized] ~40-~40: This verb does not appear to agree with the subject. Consider using a different form. (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
Context: ...urrent project as a plugin. The package contain a E2E module used by the plugin to help...

---

[uncategorized] ~40-~40: Use the indefinite article “an” before nouns that start with a vowel sound. (AI_EN_LECTOR_REPLACEMENT_DETERMINER_A_AN)
Context: ...roject as a plugin. The package contain a E2E module used by the plugin to help w...

---

[uncategorized] ~42-~42: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ion is provided without content. To add some we can run the following commands from ...

---

[uncategorized] ~53-~53: This verb does not appear to agree with the subject. Consider using a different form. (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
Context: ...tag ``` ## Basic Concepts The package implement a Value Object to handle immutability c...

---

[typographical] ~53-~53: It seems that a comma is missing. (IF_COMMA)
Context: ...er a data is fetched from the WordPress API it will be wrapped in a Set object, b...

---

[uncategorized] ~55-~55: This verb does not appear to agree with the subject. Consider using a different form. (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
Context: ...ionwhich is not directly consumed but define the type of theSet`. It should not be...

Additional comments not posted (9)

docs/installation.md (1)

19-19: Updated Composer command to reflect new package name.

The change aligns with the renaming of the repository and package, ensuring consistency across documentation.

sources/server/src/Library.php (1)

5-5: Namespace updated to reflect new repository ownership.

This change is necessary to maintain consistency with the new repository owner's naming conventions.

Verification successful

---

Namespace updated to reflect new repository ownership.

The old namespace Widoz\Wp\EntitiesSearch has been successfully removed from the codebase.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all references to the old namespace are updated.

# Test: Search for the old namespace usage. Expect: No occurrences.
rg --type php $'Widoz\\Wp\\EntitiesSearch'

Length of output: 139

---

---

Script:

#!/bin/bash
# Description: Verify all references to the old namespace are updated.

# Test: Search for the old namespace usage. Expect: No occurrences.
rg --type php 'Widoz\\\\Wp\\\\EntitiesSearch'

Length of output: 47

plugin.php (1)

12-12: Namespace and use statement updated in plugin.php.

The updates ensure that the plugin's code references the correct namespace following the repository ownership change.

Also applies to: 15-15

Verification successful

---

Namespace and use statement updated in plugin.php.

The updates ensure that the plugin's code references the correct namespace following the repository ownership change. No occurrences of the old namespace Widoz\Wp\EntitiesSearch were found in the codebase.

• Verified that the old namespace Widoz\Wp\EntitiesSearch has been completely removed.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all references to the old namespace are updated.

# Test: Search for the old namespace usage. Expect: No occurrences.
rg --type php $'Widoz\\Wp\\EntitiesSearch'

Length of output: 139

---

---

Script:

#!/bin/bash
# Description: Verify all references to the old namespace are updated.

# Test: Search for the old namespace usage. Expect: No occurrences.
rg --type php 'Widoz\\\\Wp\\\\EntitiesSearch'

Length of output: 47

README.md (2)

5-6: Updated GitHub badge URLs and documentation link.

The updated links reflect the new repository owner and ensure that users are directed to the correct resources.

Also applies to: 15-15

---

Line range hint 10-10: Grammar correction needed in README.md.

The phrase "At it's core" should be corrected to "At its core" to avoid grammatical errors.

- At it's core it permits to build components and reuse the WordPress Rest API to search for Posts associated to one or more Post Types but also, to search for Terms belonging to one or more Taxonomies.
+ At its core, it permits building components and reusing the WordPress Rest API to search for Posts associated to one or more Post Types but also, to search for Terms belonging to one or more Taxonomies.

sources/server/src/Modules/Logging/Module.php (1)

5-5: Namespace updated in Logging Module to reflect new repository ownership.

This change is essential for maintaining namespace consistency across the project following the change in repository ownership.

Verification successful

---

Namespace update verified successfully.

All references to the old namespace Widoz\Wp\EntitiesSearch have been updated to the new namespace SpaghettiDojo\Wp\EntitiesSearch\Modules\Logging.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all references to the old namespace are updated.

# Test: Search for the old namespace usage. Expect: No occurrences.
rg --type php $'Widoz\\Wp\\EntitiesSearch'

Length of output: 139

---

---

Script:

#!/bin/bash
# Description: Verify all references to the old namespace are updated.

# Test: Search for the old namespace usage. Expect: No occurrences.
rg --type php 'Widoz\\\\Wp\\\\EntitiesSearch'

Length of output: 47

sources/server/src/Modules/BlockEditor/Module.php (2)

5-5: Namespace updated to reflect new repository ownership.

The namespace change from Widoz\Wp\EntitiesSearch to SpaghettiDojo\Wp\EntitiesSearch is consistent with the PR objectives and AI-generated summary.

---

Line range hint 5-41: Review of class logic and dependency usage.

The class logic and dependency usage seem appropriate and consistent with WordPress development standards. The use of ContainerInterface for dependency injection and the registration of scripts using WordPress hooks are correctly implemented.

Ensure that all dependencies and assets related to the namespace change are updated accordingly in the project to prevent any potential issues.

Verification successful

---

Namespace Change Verified: The old namespace Widoz\Wp\EntitiesSearch has been successfully updated, and no occurrences were found in the codebase.

• All dependencies and assets related to the namespace change are updated accordingly.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all dependencies and assets related to the namespace change are updated.

# Test: Search for old namespace usage. Expect: No occurrences.
rg --type php $'Widoz\\Wp\\EntitiesSearch'

Length of output: 139

---

---

Script:

#!/bin/bash
# Description: Verify all dependencies and assets related to the namespace change are updated.

# Test: Search for old namespace usage. Expect: No occurrences.
rg --type php 'Widoz\\\\Wp\\\\EntitiesSearch'

Length of output: 47

docs/development.md (1)

12-12: Updated repository URL to reflect new ownership.

The repository URL change from git@github.com:widoz/wp-entities-search.git to git@github.com:spaghetti-dojo/wp-entities-search.git aligns with the PR objectives.

Tools

Markdownlint

12-12: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (2)

docs/installation.md (1)

Line range hint 7-7: Consider restructuring document to avoid multiple top-level headings.

Markdownlint flagged the presence of multiple top-level headings in the same document, which can affect the structure and readability.

-# Installation
+# Installation Guide

docs/development.md (1)

Line range hint 40-55: Fix grammatical issues in documentation.

Several grammatical errors detected by static analysis tools need correction to improve the readability and professionalism of the documentation.

- The package contain a E2E module used by the plugin to help with the development.
+ The package contains an E2E module used by the plugin to help with the development.
- The package implement a Value Object to handle immutability called `Set`.
+ The package implements a Value Object to handle immutability called `Set`.
- Another commonly used data structure is the `ControlOption` which is not directly consumed but define the type of the `Set`.
+ Another commonly used data structure is the `ControlOption`, which is not directly consumed but defines the type of the `Set`.

Tools

Markdownlint

12-12: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

13-13: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

14-14: null (MD014, commands-show-output)
Dollar signs used before commands without showing output

---

15-15: null (MD014, commands-show-output)
Dollar signs used before commands without showing output