@napi-rs/cli 2.15.1 → 3.0.0-alpha.0

package/dist/api/templates/ci-template.js

@@ -0,0 +1,566 @@
+export const YAML = () => `
+name: CI
+
+env:
+  DEBUG: 'napi:*'
+  MACOSX_DEPLOYMENT_TARGET: '10.13'
+
+on:
+  push:
+    branches:
+      - main
+    tags-ignore:
+      - '**'
+    paths-ignore:
+      - '**/*.md'
+      - 'LICENSE'
+      - '**/*.gitignore'
+      - '.editorconfig'
+      - 'docs/**'
+  pull_request:
+
+jobs:
+  build:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - host: macos-latest
+            target: 'x86_64-apple-darwin'
+            build: |
+              yarn build --platform
+              strip -x *.node
+          - host: windows-latest
+            build: yarn build --platform
+            target: 'x86_64-pc-windows-msvc'
+          - host: windows-latest
+            build: |
+              yarn build --platform --target i686-pc-windows-msvc
+              yarn test
+            target: 'i686-pc-windows-msvc'
+          - host: ubuntu-latest
+            target: 'x86_64-unknown-linux-gnu'
+            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
+            build: >-
+              set -e &&\n
+              yarn build --platform --target x86_64-unknown-linux-gnu &&\n
+              strip *.node
+          - host: ubuntu-latest
+            target: 'x86_64-unknown-linux-musl'
+            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
+            build: >-
+              set -e &&
+              yarn build --platform &&
+              strip *.node
+          - host: macos-latest
+            target: 'aarch64-apple-darwin'
+            build: |
+              yarn build --platform --target aarch64-apple-darwin
+              strip -x *.node
+          - host: ubuntu-latest
+            target: 'aarch64-unknown-linux-gnu'
+            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian-aarch64
+            build: >-
+              set -e &&\n
+              yarn build --platform --target aarch64-unknown-linux-gnu &&\n
+              aarch64-unknown-linux-gnu-strip *.node
+          - host: ubuntu-latest
+            target: 'armv7-unknown-linux-gnueabihf'
+            setup: |
+              sudo apt-get update
+              sudo apt-get install gcc-arm-linux-gnueabihf -y
+            build: |
+              yarn build --platform --target armv7-unknown-linux-gnueabihf
+              arm-linux-gnueabihf-strip *.node
+          - host: ubuntu-latest
+            target: 'aarch64-linux-android'
+            build: |
+              yarn build --platform --target aarch64-linux-android
+              \${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-strip *.node
+          - host: ubuntu-latest
+            target: 'armv7-linux-androideabi'
+            build: |
+              yarn build --platform --target armv7-linux-androideabi
+              \${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-strip *.node
+          - host: ubuntu-latest
+            target: 'aarch64-unknown-linux-musl'
+            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
+            build: >-
+              set -e &&\n
+              rustup target add aarch64-unknown-linux-musl &&\n
+              yarn build --platform --target aarch64-unknown-linux-musl &&\n
+              /aarch64-linux-musl-cross/bin/aarch64-linux-musl-strip *.node
+          - host: windows-latest
+            target: 'aarch64-pc-windows-msvc'
+            build: yarn build --platform --target aarch64-pc-windows-msvc
+
+    name: stable - \${{ matrix.settings.target }} - node@18
+    runs-on: \${{ matrix.settings.host }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        if: \${{ !matrix.settings.docker }}
+        with:
+          node-version: 18
+          check-latest: true
+          cache: yarn
+
+      - name: Install
+        uses: dtolnay/rust-toolchain@stable
+        if: \${{ !matrix.settings.docker }}
+        with:
+          toolchain: stable
+          targets: \${{ matrix.settings.target }}
+
+      - name: Cache cargo
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            .cargo-cache
+            target/
+          key: \${{ matrix.settings.target }}-cargo-\${{ matrix.settings.host }}
+
+      - uses: goto-bus-stop/setup-zig@v2
+        if: \${{ matrix.settings.target == 'armv7-unknown-linux-gnueabihf' }}
+        with:
+          version: 0.10.1
+
+      - name: Setup toolchain
+        run: \${{ matrix.settings.setup }}
+        if: \${{ matrix.settings.setup }}
+        shell: bash
+
+      - name: Setup node x86
+        if: matrix.settings.target == 'i686-pc-windows-msvc'
+        run: yarn config set supportedArchitectures.cpu "ia32"
+        shell: bash
+
+      - name: 'Install dependencies'
+        run: yarn install
+
+      - name: Setup node x86
+        uses: actions/setup-node@v3
+        if: matrix.settings.target == 'i686-pc-windows-msvc'
+        with:
+          node-version: 18
+          check-latest: true
+          cache: yarn
+          architecture: x86
+
+      - name: Build in docker
+        uses: addnab/docker-run-action@v3
+        if: \${{ matrix.settings.docker }}
+        with:
+          image: \${{ matrix.settings.docker }}
+          options: --user 0:0 -v \${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v \${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v \${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v \${{ github.workspace }}:/build -w /build
+          run: \${{ matrix.settings.build }}
+
+      - name: 'Build'
+        run: \${{ matrix.settings.build }}
+        if: \${{ !matrix.settings.docker }}
+        shell: bash
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: bindings-\${{ matrix.settings.target }}
+          path: "*.node"
+          if-no-files-found: error
+
+  build-freebsd:
+    runs-on: macos-12
+    name: Build FreeBSD
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build
+        id: build
+        uses: vmactions/freebsd-vm@v0
+        env:
+          DEBUG: 'napi:*'
+          RUSTUP_HOME: /usr/local/rustup
+          CARGO_HOME: /usr/local/cargo
+          RUSTUP_IO_THREADS: 1
+        with:
+          envs: 'DEBUG RUSTUP_HOME CARGO_HOME RUSTUP_IO_THREADS'
+          usesh: true
+          mem: 3000
+          prepare: |
+            pkg install -y -f curl node libnghttp2
+            curl -qL https://www.npmjs.com/install.sh | sh
+            npm install --location=global --ignore-scripts yarn
+            curl https://sh.rustup.rs -sSf --output rustup.sh
+            sh rustup.sh -y --profile minimal --default-toolchain beta
+            export PATH="/usr/local/cargo/bin:$PATH"
+            echo "~~~~ rustc --version ~~~~"
+            rustc --version
+            echo "~~~~ node -v ~~~~"
+            node -v
+            echo "~~~~ yarn --version ~~~~"
+            yarn --version
+          run: |
+            export PATH="/usr/local/cargo/bin:$PATH"
+            pwd
+            ls -lah
+            whoami
+            env
+            freebsd-version
+            yarn install
+            yarn build
+            strip -x *.node
+            yarn test
+            rm -rf node_modules
+            rm -rf target
+            rm -rf .yarn/cache
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: bindings-freebsd
+          path: "*.node"
+          if-no-files-found: error
+
+  test-macOS-windows-binding:
+    name: Test bindings on \${{ matrix.settings.target }} - node@\${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - host: macos-latest
+            target: 'x86_64-apple-darwin'
+          - host: windows-latest
+            target: 'x86_64-pc-windows-msvc'
+        node: ['14', '16', '18']
+    runs-on: \${{ matrix.settings.host }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: \${{ matrix.node }}
+          check-latest: true
+          cache: 'yarn'
+
+      - name: 'Install dependencies'
+        run: yarn install
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-\${{ matrix.settings.target }}
+          path: .
+
+      - name: List packages
+        run: ls -R .
+        shell: bash
+
+      - name: Test bindings
+        run: yarn test
+
+  test-linux-x64-gnu-binding:
+    name: Test bindings on Linux-x64-gnu - node@\${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['14', '16', '18']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: \${{ matrix.node }}
+          check-latest: true
+          cache: 'yarn'
+
+      - name: 'Install dependencies'
+        run: yarn install
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-x86_64-unknown-linux-gnu
+          path: .
+
+      - name: List packages
+        run: ls -R .
+        shell: bash
+
+      - name: Test bindings
+        run: docker run --rm -v $(pwd):/build -w /build node:\${{ matrix.node }}-slim yarn test
+
+  test-linux-x64-musl-binding:
+    name: Test bindings on x86_64-unknown-linux-musl - node@\${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['14', '16', '18']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: \${{ matrix.node }}
+          check-latest: true
+          cache: 'yarn'
+
+      - name: 'Install dependencies'
+        run: |
+          yarn config set supportedArchitectures.libc "musl"
+          yarn install
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-x86_64-unknown-linux-musl
+          path: .
+
+      - name: List packages
+        run: ls -R .
+        shell: bash
+
+      - name: Test bindings
+        run: docker run --rm -v $(pwd):/build -w /build node:\${{ matrix.node }}-alpine yarn test
+
+  test-linux-aarch64-gnu-binding:
+    name: Test bindings on aarch64-unknown-linux-gnu - node@\${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['14', '16', '18']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-aarch64-unknown-linux-gnu
+          path: .
+
+      - name: List packages
+        run: ls -R .
+        shell: bash
+
+      - name: Install dependencies
+        run: |
+          yarn config set supportedArchitectures.cpu "arm64"
+          yarn config set supportedArchitectures.libc "glibc"
+          yarn install
+      
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: arm64
+      - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+
+      - name: Setup and run tests
+        uses: addnab/docker-run-action@v3
+        with:
+          image: node:\${{ matrix.node }}-slim
+          options: --platform linux/arm64 -v \${{ github.workspace }}:/build -w /build
+          run: |
+            set -e
+            yarn test
+            ls -la
+
+  test-linux-aarch64-musl-binding:
+    name: Test bindings on aarch64-unknown-linux-musl - node@\${{ matrix.node }}
+    needs:
+      - build
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-aarch64-unknown-linux-musl
+          path: .
+
+      - name: List packages
+        run: ls -R .
+        shell: bash
+
+      - name: Install dependencies
+        run: |
+          yarn config set supportedArchitectures.cpu "arm64"
+          yarn config set supportedArchitectures.libc "musl"
+          yarn install
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: arm64
+      - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+
+      - name: Setup and run tests
+        uses: addnab/docker-run-action@v3
+        with:
+          image: node:lts-alpine
+          options: --platform linux/arm64 -v \${{ github.workspace }}:/build -w /build
+          run: |
+            set -e
+            yarn test
+
+  test-linux-arm-gnueabihf-binding:
+    name: Test bindings on armv7-unknown-linux-gnueabihf - node@\${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['14', '16', '18']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-armv7-unknown-linux-gnueabihf
+          path: .
+
+      - name: List packages
+        run: ls -R .
+        shell: bash
+
+      - name: Install dependencies
+        run: |
+          yarn config set supportedArchitectures.cpu "arm"
+          yarn install
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: arm
+      - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+
+      - name: Setup and run tests
+        uses: addnab/docker-run-action@v3
+        with:
+          image: node:\${{ matrix.node }}-bullseye-slim
+          options: --platform linux/arm/v7 -v \${{ github.workspace }}:/build -w /build
+          run: |
+            set -e
+            yarn test
+            ls -la
+
+  universal-macOS:
+    name: Build universal macOS binary
+    needs:
+      - build
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          check-latest: true
+          cache: yarn
+
+      - name: 'Install dependencies'
+        run: yarn install
+
+      - name: Download macOS x64 artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-x86_64-apple-darwin
+          path: artifacts
+      - name: Download macOS arm64 artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: bindings-aarch64-apple-darwin
+          path: artifacts
+
+      - name: Combine binaries
+        run: yarn universal
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: bindings-universal-apple-darwin
+          path: "*.node"
+          if-no-files-found: error
+
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    needs:
+      - test-linux-x64-gnu-binding
+      - test-linux-x64-musl-binding
+      - test-linux-aarch64-gnu-binding
+      - test-linux-arm-gnueabihf-binding
+      - test-macOS-windows-binding
+      - test-linux-aarch64-musl-binding
+      - build-freebsd
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          check-latest: true
+          cache: 'yarn'
+
+      - name: 'Install dependencies'
+        run: yarn install
+
+      - name: Download all artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: artifacts
+
+      - name: Move artifacts
+        run: yarn artifacts
+
+      - name: List packages
+        run: ls -R ./npm
+        shell: bash
+
+      - name: Publish
+        run: |
+          if git log -1 --pretty=%B | grep "^[0-9]\\+\\.[0-9]\\+\\.[0-9]\\+$";
+          then
+            echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+            npm publish --access public
+          elif git log -1 --pretty=%B | grep "^[0-9]\\+\\.[0-9]\\+\\.[0-9]\\+";
+          then
+            echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+            npm publish --tag next --access public
+          else
+            echo "Not a release, skipping publish"
+          fi
+        env:
+          GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: \${{ secrets.NPM_TOKEN }}
+`;

