Added symbol/split
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
SplitSymbolconstant which exportsSymbol.splitwhen supported, ornullotherwise. - 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
@@splitmethod. - 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:
- #8488
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.
- [x] Read, understood, and followed the contributing guidelines.
AI Assistance
When authoring the changes proposed in this PR, did you use any kind of AI assistance?
- [x] Yes
- [ ] No
If you answered "yes" above, how did you use AI assistance?
- [x] Code generation (e.g., when writing an implementation or fixing a bug)
- [x] Test/benchmark generation
- [x] 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
:wave: Hi there! :wave:
And thank you for opening your first pull request! We will review it shortly. :runner: :dash:
Getting Started
- Please read our contributing guidelines if you haven't already.
- For development guidance, refer to the development guide.
Next Steps
- A project maintainer will approve GitHub Actions workflows for your PR.
- All CI checks must pass before your submission can be fully reviewed.
- 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
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.