Skip to content

feat: add symbol/split#8555

Open
12adarshkumar12 wants to merge 1 commit intostdlib-js:developfrom
12adarshkumar12:feature/symbol/split
Open

feat: add symbol/split#8555
12adarshkumar12 wants to merge 1 commit intostdlib-js:developfrom
12adarshkumar12:feature/symbol/split

Conversation

@12adarshkumar12
Copy link
Copy Markdown

@12adarshkumar12 12adarshkumar12 commented Nov 19, 2025 •
edited
Loading

Resolves #8488.

Description

What is the purpose of this pull request?

This pull request adds the @stdlib/symbol/split package.
The package behaves consistently with existing stdlib symbol packages such as
@stdlib/symbol/replace, @stdlib/symbol/iterator, and others.

This pull request:

  • Implements the SplitSymbol constant which exports Symbol.split when supported, or null otherwise.
  • Mirrors the structure and behavior of existing symbol packages exactly, per project standards.
  • Adds complete unit tests validating environmental support and aliasing to Symbol.split.
  • Includes examples demonstrating custom split behavior via the @@split method.
  • Provides REPL documentation, type definitions, and package metadata consistent with stdlib conventions.

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.

No.

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 PR was authored with ChatGPT’s assistance for generating boilerplate code, documentation, and test scaffolding, while all logic was reviewed and validated manually.

@stdlib-js/reviewers

@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Nov 19, 2025

👋 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 Gitter channel to chat with project maintainers and other community members.

We appreciate your contribution!

Documentation Links

@stdlib-bot stdlib-bot added First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. labels Nov 19, 2025
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Nov 19, 2025

Coverage Report

Package Statements Branches Functions Lines
symbol/split $\color{green}92/92$
$color{green}+100.00%$ 		$\color{red}2/3$
$color{green}+66.67%$ 		$\color{green}0/0$
$color{green}+100.00%$ 		$\color{green}92/92$
$color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

@stdlib-bot stdlib-bot added Good First PR A pull request resolving a Good First Issue. Potential Duplicate There might be another pull request resolving the same issue. labels Nov 19, 2025
@kgryte kgryte changed the title Added symbol/split feat: add symbol/split Dec 27, 2025
@kgryte kgryte added the Feature Issue or pull request for adding a new feature. label Dec 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Feature Issue or pull request for adding a new feature. 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. Potential Duplicate There might be another pull request resolving the same issue.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[RFC]: add symbol/split

3 participants

@12adarshkumar12 @stdlib-bot @kgryte