Skip to content

chore: release synckit#221

Merged
JounQin merged 2 commits intomainfrom
changeset-release/main
Apr 2, 2025
Merged

chore: release synckit#221
JounQin merged 2 commits intomainfrom
changeset-release/main

Conversation

@JounQin
Copy link
Member

@JounQin JounQin commented Apr 2, 2025

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

synckit@0.11.0

Minor Changes

  • #222 59f7432 Thanks @JounQin! - feat: add oxc ts runner support, correct swc ts runner with --import flag support

Patch Changes

  • #222 59f7432 Thanks @JounQin! - fix: .cjs should never be treated as ESM

  • #219 79fa3a2 Thanks @JounQin! - refactor: split into chunk files, add module-sync entry

  • #222 59f7432 Thanks @JounQin! - fix: only consider process.features.typescript when --no-experimental-strip-types flag enabled

Summary by CodeRabbit

  • New Features

    • Added support for an additional TypeScript runner.
  • Bug Fixes

    • Fixed issues with flag handling for a TypeScript runner.
    • Resolved discrepancies in module file type recognition.
  • Refactor

    • Improved module synchronization with a streamlined code structure.
  • Chores

    • Updated the release version to 0.11.0.
  • Documentation

    • Enhanced README with updated badges for workflow status and pull request reviews.
  • Changelog

    • Added a new section in the CHANGELOG for version 0.11.0, detailing minor and patch changes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

The changes involve the deletion of the file .changeset/spicy-walls-listen.md, which documented a refactor of the synckit module, including its restructuring into chunk files and the addition of a module-sync entry. A new section has been added to CHANGELOG.md for version 0.11.0, detailing minor and patch changes. Additionally, the package version in package.json has been updated from 0.10.3 to 0.11.0. No alterations were made to exported or public entities.

Changes

File(s) Change Summary
.changeset/spicy-walls-listen.md, CHANGELOG.md Deleted the changeset file documenting the module refactor and added a new changelog entry for version 0.11.0, detailing minor and patch changes.
package.json Updated the synckit package version from 0.10.3 to 0.11.0.
README.md Updated badges at the top of the document, replacing the GitHub Actions badge and adding a new badge for "CodeRabbit Pull Request Reviews."

Possibly related PRs

  • feat: add oxc ts runner support #222: The changes in the main PR, which involve a refactor of the "synckit" module and the addition of a module-sync entry, are related to the retrieved PR that introduces support for the oxc TypeScript runner, as both involve modifications to the module's structure and functionality.

Poem

I'm a bouncy rabbit in lines of code,
Hopping over patches on this digital road.
The module splits just like my hops so neat,
Version bumped in a rhythmic beat.
With carrots 🥕 and code, my joy's complete!

Happy to crunch these changes with my floppy ears!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 357c38f and adfe18b.

📒 Files selected for processing (1)
  • README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Lint and Test with Node.js 22 on windows-latest
  • GitHub Check: Lint and Test with Node.js 23 on windows-latest
  • GitHub Check: Lint and Test with Node.js 20 on windows-latest
  • GitHub Check: Lint and Test with Node.js 20 on macos-latest
  • GitHub Check: Lint and Test with Node.js 18.18 on windows-latest
  • GitHub Check: Lint and Test with Node.js 18 on macos-latest
  • GitHub Check: Lint and Test with Node.js 18 on windows-latest
  • GitHub Check: Lint and Test with Node.js 22 on macos-latest
  • GitHub Check: Lint and Test with Node.js 23 on macos-latest
  • GitHub Check: Lint and Test with Node.js 23 on windows-latest
  • GitHub Check: Lint and Test with Node.js 22 on windows-latest
  • GitHub Check: Lint and Test with Node.js 20 on windows-latest
  • GitHub Check: Lint and Test with Node.js 18 on windows-latest
  • GitHub Check: Lint and Test with Node.js 18.18 on windows-latest
  • GitHub Check: Lint and Test with Node.js 18 on macos-latest
