Skip to content

feat: add symbol/split #8498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

feat: add symbol/split #8498

wants to merge 3 commits into from
+290 −1

Conversation

@AdminAdi
Copy link

@AdminAdi AdminAdi commented Nov 10, 2025

Resolves #8488.

Description

What is the purpose of this pull request?

This pull request:

  • Adds new @stdlib/symbol/split package implementing Symbol.split support
  • Follows existing symbol package patterns (e.g., symbol/iterator, symbol/has-instance)
  • Includes comprehensive tests, benchmarks, and documentation
  • Exports Symbol.split when available, otherwise undefined

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 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.".

AI assistance was used for code structure guidance, test generation, and documentation formatting, but the implementation follows established stdlib patterns and was manually reviewed for consistency.

@stdlib-js/reviewers

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Nov 10, 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. Good First PR A pull request resolving a Good First Issue. labels Nov 10, 2025
@stdlib-bot stdlib-bot added Potential Duplicate There might be another pull request resolving the same issue. and removed Potential Duplicate There might be another pull request resolving the same issue. labels Nov 11, 2025
@AdminAdi
Copy link
Author

AdminAdi commented Nov 17, 2025

See I have resolved the issue please merge the PR

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
.github/workflows/run_tests_coverage.yml
# Pin action to full length commit SHA
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
with:
node-version: 20 # 'lts/*'
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is not desired.

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
lib/node_modules/@stdlib/symbol/split/README.md
<section class="usage">

## Usage
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file does not currently match project conventions.

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
lib/node_modules/@stdlib/symbol/split/lib/browser.js
* @see [MDN]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split}
* @default Symbol.split
*/
var SPLIT = ( typeof Symbol === 'function' && typeof Symbol.split === 'symbol' ) ? Symbol.split : '@@split'; // eslint-disable-line no-undef
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see other packages exposing symbols. This is not how we implement them.

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
lib/node_modules/@stdlib/symbol/split/main.js
* @see [MDN]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split}
* @default Symbol.split
*/
var SPLIT = ( typeof Symbol === 'function' && typeof Symbol.split === 'symbol' ) ? Symbol.split : '@@split'; // eslint-disable-line no-undef
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment.

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
lib/node_modules/@stdlib/symbol/split/package.json
Comment on lines +24 to +26
"test": "make test",
"test-cov": "make test-cov",
"examples": "make examples"
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should not be here. It is not clear why you added these.

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
lib/node_modules/@stdlib/symbol/split/package.json
},
"dependencies": {},
"devDependencies": {
"@stdlib/assert/has-symbol-support": "^0.0.0"
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be removed.

kgryte
kgryte reviewed Nov 18, 2025
View reviewed changes
lib/node_modules/@stdlib/symbol/split/package.json
"linux",
"macos",
"openbsd",
"posix",
Copy link
Member

@kgryte kgryte Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"posix",

Why was this added? This isn't an OS.

kgryte
kgryte requested changes Nov 18, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your interest; however, this PR does not follow project conventions. I suggest revisiting the original RFC and following its guidance.

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Nov 18, 2025
@kgryte kgryte changed the title Implemented Symbol.split package as per RFC requirements feat: add symbol/split Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

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 Changes Pull request which needs changes before being merged.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[RFC]: add symbol/split

3 participants

@AdminAdi @stdlib-bot @kgryte