Fixes #154: Unicode characters cause wholeWord to break #155
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduced `unicodeWordBoundaries` in `ProfanityOptions` to control word boundary behavior. - Updated `Profanity` class to handle both ASCII and Unicode-aware boundaries based on the new option. - Enhanced README with usage examples for the new feature. - Added tests to verify default behavior and custom settings for `unicodeWordBoundaries`.
There was a problem hiding this comment.
Pull Request Overview
This PR adds Unicode-aware word boundary support to fix issues with whole-word matching when Unicode characters are present. The enhancement allows proper handling of diacritics and Unicode punctuation while maintaining backward compatibility.
Key changes:
- Added
unicodeWordBoundariesoption that defaults tofalsefor performance - Enhanced regex building to support Unicode-aware word boundaries using
\p{L},\p{N}, and\p{M}character classes - Updated benchmarks to compare Unicode-aware vs ASCII performance
Reviewed Changes
Copilot reviewed 11 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/profanity-options.ts | Adds unicodeWordBoundaries option with false default |
| src/profanity.ts | Implements Unicode-aware word boundary logic in regex building and whitelist checking |
| tests/profanity-unicode-boundaries.spec.ts | Comprehensive test coverage for Unicode boundary scenarios |
| tests/profanity-options.spec.ts | Tests for the new unicodeWordBoundaries option |
| src/tools/benchmark/benchmark.ts | Enhanced benchmarks to compare Unicode vs ASCII performance with paired execution |
| README.md | Documentation for the new unicodeWordBoundaries option |
| package.json | Updated dependencies and Docker Compose syntax |
| .nvmrc | Updated Node.js version to 22.19.0 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 13 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #154: