Skip to content
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.

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

feat: support cjs and esm both by tshy #6

Merged
merged 1 commit into from
Jun 23, 2024
Merged

feat: support cjs and esm both by tshy #6

merged 1 commit into from
Jun 23, 2024

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Jun 23, 2024

BREAKING CHANGE: drop Node.js < 18.19.0 support

part of eggjs/egg#3644

eggjs/egg#5257

Summary by CodeRabbit

  • New Features

    • Updated LICENSE to include the MIT License text.
    • Added stricter TypeScript rules and node prefix enforcement in the ESLint configuration.
  • Chores

    • Updated Node.js versions in GitHub Actions workflows and added CODECOV_TOKEN secret.
    • Modified .gitignore to ignore new patterns.
  • Documentation

    • Refactored README.md to update import statements and function signatures.
  • Refactor

    • Refactored multiple files to switch from CommonJS to ES module imports.
    • Updated test files to use ES modules and improved test descriptions and assertions.
  • Configuration

    • Updated package.json for Node.js version requirement, script commands, and dev dependencies.
    • Enhanced tsconfig.json for stricter typing and ES2022 targeting.

BREAKING CHANGE: drop Node.js < 18.19.0 support

part of eggjs/egg#3644

eggjs/egg#5257
@fengmk2 fengmk2 self-assigned this Jun 23, 2024
Copy link

coderabbitai bot commented Jun 23, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The updates encompass multiple files, introducing enhanced TypeScript integration, updated Node.js version support, CI/CD adjustments, and various test and linting improvements. Significant alterations include transitioning from CommonJS to ES module imports, refining the build and export configuration, and updating license, README, and ignore files for better developer experience and compliance. These changes collectively modernize the codebase and streamline development workflows.

Changes

Files Summary
.eslintrc Extended ESLint configuration for TypeScript and node prefix rules.
.github/workflows/nodejs.yml Updated Node.js versions and added CODECOV_TOKEN secret.
.github/workflows/release.yml Removed checkTest parameter from job configuration.
.gitignore Added patterns to ignore .tshy*, .eslintcache, and dist directories.
LICENSE Updated with MIT License text including copyright information and permissions.
README.md Migrated from require to import, updated function signature in API section.
package.json Node.js version requirement, updated scripts, dev dependencies, and module exports configuration.
src/index.ts Improved message handling and debugging for worker threads and child processes.
test/child.js, test/sendmessage.test.js Switched from CommonJS to ES module imports and updated test cases accordingly.
tsconfig.json Extended config from @eggjs/tsconfig, enhanced compiler options for stricter typing.

Poem

In the code where modules glow so bright,
Typescript swoops, enforcing right.
Lints and tests now sing in tune,
NodeJS secrets unveil soon.
With ES6 imports, so clear,
The code's a joy, let’s give a cheer!
Modern paths we now pursue,
Thanks to all; we're born anew! 🌟🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/[email protected] filesystem, unsafe Transitive: environment, shell +50 2.89 MB oss-bot
npm/[email protected] Transitive: environment, eval, filesystem, shell, unsafe +246 36.9 MB fengmk2

🚮 Removed packages: npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

Copy link

codecov bot commented Jun 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.14%. Comparing base (d54af2c) to head (0cf5ac6).

Additional details and impacted files
@@            Coverage Diff             @@
##           master       #6      +/-   ##
==========================================
+ Coverage   95.65%   97.14%   +1.49%     
==========================================
  Files           1        1              
  Lines          46       70      +24     
  Branches        0       16      +16     
==========================================
+ Hits           44       68      +24     
  Misses          2        2              

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

@fengmk2 fengmk2 merged commit 30acc65 into master Jun 23, 2024
19 checks passed
@fengmk2 fengmk2 deleted the next-major branch June 23, 2024 16:28
fengmk2 pushed a commit that referenced this pull request Jun 23, 2024
[skip ci]

## [3.0.0](v2.0.0...v3.0.0) (2024-06-23)

### ⚠ BREAKING CHANGES

* drop Node.js < 18.19.0 support

part of eggjs/egg#3644

eggjs/egg#5257

### Features

* support cjs and esm both by tshy ([#6](#6)) ([30acc65](30acc65))
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