🔇 Additional comments (2)
README.md (2)

3-3: Updated GitHub Actions Badge: Clear Enhancement

The updated badge now specifically queries the status for the main branch. This improves clarity on the workflow status and ensures that visitors see the current build state.


6-6: New CodeRabbit Pull Request Reviews Badge: Valuable Addition

The added badge provides insightful metrics for pull request reviews through CodeRabbit. Its inclusion can enhance transparency and engagement for contributors.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codesandbox-ci
Copy link

codesandbox-ci bot commented Apr 2, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Apr 2, 2025

Open in StackBlitz

npm i https://pkg.pr.new/synckit@221

commit: adfe18b

@github-actions
Copy link
Contributor

github-actions bot commented Apr 2, 2025

📊 Package size report   0.2%↑

File Before After
README.md 15.6 kB 1%↑15.8 kB
Total (Includes all files) 95.7 kB 0.2%↑95.9 kB
Tarball size 23.0 kB 0.3%↑23.1 kB
Unchanged files
File Size
index.d.cts 60 B
lib/common.d.ts 329 B
lib/common.js 987 B
lib/common.js.map 1.2 kB
lib/constants.d.ts 1.8 kB
lib/constants.js 2.4 kB
lib/constants.js.map 2.3 kB
lib/helpers.d.ts 1.5 kB
lib/helpers.js 17.3 kB
lib/helpers.js.map 15.3 kB
lib/index.cjs 24.3 kB
lib/index.d.ts 424 B
lib/index.js 2.6 kB
lib/index.js.map 2.5 kB
lib/types.d.ts 1.4 kB
lib/types.js 44 B
lib/types.js.map 102 B
LICENSE 1.1 kB
package.json 4.3 kB

🤖 This report was automatically generated by pkg-size-action

@codecov
Copy link

