node char diff with rust
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jay 29e3855841
update package name
3 years ago
.github/workflows Initial commit 3 years ago
__test__ [feat] update 3 years ago
npm [feat] modify package.json 3 years ago
scripts [feat] modify package.json 3 years ago
src [feat] add diffLines function 3 years ago
.gitignore first version 3 years ago
.npmignore update 3 years ago
Cargo.toml update package name 3 years ago
LICENSE Initial commit 3 years ago Initial commit 3 years ago Initial commit 3 years ago
index.d.ts [feat] add diffLines function 3 years ago
index.js [feat] add diffLines function 3 years ago
package-lock.json [feat] add diffLines function 3 years ago
package.json [feat] update 3 years ago
yarn.lock Initial commit 3 years ago


Template project for writing node package with napi-rs.

Install this test package

yarn add @napi-rs/package-template

Support matrix

⚠️ Linux musl has not been supported now.

Operating Systems

Linux macOS Windows x64 MSVC


Node10 Node 12 Node14



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


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


With github actions, every commits and pull request will be built and tested automatically in [node@10, node@12, @node14] x [macOS, Linux, Windows] matrix. You will never be afraid of the native addon broken in these platforms.


Release native package is very difficult in old days. Native packages may ask developers who use its to install build toolchains 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 @napi-rs/package-template to see how it works.

Develop requirements

  • Install latest Rust
  • Install NodeJS@8.9+ which supported N-API
  • Install yarn@1.x

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.