fix: add `napi-postinstall` dep for workaround `npm`'s bug #66

JounQin · 2025-04-19T21:20:41Z

close #56

Important

Add napi-postinstall dependency and update package metadata and dependencies to address npm bug.

Dependencies:
- Add napi-postinstall as a dependency in npm/package.json to workaround an npm bug.
- Update @napi-rs/cli to 3.0.0-alpha.78, @napi-rs/wasm-runtime to ^0.2.9, @types/node to ^22.14.1, and emnapi to ^1.4.3 in package.json.
Scripts:
- Add postinstall script in npm/package.json to run napi-postinstall unrs-resolver check.
Metadata:
- Update description, homepage, and repository fields in npm/package.json.

^{This description was created by}^{for d66dcea. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

Chores
- Updated package metadata fields for improved clarity and consistency.
- Added a post-installation script to enhance setup reliability.
- Introduced a new dependency for post-installation behavior.
- Updated development dependency versions for better stability and compatibility.

Copilot

Copilot reviewed 1 out of 3 changed files in this pull request and generated no comments.

Files not reviewed (2)

npm/package.json: Language not supported
package.json: Language not supported

coderabbitai · 2025-04-19T21:20:48Z

Walkthrough

The changes update the package.json file to unify metadata fields, adjust repository and funding URLs, and update the description. A new scripts section introduces a postinstall script that runs napi-postinstall unrs-resolver check, and a new dependency on napi-postinstall is added. Additionally, several development dependencies and the packageManager version are incremented. No changes are made to exported or public code entities.

Changes

File(s)	Change Summary
package.json	Updated description, homepage, repository, and funding fields; added `scripts.postinstall` and `napi-postinstall` dependency; updated devDependencies and `packageManager` versions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant npm
    participant PostinstallScript
    participant napi-postinstall

    User->>npm: Install package
    npm->>PostinstallScript: Run "postinstall" script
    PostinstallScript->>napi-postinstall: Execute "napi-postinstall unrs-resolver check"
    napi-postinstall-->>PostinstallScript: Perform post-install checks
    PostinstallScript-->>npm: Complete installation

Assessment against linked issues

Objective	Addressed	Explanation
Ensure native binding is properly loaded post-install to resolve ESLint error (#56)	✅

Poem

A hop and a skip, a package reborn,
With scripts that run after install in the morn.
URLs now tidy, dependencies tight,
The bunny ensures your bindings are right!
So nibble some carrots, rejoice and cheer—
The resolver’s improved for all who draw near! 🐇✨

📜 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 a2a4a11 and d66dcea.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (2)

npm/package.json (3 hunks)
package.json (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Test (windows-latest)

🔇 Additional comments (8)

package.json (2)

19-22: Verify devDependencies version bumps
Ensure compatibility of bumped devDependencies (@napi-rs/cli, @napi-rs/wasm-runtime, @types/node, emnapi) and confirm they don’t introduce breaking changes. Run local builds and the test suite after updating.

26-26: Update pnpm packageManager version
You’ve bumped packageManager to pnpm@10.8.1; please regenerate the lockfile (pnpm install) and ensure CI pipelines are updated to use this version.

npm/package.json (6)

4-4: Update package description
The new description “UnRS Resolver Node API with PNP support” correctly reflects the project name.

13-13: Anchor README in homepage URL
The homepage now includes #readme. Verify that the link points to the intended section in GitHub.

14-14: Simplify repository field
Switching to a string URL is supported by npm and simplifies the config.

46-46: Flatten funding field to string
Using a direct URL for funding matches npm schema and is easier to consume.

47-49: Add postinstall script for napi-postinstall
The postinstall hook runs napi-postinstall unrs-resolver check. Please test in a fresh install (CI and local) to ensure the binary is fetched and validation passes across all supported platforms.

50-52: Include napi-postinstall as runtime dependency
Adding napi-postinstall@^0.1.1 is necessary for the workaround. Confirm that version exists on npm and audit for any known vulnerabilities.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
@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 · 2025-04-19T21:21:09Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Package	Supply Chain Security	Quality	Maintenance
@napi-rs/wasm-runtime@0.2.8 ⏵ 0.2.9	⁺¹	⁺¹
@types/node@22.14.0 ⏵ 22.14.1		⁺¹
@napi-rs/cli@3.0.0-alpha.77 ⏵ 3.0.0-alpha.78
emnapi@1.4.0 ⏵ 1.4.3	⁺¹		⁺⁵

View full report

sonarqubecloud · 2025-04-19T21:21:29Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ellipsis-dev

Important

Looks good to me! 👍

Reviewed everything up to d66dcea in 50 seconds. Click for details.

Reviewed 63 lines of code in 2 files
Skipped 1 files when reviewing.
Skipped posting 7 draft comments. View those below.
Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. npm/package.json:47

Draft comment:
Ensure the 'postinstall' script and dependency 'napi-postinstall' correctly trigger native binding checks.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

2. package.json:13

Draft comment:
Version bumps in devDependencies and packageManager update look good; verify compatibility with your build workflow.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

3. npm/package.json:14

Draft comment:
Repository field now a string; confirm this is consistent with project conventions.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

4. npm/package.json:46

Draft comment:
Funding field changed from an object to a string; ensure this aligns with npm guidelines and remains consistent.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

5. npm/package.json:47

Draft comment:
Added postinstall script using napi-postinstall to work around the native binding issue; verify this resolves the ESLint error.
Reason this comment was not posted:
Confidence changes required: 33% <= threshold 50% None

6. package.json:19

Draft comment:
Updated dev dependency versions; ensure these upgrades (e.g. @napi-rs/cli, @napi-rs/wasm-runtime, @types/node, emnapi) are backward compatible.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

7. package.json:26

Draft comment:
Package manager version bumped to pnpm@10.8.1; ensure this version is available in your build environment.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

Workflow ID: wflow_1YYRPyMcubCt0HNy

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

fix: add napi-postinstall dep for workaround npm's bug

d66dcea

JounQin requested a review from Copilot April 19, 2025 21:20

Copilot AI reviewed Apr 19, 2025

View reviewed changes

ellipsis-dev bot reviewed Apr 19, 2025

View reviewed changes

JounQin merged commit 73def65 into main Apr 19, 2025
14 checks passed

JounQin deleted the fix/postinstall branch April 19, 2025 21:26

This was referenced Apr 22, 2025

Pnpm build scripts approval warning #85

Closed

Benchmark WASM version vs native version of npm module #88

Closed

coderabbitai bot mentioned this pull request Apr 24, 2025

feat: enable no_opt_arch flag for mimalloc-safe on linux-aarch64 #98

Merged

richardlau mentioned this pull request Apr 24, 2025

Test failures on AIX nodejs/node-addon-api#1654

Closed

This was referenced Apr 26, 2025

chore: bump napi-postinstall to support yarn/pnpm on webcontainer #103

Merged

fix: bump napi-postinstall to fix yarn pnp compatibility issue #106

Merged

chore: release v1.7.2 #107

Merged

kachick mentioned this pull request Apr 28, 2025

Fix failing coverage sunfish-shogi/shogihome#1183

Merged

7 tasks

coderabbitai bot mentioned this pull request Jul 6, 2025

chore: release v1.11.1 #181

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: add `napi-postinstall` dep for workaround `npm`'s bug #66

fix: add `napi-postinstall` dep for workaround `npm`'s bug #66

Uh oh!

JounQin commented Apr 19, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai bot commented Apr 19, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

socket-security bot commented Apr 19, 2025

Uh oh!

sonarqubecloud bot commented Apr 19, 2025

Uh oh!

ellipsis-dev bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix: add napi-postinstall dep for workaround npm's bug #66

fix: add napi-postinstall dep for workaround npm's bug #66

Uh oh!

Conversation

JounQin commented Apr 19, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

socket-security bot commented Apr 19, 2025

Uh oh!

sonarqubecloud bot commented Apr 19, 2025

Quality Gate passed

Uh oh!

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fix: add `napi-postinstall` dep for workaround `npm`'s bug #66

fix: add `napi-postinstall` dep for workaround `npm`'s bug #66

JounQin commented Apr 19, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)