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: hasOwn support Node.js 14 #25

Merged
merged 2 commits into from
Dec 9, 2024
Merged

feat: hasOwn support Node.js 14 #25

merged 2 commits into from
Dec 9, 2024

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Dec 9, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new CI workflow for Node.js version 14.
  • Improvements

    • Expanded CI testing to include Node.js version 22.
    • Updated dependency version for tshy to 3.0.2.
    • Enhanced compatibility for property checks across different Node.js versions.
    • Added various badges and a contributors section to the README.

Copy link

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request involve modifications to Continuous Integration (CI) configurations and package dependencies. The .github/workflows/ci.yml file was updated to include Node.js version 22 in the CI process. A new workflow file, .github/workflows/nodejs-14.yml, was added to support CI for Node.js version 14. Additionally, the package.json file was updated to change the tshy dependency version from ^1.0.0 to ^3.0.2 and clarify the exports structure. Lastly, the hasOwnProperty function in src/types/util.ts was modified for better compatibility with Node.js versions.

Changes

File Change Summary
.github/workflows/ci.yml Updated Node.js version parameter from '16, 18, 20' to '16, 18, 20, 22'.
.github/workflows/nodejs-14.yml Added new workflow for Node.js 14 CI, including steps for checkout, setup, install, and testing.
package.json Updated tshy dependency from ^1.0.0 to ^3.0.2 and clarified exports structure.
src/types/util.ts Modified hasOwnProperty function to check for Object.hasOwn for compatibility with Node.js 16+.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CI
    participant Node14
    participant Node22
    User->>CI: Push to master
    CI->>Node14: Setup Node.js 14
    Node14->>CI: Run tests
    CI->>Node22: Setup Node.js 22
    Node22->>CI: Run tests
    CI->>User: CI results
Loading

🐇 "In the garden of code, we hop with glee,
New versions of Node, as fresh as can be!
With tests that run swift, and dependencies bright,
Our project grows stronger, a true delight!
So let’s celebrate changes, let’s dance and cheer,
For every new version brings us good cheer!" 🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 08e3ded and 23e3e0c.

📒 Files selected for processing (2)
  • README.md (2 hunks)
  • package.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json

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

Copy link

@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: 1

🧹 Outside diff range and nitpick comments (1)
package.json (1)

Line range hint 39-41: Critical: Node.js engine requirement conflicts with PR objective.

The package.json specifies ">= 16.0.0" as the Node.js engine requirement, but this PR's objective is to add Node.js 14 support. This needs to be updated to ">= 14.0.0" to align with the PR's goal.

  "node": {
-    "engines": ">= 16.0.0"
+    "engines": ">= 14.0.0"
  },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2aa95f8 and 08e3ded.

📒 Files selected for processing (4)
  • .github/workflows/ci.yml (1 hunks)
  • .github/workflows/nodejs-14.yml (1 hunks)
  • package.json (1 hunks)
  • src/types/util.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .github/workflows/nodejs-14.yml
🔇 Additional comments (2)
src/types/util.ts (1)

9-13: LGTM! Excellent backward compatibility implementation.

The implementation correctly handles both modern and legacy Node.js versions by:

  • Using Object.hasOwn when available (Node.js ≥ 16.9.0)
  • Falling back to Object.prototype.hasOwnProperty.call for older versions

Let's verify the Node.js version compatibility:

.github/workflows/ci.yml (1)

16-16: Verify Node.js 14 CI coverage.

While adding Node.js 22 is great for future-proofing, this PR's objective is to add Node.js 14 support. However:

  1. Node.js 14 is not included in the test matrix
  2. The mentioned .github/workflows/nodejs-14.yml file appears to be missing from the PR

Let's verify the Node.js version requirements:

@@ -64,7 +64,7 @@
"long": "^3.2.0",
"semver": "^5.4.1",
"ts-expect": "^1.3.0",
"tshy": "^1.0.0",
"tshy": "^3.0.2",
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

tshy v3.0.2 is incompatible with Node.js 14

The tshy v3.0.2 package requires Node.js 20 or >=22, which conflicts with the PR's objective to support Node.js 14. This dependency update would prevent the package from working on Node.js 14.

  • Consider using an older version of tshy that supports Node.js 14
  • Or remove Node.js 14 support from the PR's objectives
🔗 Analysis chain

Consider if tshy v3.0.2 supports Node.js 14.

The tshy dependency was updated to ^3.0.2. Please verify its compatibility with Node.js 14.

Let's check tshy's version requirements:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check tshy package requirements
# Expected: Should support Node.js 14

# Check tshy package.json for engine requirements
curl -s https://registry.npmjs.org/tshy/3.0.2 | jq '.engines'

Length of output: 88

@fengmk2 fengmk2 merged commit 857bdff into master Dec 9, 2024
8 checks passed
@fengmk2 fengmk2 deleted the hasOwn-support-node-14 branch December 9, 2024 04:17
fengmk2 pushed a commit that referenced this pull request Dec 9, 2024
[skip ci]

## [2.2.0](v2.1.0...v2.2.0) (2024-12-09)

### Features

* hasOwn support Node.js 14 ([#25](#25)) ([857bdff](857bdff))
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