fix: Make sure that later matches at the start of words rank higher than earlier substring matches

[matmannion]

What:

Fixes #159, so WORD STARTS WITH matches are returned correctly even if there is an earlier prefix that isn't at the start of a word.

How:

Added a new generator to call indexOf multiple times (to avoid needing to iterate through the whole string). I'm open to suggestion that this might be over-complicating it (as opposed if (testString.includes(` ${stringToRank}`))) but it at least keeps the search consistent.

Checklist:

• Documentation N/A
• Tests
• Ready to be merged
  

Summary by CodeRabbit

• Refactor

  • Reformatted and restructured test cases for improved readability and consistency without altering test logic or behavior.
  • Updated internal type formatting for clarity.

• Bug Fixes

  • Improved word boundary detection in ranking logic to better identify matches that start after spaces or suffixes.

• Style

  • Enhanced code formatting and spacing in test definitions for better maintainability.

[kentcdodds]

Thanks for the contribution! I should probably set up prettier in this project eventually, but it's pretty much in maintenance mode anyway as it "does what it says on the tin" so it's hard to justify making investments in it further 😅

Thanks for this improvement!

[github-actions]

🎉 This PR is included in version 8.0.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new internal generator to find all occurrences of a substring within a string and update the ranking logic to ensure that WORD_STARTS_WITH is correctly detected even when earlier non-word-start matches exist. Test cases are reformatted for clarity, with no changes to test logic.

Changes

File(s)	Change Summary
src/index.ts	Added indexesOf generator; updated getMatchRanking to check all substring occurrences for WORD_STARTS_WITH; minor type and style adjustments.
src/tests/index.ts	Reformatted test cases for readability; expanded test objects; added/clarified test entries; no logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant getMatchRanking
    participant indexesOf

    Caller->>getMatchRanking: Call with (testString, stringToRank)
    getMatchRanking->>indexesOf: Generate all indices of stringToRank in testString
    indexesOf-->>getMatchRanking: Iterator of indices
    loop For each index in iterator
        getMatchRanking->>getMatchRanking: Check if index is at word start (preceded by space)
        alt Word start found
            getMatchRanking-->>Caller: Return WORD_STARTS_WITH
        end
    end
    getMatchRanking-->>Caller: Return other ranking (if applicable)

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure WORD_STARTS_WITH is not shadowed by CONTAINS when a word-start match exists (#159)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

In the meadow of code, a bug did lurk,
Shadowing matches—oh, what a quirk!
Now every word start shines so bright,
No more confusion in autocomplete’s light.
With tests tidied up and logic anew,
This bunny hops on, code crisp as dew! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 025e4cf and 70f4b9a.

📒 Files selected for processing (2)

• src/__tests__/index.ts (7 hunks)
• src/index.ts (5 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.