infinyon / infinyon/node-bindgen

Support for publishing NPM modules with binary targets

Open
#131 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

build help wanted nj-cli
Dominant language
Rust
Stars
587
Forks
43
PR merge metrics
No merged PRs in 30d

Description

`node-bindgen` is primary used for building native-modules using Rust. However, it assumes that consume of the modules has `rust/cargo` toolschain installed and expected to use to build modules. We need to enable for non rust users to consume the modules.

In order to do so we should do following

- [ ] Enhance `Nj-cli` to publish NPM modules with binaries bundles in. It should have list of rust target that should be included in the published module. For example: `[x86_64-apple-darwin, x86_64-unknown-linux-gnu]`.
- [ ] When modules are installed, it should only keep binaries that are specific to host

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Nj-cli publishing entry point and the module installation path. Trace how target lists and published binaries are currently handled, then define done as publishing the requested Rust targets and retaining only the host-specific binary after installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, rust
Domain
build-system, cli, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.