Skip to content

fix(string): handle emoji modifiers in previous grapheme breaks#12215

Open
sjh9714 wants to merge 2 commits into
stdlib-js:developfrom
sjh9714:fix-prev-grapheme-skin-tone-break
Open

fix(string): handle emoji modifiers in previous grapheme breaks#12215
sjh9714 wants to merge 2 commits into
stdlib-js:developfrom
sjh9714:fix-prev-grapheme-skin-tone-break

Conversation

@sjh9714
Copy link
Copy Markdown

@sjh9714 sjh9714 commented May 20, 2026

Resolves #1092.

Description

What is the purpose of this pull request?

This pull request:

  • Adds a regression test for prevGraphemeClusterBreak( '👉🏿' ) returning no previous break inside a single emoji modifier sequence.
  • Updates prevGraphemeClusterBreak to skip UTF-16 low surrogate code units without recording a grapheme break or clearing the grapheme/emoji property caches.
  • Keeps the existing behavior for separate emoji clusters such as prevGraphemeClusterBreak( '🌷🐷', 2 ) === 1.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

The filtered JavaScript lint command exits successfully, but reports existing warnings for Devanagari sample strings and synchronous fixture reads in this package's existing files.

I did not run the full repository-wide make test suite.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

I used Codex to inspect the affected grapheme-break code path, add the regression test, make the small implementation change, and run the listed local verification commands.

Testing

  • NODE_PATH=./lib/node_modules node - <<'NODE' ... reproduced the issue before the fix: prev(👉🏿)= 1, next(👉🏿)= -1, prev(🌷🐷,2)= 1.
  • make test-javascript TESTS_FILTER=".*/string/prev-grapheme-cluster-break/.*" failed before the fix with expected: -1, actual: 1 for the new regression test.
  • make TESTS_FILTER=".*/string/prev-grapheme-cluster-break/.*" test
  • make TESTS_FILTER=".*/string/next-grapheme-cluster-break/.*" test
  • make lint-javascript SOURCES_FILTER=".*/string/prev-grapheme-cluster-break/.*" TESTS_FILTER=".*/string/prev-grapheme-cluster-break/.*" EXAMPLES_FILTER=".*/string/prev-grapheme-cluster-break/.*" BENCHMARKS_FILTER=".*/string/prev-grapheme-cluster-break/.*"
  • git diff --check
  • make init

@stdlib-js/reviewers

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@sjh9714 sjh9714 requested a review from a team May 20, 2026 05:22
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. labels May 20, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

Getting Started

Next Steps

  1. A project maintainer will approve GitHub Actions workflows for your PR.
  2. All CI checks must pass before your submission can be fully reviewed.
  3. You'll need to address any failures in linting or unit tests.

Running Tests Locally

You can use make to run any of the CI commands locally from the root directory of the stdlib repository:

# Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"

# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"

If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR.

If you have any further questions while waiting for a response, please join our Zulip community to chat with project maintainers and other community members.

We appreciate your contribution!

Documentation Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Needs Review A pull request which needs code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug with skin tone emojis when using prevGraphemeClusterBreak package

2 participants