@napi-rs/package-template

Template project for writing node package with napi-rs

``

.

Install this test package

yarn add 

Support matrix

Operating Systems

node12 node14 node16
Windows x64
Windows x32
Windows arm64
macOS x64
macOS arm64
Linux x64 gnu
Linux x64 musl
Linux arm gnu
Linux arm64 gnu
Linux arm64 musl
Android arm64
FreeBSD x64

Ability

Build

After yarn build/npm run build command, you can see package-template.[darwin|win32|linux].node file in project root. This is the native addon built from lib.rs.

Test

With ava, run yarn test/npm run test to testing native addon. You can also switch to another testing framework if you want.

CI

With GitHub actions, every commits and pull request will be built and tested automatically in [[email protected], [email protected], @node16] x [macOS, Linux, Windows] matrix. You will never be afraid of the native addon broken in these platforms.

Release

Release native package is very difficult in old days. Native packages may ask developers who use its to install build toolchain like gcc/llvm , node-gyp or something more.

With GitHub actions, we can easily prebuild binary for major platforms. And with N-API, we should never afraid of ABI Compatible.

The other problem is how to deliver prebuild binary to users. Download it in postinstall script is a common way which most packages do it right now. The problem of this solution is it introduced many other packages to download binary which has not been used by runtime codes. The other problem is some user may not easily download the binary from GitHub/CDN if they are behind private network (But in most case, they have a private NPM mirror).

In this package we choose a better way to solve this problem. We release different npm packages for different platform. And add it to optionalDependencies before release the Major package to npm.

NPM will choose which native package should download from registry automatically. You can see npm dir for details. And you can also run yarn add to see how it works.

Develop requirements

Test in local

  • yarn
  • yarn build
  • yarn test

And you will see:

$ ava --verbose

  ✔ sync function from native code
  ✔ sleep function from native code (201ms)
  ─

  2 tests passed
✨  Done in 1.12s.

Release package

Ensure you have set you NPM_TOKEN in GitHub project setting.

In Settings -> Secrets, add NPM_TOKEN into it.

When you want release package:

yarn version [xxx]

git push --follow-tags

GitHub actions will do the rest job for you.

Information - Updated Oct 21, 2021

Stars: 0
Forks: 0
Issues: 0

Requirement for Windows

Toolchain used stable-x86_64-pc-windows-gnu

Requirement for Windows

A free command for Windows

Install with cargo install dfree

A free command for Windows

Notatin is a Rust parser for offline Windows Registry files

This project is currently pre-release and should not be used for active investigations

Notatin is a Rust parser for offline Windows Registry files

Linux, macOS, Windows:

Rust bindings to the PC/SC API for smart card communication

Linux, macOS, Windows:

This crate has stopped updating, please use rust-fatfs

This crate has stopped updating, please use sdio_sdhc and WindowsAPI

This crate has stopped updating, please use rust-fatfs
Game

346

Run any Windows program through Valve's Proton

Run any Windows program through Usage

Run any Windows program through Valve's Proton

A custom built API server to dynamically resize images based upon a URL query

Because window aspect ratios vary from device to device, serving a 3840×2160 pixel image to a 640x480 client viewport is a waste of bandwidth and...

A custom built API server to dynamically resize images based upon a URL query

A rust crate for managing multiple consoles from one windows application

Normaly a program running on windows can only use one console

A rust crate for managing multiple consoles from one windows application

Windows Firewall

Interact with the from Rust

Windows Firewall

Coverts simple basic shell scripts to windows batch scripts

cargo-make a way to write simple tasks with shell scripts without duplicating their code for each platform

Coverts simple basic shell scripts to windows batch scripts

A pure Rust library for reading/writing Windows

A pure Rust library for reading/writing License

A pure Rust library for reading/writing Windows
Facebook Instagram Twitter GitHub Dribbble
Privacy