feat: support cjs and esm both by tshy #2

fengmk2 · 2024-12-20T12:22:49Z

BREAKING CHANGE: drop Node.js < 18.19.0 support

part of eggjs/egg#3644

eggjs/egg#5257

Summary by CodeRabbit

Release Notes

New Features
- Introduced new GitHub Actions workflows for CI, package publishing, and releases.
- Added a new TypeScript configuration file to enforce strict type-checking.
- Updated package name to @cnpmjs/muk-prop with improved installation instructions.
Bug Fixes
- Enhanced type definitions and refactored mock functionality for better clarity and safety.
Documentation
- Comprehensive updates to the README, including usage examples and installation instructions.
Chores
- Updated .gitignore to exclude additional files and directories.
- Removed Travis CI configuration file.

BREAKING CHANGE: drop Node.js < 18.19.0 support part of eggjs/egg#3644 eggjs/egg#5257

coderabbitai · 2024-12-20T12:22:56Z

Warning

Rate limit exceeded

@fengmk2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e47a73b and ee9eb41.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (12)

.eslintrc (1 hunks)
.github/workflows/nodejs.yml (1 hunks)
.github/workflows/pkg.pr.new.yml (1 hunks)
.github/workflows/release.yml (1 hunks)
.gitignore (1 hunks)
.travis.yml (0 hunks)
LICENSE (1 hunks)
README.md (3 hunks)
package.json (1 hunks)
src/index.ts (4 hunks)
test/method.test.ts (12 hunks)
tsconfig.json (1 hunks)

Walkthrough

This pull request introduces a comprehensive modernization of the muk-prop library, transitioning it to a TypeScript-based project with improved module support, updated CI/CD workflows, and enhanced type safety. The changes include migrating to ES modules, updating package configuration, introducing GitHub Actions for continuous integration and release management, and refactoring the core library implementation with stricter type definitions.

Changes

File	Change Summary
`.eslintrc`	Added ESLint configuration extending TypeScript and Node.js prefix rules
`.github/workflows/nodejs.yml`	New CI workflow for Node.js testing across multiple versions
`.github/workflows/pkg.pr.new.yml`	Added workflow for package publishing
`.github/workflows/release.yml`	New workflow for automated releases
`.gitignore`	Updated with additional ignore patterns for build and cache files
`.travis.yml`	Removed legacy Travis CI configuration
`LICENSE`	Updated copyright notice
`README.md`	Comprehensive update with new package name and badges
`package.json`	Major restructuring with ES module support, new dependencies, and publish configuration
`src/index.ts`	Refactored with improved type definitions and modern JavaScript practices
`test/method.test.ts`	Migrated to ES module imports and added type annotations
`tsconfig.json`	New TypeScript configuration with strict type checking

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Repo as GitHub Repository
    participant CI as GitHub Actions
    participant NPM as NPM Registry

    Dev->>Repo: Push changes
    Repo->>CI: Trigger workflows
    CI->>CI: Run linting
    CI->>CI: Run tests
    CI->>CI: Build package
    alt All checks pass
        CI->>NPM: Publish package
        NPM-->>Dev: Package published
    else Checks fail
        CI-->>Dev: Workflow failure notification
    end

Poem

🐰 A Rabbit's Ode to Code Renewal 🚀

From CommonJS to modules bright,
TypeScript dancing with delight,
CI workflows spinning free,
Muk-prop leaps with agility!

Hop, hop, hooray! 🎉

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>, 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. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

socket-security · 2024-12-20T12:23:09Z

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

View full report↗︎

pkg-pr-new · 2024-12-20T12:23:30Z

Open in Stackblitz

npm i https://pkg.pr.new/node-modules/muk-prop.js/@cnpmjs/muk-prop@2

commit: ee9eb41

codecov · 2024-12-20T12:27:51Z

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

[skip ci] ## 1.0.0 (2024-12-20) ### ⚠ BREAKING CHANGES * drop Node.js < 18.19.0 support part of eggjs/egg#3644 eggjs/egg#5257 ### Features * add isMocked method to check if the member of the object is mocked ([986493c](986493c)) * reset package ([6779edb](6779edb)) * support cjs and esm both by tshy ([#2](#2)) ([49d3982](49d3982)) * support mock prop with getter setter ([#4](#4)) ([0ba2ae2](0ba2ae2)) ### Bug Fixes * can't redefine process.env when node<4 ([7de27b7](7de27b7)), closes [nodejs/node#2999](nodejs/node#2999) * clear mock cache when restore ([790b26c](790b26c)) * hasOwnProperty not found ([5e40063](5e40063)) * muk can mock accessor descriptor now ([73001d7](73001d7)) * should check process.env ([1cefede](1cefede))

fengmk2 added 2 commits December 20, 2024 19:44

remove package-lock.json

75ba8a4

feat: support cjs and esm both by tshy

ace4a3c

BREAKING CHANGE: drop Node.js < 18.19.0 support part of eggjs/egg#3644 eggjs/egg#5257

fengmk2 changed the title ~~Egg v4~~ feat: support cjs and esm both by tshy Dec 20, 2024

f

3c2e0aa

f

ee9eb41

fengmk2 merged commit 49d3982 into master Dec 20, 2024
5 checks passed

fengmk2 deleted the egg-v4 branch December 20, 2024 12:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support cjs and esm both by tshy #2

feat: support cjs and esm both by tshy #2

fengmk2 commented Dec 20, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 20, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

socket-security bot commented Dec 20, 2024 •

edited

Loading

pkg-pr-new bot commented Dec 20, 2024 •

edited

Loading

codecov bot commented Dec 20, 2024

feat: support cjs and esm both by tshy #2

feat: support cjs and esm both by tshy #2

Conversation

fengmk2 commented Dec 20, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

Release Notes

coderabbitai bot commented Dec 20, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

socket-security bot commented Dec 20, 2024 • edited Loading

pkg-pr-new bot commented Dec 20, 2024 • edited Loading

codecov bot commented Dec 20, 2024

Welcome to Codecov 🎉

fengmk2 commented Dec 20, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 20, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

socket-security bot commented Dec 20, 2024 •

edited

Loading

pkg-pr-new bot commented Dec 20, 2024 •

edited

Loading