package/dist/api/templates/ci.yml.d.ts

@@ -0,0 +1 @@
+export declare const createGithubActionsCIYml: (binaryName: string, targets: string[]) => string;

package/dist/api/templates/ci.yml.js

@@ -0,0 +1,92 @@
+import { load, dump } from 'js-yaml';
+import { NodeArchToCpu, UniArchsByPlatform, parseTriple, } from '../../utils/index.js';
+import { YAML } from './ci-template.js';
+const BUILD_FREEBSD = 'build-freebsd';
+const TEST_MACOS_WINDOWS = 'test-macOS-windows-binding';
+const TEST_LINUX_X64_GNU = 'test-linux-x64-gnu-binding';
+const TEST_LINUX_X64_MUSL = 'test-linux-x64-musl-binding';
+const TEST_LINUX_AARCH64_GNU = 'test-linux-aarch64-gnu-binding';
+const TEST_LINUX_AARCH64_MUSL = 'test-linux-aarch64-musl-binding';
+const TEST_LINUX_ARM_GNUEABIHF = 'test-linux-arm-gnueabihf-binding';
+const UNIVERSAL_MACOS = 'universal-macOS';
+export const createGithubActionsCIYml = (binaryName, targets) => {
+    const allTargets = new Set(targets.flatMap((t) => {
+        const platform = parseTriple(t);
+        if (platform.arch === 'universal') {
+            const srcTriples = UniArchsByPlatform[platform.platform]?.map((arch) => t.replace('universal', NodeArchToCpu[arch]));
+            return [t, ...(srcTriples ?? [])];
+        }
+        return [t];
+    }));
+    const fullTemplate = load(YAML());
+    const requiredSteps = [];
+    const enableWindowsX86 = allTargets.has('x86_64-pc-windows-msvc');
+    const enableMacOSX86 = allTargets.has('x86_64-apple-darwin');
+    const enableLinuxX86Gnu = allTargets.has('x86_64-unknown-linux-gnu');
+    const enableLinuxX86Musl = allTargets.has('x86_64-unknown-linux-musl');
+    const enableLinuxArm8Gnu = allTargets.has('aarch64-unknown-linux-gnu');
+    const enableLinuxArm8Musl = allTargets.has('aarch64-unknown-linux-musl');
+    const enableLinuxArm7 = allTargets.has('armv7-unknown-linux-gnueabihf');
+    const enableFreeBSD = allTargets.has('x86_64-unknown-freebsd');
+    const enableMacOSUni = allTargets.has('universal-apple-darwin');
+    fullTemplate.jobs.build.strategy.matrix.settings =
+        fullTemplate.jobs.build.strategy.matrix.settings.filter(({ target }) => allTargets.has(target));
+    if (!fullTemplate.jobs.build.strategy.matrix.settings.length) {
+        delete fullTemplate.jobs.build.strategy.matrix;
+    }
+    if (!enableFreeBSD) {
+        delete fullTemplate.jobs[BUILD_FREEBSD];
+    }
+    else {
+        requiredSteps.push(BUILD_FREEBSD);
+    }
+    if (!enableWindowsX86 && !enableMacOSX86) {
+        delete fullTemplate.jobs[TEST_MACOS_WINDOWS];
+    }
+    else {
+        const filterTarget = enableWindowsX86 ? 'macos-latest' : 'windows-latest';
+        fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings =
+            fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings.filter(({ host }) => host !== filterTarget);
+        requiredSteps.push(TEST_MACOS_WINDOWS);
+    }
+    if (!enableLinuxX86Gnu) {
+        delete fullTemplate.jobs[TEST_LINUX_X64_GNU];
+    }
+    else {
+        requiredSteps.push(TEST_LINUX_X64_GNU);
+    }
+    if (!enableLinuxX86Musl) {
+        delete fullTemplate.jobs[TEST_LINUX_X64_MUSL];
+    }
+    else {
+        requiredSteps.push(TEST_LINUX_X64_MUSL);
+    }
+    if (!enableLinuxArm8Gnu) {
+        delete fullTemplate.jobs[TEST_LINUX_AARCH64_GNU];
+    }
+    else {
+        requiredSteps.push(TEST_LINUX_AARCH64_GNU);
+    }
+    if (!enableLinuxArm8Musl) {
+        delete fullTemplate.jobs[TEST_LINUX_AARCH64_MUSL];
+    }
+    else {
+        requiredSteps.push(TEST_LINUX_AARCH64_MUSL);
+    }
+    if (!enableLinuxArm7) {
+        delete fullTemplate.jobs[TEST_LINUX_ARM_GNUEABIHF];
+    }
+    else {
+        requiredSteps.push(TEST_LINUX_ARM_GNUEABIHF);
+    }
+    if (!enableMacOSUni) {
+        delete fullTemplate.jobs[UNIVERSAL_MACOS];
+    }
+    else {
+        requiredSteps.push(UNIVERSAL_MACOS);
+    }
+    fullTemplate.jobs.publish.needs = requiredSteps;
+    return dump(fullTemplate, {
+        lineWidth: 1000,
+    });
+};

package/dist/api/templates/index.d.ts

@@ -0,0 +1,8 @@
+export * from './.gitignore.js';
+export * from './.npmignore.js';
+export * from './build.rs.js';
+export * from './cargo.toml.js';
+export * from './ci.yml.js';
+export * from './lib.rs.js';
+export * from './package.json.js';
+export * from './js-binding.js';

package/dist/api/templates/index.js

@@ -0,0 +1,8 @@
+export * from './.gitignore.js';
+export * from './.npmignore.js';
+export * from './build.rs.js';
+export * from './cargo.toml.js';
+export * from './ci.yml.js';
+export * from './lib.rs.js';
+export * from './package.json.js';
+export * from './js-binding.js';

package/dist/api/templates/js-binding.d.ts

@@ -0,0 +1 @@
+export declare function createJsBinding(localName: string, pkgName: string): string;