napi-postinstall

The postinstall script helper for handling native bindings in legacy npm versions, this is a reimplementation of the node-install functionality from esbuild for napi-rs ecosystem packages like rollup, @swc/core and unrs-resolver.

For more details, please refer to the following issues:

• npm/cli#4828 -- root cause
• napi-rs/napi-rs#2569
• unrs/unrs-resolver#56

TOC

• Usage
  • Install
  • CLI
  • API
    • Types
    • Example
• Sponsors and Backers
  • Sponsors
  • Backers
• Changelog
• License

Usage

Install

# pnpm
pnpm add napi-postinstall

# yarn
yarn add napi-postinstall

# npm
npm i napi-postinstall

# bun
bun add napi-postinstall

CLI

napi-postinstall unrs-resolver #<napi-package-name>

You can put it into scripts#postinstall of your package.json:

{
  "scripts": {
    "postinstall": "napi-postinstall unrs-resolver"
  }
}

This will check and prepare the napi binding packages for you automatically.

API

Types

// napi-postinstall
export interface PackageJson {
  name: string
  version: string
}

export declare function checkAndPreparePackage(
  packageNameOrPackageJson: PackageJson | string,
  checkVersion?: boolean,
): Promise<void>

// napi-postinstall/fallback
declare function fallback<T = unknown>(
  packageJsonPath: string,
  checkVersion?: boolean,
): T
export = fallback

Example

// index.js
const { checkAndPreparePackage, isNpm } = require('napi-postinstall')

if (isNpm()) {
  void checkAndPreparePackage('unrs-resolver' /* <napi-package-name> */)
}

// fallback.js
module.exports = require('napi-postinstall/fallback')(
  require.resolve('./package.json') /* <napi-package-json-path> */,
  true /* <check-version> */,
)

Sponsors and Backers

Sponsors

1stG	RxTS	UnTS

Backers

1stG	RxTS	UnTS

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

MIT © JounQin@1stG.me

Change Log

0.3.4

Patch Changes

• #56 9ce741b Thanks @JounQin! - feat: add support for loong64 arch and openharmony platform

0.3.3

Patch Changes

• #47 8447abb Thanks @WooWan! - feat: support for HTTP protocol in private registries

• #51 1d9c7d5 Thanks @mrginglymus! - feat: try reading package.json from cwd for cli usage

0.3.0

Minor Changes

• #40 d4719ff Thanks @JounQin! - feat: add runtime fallback and webcontainer support

0.2.5

Patch Changes

• #38 76b34bd Thanks @WooWan! - feat: handle 307 and 308 redirect status codes

0.2.4

Patch Changes

• #32 6195df6 Thanks @JounQin! - fix: target ES2020 for Node <15 compatibility

0.2.3

Patch Changes

• #27 f52b3e9 Thanks @JounQin! - fix: newPath dir could be unavailable, make sure it's already there

0.2.2

Patch Changes

• #25 2eb7867 Thanks @mrginglymus! - fix: give up patching yarn pnp automatically which is impossible

0.2.1

Patch Changes

• #23 f14cd3f Thanks @JounQin! - fix: always use wasm32-wasi target for webcontainer

0.2.0

Minor Changes

• #21 2d6c726 Thanks @JounQin! - feat: support reading package.json from npm registry

• #21 2d6c726 Thanks @JounQin! - feat: support yarn/pnpm seamlessly for webcontainer

0.1.6

Patch Changes

• #18 8a887ee Thanks @JounQin! - fix: support install wasm32-wasi correctly with --cpu=wasm32

0.1.5

Patch Changes

• c88dc0c Thanks @JounQin! - fix: isNpm detection

0.1.4

Patch Changes

• 87ecdd2 Thanks @JounQin! - fix: only check for npm

0.1.3

Patch Changes

• #12 5b8ff18 Thanks @JounQin! - chore: remove unnecessary tslib by targeting ES2021

0.1.2

Patch Changes

• #8 68a8acc Thanks @JounQin! - fix: tslib should be listed as dependency

0.1.1

Patch Changes

• #6 c56e93a Thanks @JounQin! - fix: allow optional optionalDependencies for development

0.1.0

Minor Changes

• #3 cc98bce Thanks @JounQin! - feat: first blood, should just work