Add disableOnNumbers field to typo tolerance settings

[Strift]

Pull Request

This PR updates the typo tolerance settings to allow deactivating typo tolerance on high entropy words.

Related engine issue: meilisearch/meilisearch#5344

What does this PR do?

• Add disableOnNumbers field to typo tolerance settings
• Update tests

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• Documentation

  • Updated documentation to reflect support for the new typo tolerance setting: disableOnNumbers.

• Tests

  • Enhanced tests to include and verify the disableOnNumbers option in typo tolerance settings, ensuring it is correctly handled and defaults to false.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update documentation and test cases to reflect a new boolean property, disableOnNumbers, in the typo tolerance settings. PHPDoc annotations and constant arrays in test classes were modified to include this property, ensuring the new setting is documented and validated in tests. No implementation or control flow was altered.

Changes

File(s)	Change Summary
src/Endpoints/Delegates/HandlesSettings.php	Updated PHPDoc annotations for getTypoTolerance() and updateTypoTolerance() to include disableOnNumbers in the array structure.
tests/Endpoints/IndexTest.php	Modified testIndexGetSettings to expect 'disableOnNumbers' => false in typo tolerance settings.
tests/Settings/SettingsTest.php	Added 'disableOnNumbers' => false to the DEFAULT_TYPO_TOLERANCE constant and related test arrays.
tests/Settings/TypoToleranceTest.php	Added 'disableOnNumbers' => false to the DEFAULT_TYPO_TOLERANCE constant; updated test to set 'disableOnNumbers' => true in payload.

Poem

In the warren of code, a new flag appears,
Typo tolerance grows, as the documentation clears.
Tests now expect numbers to stand tall,
With disableOnNumbers, we cover them all.
🐇 Hopping through arrays, settings in tow—
Our code grows stronger, as features bestow!

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[Strift]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[norkunas]

This needs to be added to https://github.com/meilisearch/meilisearch-php/pull/735/files#diff-95249731dd8911bac7f33ecddf8a964d71b4c6807649fb8b620b6370f3e112a2R50

[Strift]

I'm not sure if you are requesting changes in this PR or not.

As per #749, we agreed to release v1.15 (which includes Meilisearch v1.15 changes) before handling the release of v2.0. So I'm thinking we can either rebase or merge main in the v2 branch after releasing this.

Let me know if I misunderstood something. 🙏

[norkunas]

Yes, I just noted to don't forget :)