perf: improve getAcronym helper

[Raghuboi]

What:

Re-implements getAcronym by replacing the nested split/forEach logic with a single index-based loop (see diff below).

Why:

• Removes two split allocations and extra loops.
• Cuts the helper’s runtime (~6× faster on Node 20) without altering behaviour.

How:

• Iterate through the string once, collecting the first non-delimiter character that follows a space, hyphen, or the start of the string.
• No public API or type changes; all existing tests remain green.

Checklist:

• Documentation N/A
• Tests N/A (existing suite covers this path)
• Ready to be merged

Summary by CodeRabbit

• Refactor
  • Improved the logic for generating acronyms from strings, resulting in more accurate handling of spaces and hyphens.
  • Enhanced documentation and added usage examples for better clarity.

[coderabbitai]

Walkthrough

The getAcronym function in src/index.ts was refactored. Instead of splitting the input string multiple times, the function now iterates through each character, treating spaces and hyphens as delimiters, and constructs the acronym by appending the first non-delimiter character after each delimiter or at the start. Documentation and examples were added.

Changes

File(s)	Change Summary
src/index.ts	Refactored getAcronym to use character iteration for acronym formation; updated documentation and added usage examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In the land of code, where acronyms bloom,
A bunny hopped in, dispelling the gloom.
No more splitting here and there—
Just one hop, skipping delimiters with flair!
Now, with each start, the letters align,
Acronyms crafted, simply divine.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 c240500 and ec109dc.

📒 Files selected for processing (1)

• src/index.ts (1 hunks)

🔇 Additional comments (2)

src/index.ts (2)

265-272: Excellent documentation with clear examples.

The added documentation effectively explains the segment identification logic and provides helpful examples that clearly illustrate the function's behavior with different input scenarios.

---

276-292: Excellent performance optimization with correct logic.

The new implementation efficiently replaces the nested split and forEach operations with a single character-by-character iteration. The algorithm correctly:

• Uses a "virtual delimiter" approach (prev = ' ') to handle the first character elegantly
• Identifies delimiter transitions to capture segment-starting characters
• Handles consecutive delimiters properly by skipping them
• Maintains the same behavior as the original implementation

The logic is sound and should deliver the claimed ~6x performance improvement while maintaining backward compatibility.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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 generate unit tests to generate unit tests for 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.

[kentcdodds]

Nice improvement! Thanks!

[github-actions]

🎉 This PR is included in version 8.1.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