codecov bot commented Apr 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.80%. Comparing base (59f7432) to head (adfe18b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #221   +/-   ##
=======================================
  Coverage   95.80%   95.80%           
=======================================
  Files           4        4           
  Lines         334      334           
  Branches      155      155           
=======================================
  Hits          320      320           
  Misses         14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
package.json (1)

16-29: Verify module-sync Exports Consistency
A new "module-sync" export entry has been added. It mirrors the "import" configuration, which looks intentional given the refactor split into chunk files. Please double-check that exposing the same file paths for both "import" and "module-sync" meets your consumer compatibility requirements.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79fa3a2 and be78dfa.

📒 Files selected for processing (3)
  • .changeset/spicy-walls-listen.md (0 hunks)
  • CHANGELOG.md (1 hunks)
  • package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • .changeset/spicy-walls-listen.md
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Lint and Test with Node.js 22 on macos-latest
  • GitHub Check: Lint and Test with Node.js 20 on macos-latest
  • GitHub Check: Lint and Test with Node.js 23 on windows-latest
  • GitHub Check: Lint and Test with Node.js 18.18 on windows-latest
  • GitHub Check: Lint and Test with Node.js 22 on windows-latest
  • GitHub Check: Lint and Test with Node.js 20 on windows-latest
  • GitHub Check: Lint and Test with Node.js 23 on macos-latest
  • GitHub Check: Lint and Test with Node.js 18 on macos-latest
  • GitHub Check: Lint and Test with Node.js 18 on windows-latest
🔇 Additional comments (2)
package.json (1)

3-3: Version Bump Verification
The package version is updated from "0.10.3" to "0.10.4", which correctly reflects the intended patch release. Ensure that this version bump is in sync with your release pipelines and related documentation.

CHANGELOG.md (1)

3-8: Changelog Update for Version 0.10.4
The changelog now includes a section for version 0.10.4 that documents the patch change with reference to pull request #219 and commit 79fa3a2. This clear documentation aligns well with the intended release process.

@github-actions github-actions bot force-pushed the changeset-release/main branch from be78dfa to 357c38f Compare April 2, 2025 08:50
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.md (1)

3-3: Release Version Header Added Successfully

The new version header ## 0.11.0 is clearly introduced. Optionally, consider including the release date for additional clarity if it aligns with your changelog style.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be78dfa and 357c38f.

📒 Files selected for processing (3)
  • .changeset/spicy-walls-listen.md (0 hunks)
  • CHANGELOG.md (1 hunks)
  • package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • .changeset/spicy-walls-listen.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
CHANGELOG.md (2)

5-8: Minor Changes Section is Clear and Informative

The "### Minor Changes" block documents the enhancements—namely, the addition of oxc TypeScript runner support and the correction of the swc runner with the --import flag. The commit reference and contributor attribution are correctly formatted.


9-16: Patch Changes Section Documented Neatly

The "### Patch Changes" block is well organized and succinctly describes the patch fixes:

  • Ensuring .cjs files are not mistaken for ESM.
  • Splitting the code into chunk files with the addition of a module-sync entry.
  • Correctly conditioning the process.features.typescript consideration with the --no-experimental-strip-types flag.

The formatting and linking to PR numbers and commit hashes are consistent.

@JounQin JounQin closed this Apr 2, 2025
@JounQin JounQin reopened this Apr 2, 2025
@JounQin
Copy link
Member Author

JounQin commented Apr 2, 2025

The new version header ## 0.11.0 is clearly introduced. Optionally, consider including the release date for additional clarity if it aligns with your changelog style.

@coderabbitai Our CHANGELOG.md is maintained by automation tool, don't review that anymore.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Tip

For best results, initiate chat on the files or code changes.

@JounQin I understand now. Thank you for letting me know that the CHANGELOG.md file is maintained by an automated tool. I'll refrain from reviewing this file in future PRs for this repository.

🐰 scribbles notes thoughtfully

✏️ Learnings added
Learnt from: JounQin
URL: https://github.com/un-ts/synckit/pull/221

Timestamp: 2025-04-02T08:59:03.195Z
Learning: For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automated tool and should not be reviewed.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Tip

For best results, initiate chat on the files or code changes.

@JounQin Thank you for letting me know that the CHANGELOG.md is maintained by an automation tool. I'll refrain from reviewing it in future PRs.

✏️ Learnings added
Learnt from: JounQin
URL: https://github.com/un-ts/synckit/pull/221

Timestamp: 2025-04-02T08:59:15.908Z
Learning: For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automation tool and should not be reviewed.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Tip

For best results, initiate chat on the files or code changes.

@JounQin I've already noted this instruction in my system. I see that I've responded to this same comment twice before, which resulted in duplicate learnings being saved:

  1. "For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automation tool and should not be reviewed."
  2. "For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automated tool and should not be reviewed."

Would you like me to remove one of these duplicate learnings? You can also manage these learnings yourself through the CodeRabbit UI learnings page.

🐰 looks a bit confused at the duplicate entries


🧠 Learnings used
Learnt from: JounQin
PR: un-ts/synckit#0
File: :0-0
Timestamp: 2025-04-02T08:59:16.178Z
Learning: For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automation tool and should not be reviewed.

Learnt from: JounQin
PR: un-ts/synckit#0
File: :0-0
Timestamp: 2025-04-02T08:59:03.374Z
Learning: For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automated tool and should not be reviewed.

@JounQin
Copy link
Member Author

JounQin commented Apr 2, 2025

Would you like me to remove one of these duplicate learnings? You can also manage these learnings yourself through the CodeRabbit UI learnings page.

@coderabbitai Yes, remove duplicate or simular learnings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Tip

For best results, initiate chat on the files or code changes.

@JounQin I'll remove one of the duplicate learnings. I'll keep the learning that states "For the un-ts/synckit repository, the CHANGELOG.md file is maintained by an automated tool and should not be reviewed." as it uses more precise wording.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 2, 2025

@JounQin JounQin merged commit 63036a0 into main Apr 2, 2025
45 checks passed
@JounQin JounQin deleted the changeset-release/main branch April 2, 2025 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant