@napi-rs/cli 3.0.0-alpha.3 → 3.0.0-alpha.5

package/src/utils/version.ts

@@ -68,7 +68,7 @@ function toEngineRequirement(versions: NodeVersion[]): string {
     requirements.push(req)
   })
 
-  return requirements.join(' && ')
+  return requirements.join(' ')
 }
 
 export function napiEngineRequirement(napiVersion: NapiVersion): string {

package/dist/def/commands/artifacts.d.ts

@@ -1,15 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseArtifactsCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    outputDir: string;
-    npmDir: string;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        outputDir: string;
-        npmDir: string;
-    };
-}

package/dist/def/commands/artifacts.js

@@ -1,29 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseArtifactsCommand extends Command {
-    static paths = [['artifacts']];
-    static usage = Command.Usage({
-        description: 'Copy artifacts from Github Actions into npm packages and ready to publish',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    outputDir = Option.String('--output-dir,-o', './', {
-        description: 'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
-    });
-    npmDir = Option.String('--npm-dir', 'npm', {
-        description: 'Path to the folder where the npm packages put',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            outputDir: this.outputDir,
-            npmDir: this.npmDir,
-        };
-    }
-}

package/dist/def/commands/build.d.ts

@@ -1,53 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseBuildCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    target?: string;
-    cwd?: string;
-    manifestPath?: string;
-    packageJsonPath?: string;
-    targetDir?: string;
-    outputDir?: string;
-    platform?: boolean;
-    jsPackageName?: string;
-    jsBinding?: string;
-    noJsBinding?: boolean;
-    dts?: string;
-    dtsHeader?: string;
-    noDtsHeader?: boolean;
-    strip?: boolean;
-    release?: boolean;
-    verbose?: boolean;
-    bin?: string;
-    package?: string;
-    crossCompile?: boolean;
-    watch?: boolean;
-    features?: string[];
-    allFeatures?: boolean;
-    noDefaultFeatures?: boolean;
-    getOptions(): {
-        target: string | undefined;
-        cwd: string | undefined;
-        manifestPath: string | undefined;
-        packageJsonPath: string | undefined;
-        targetDir: string | undefined;
-        outputDir: string | undefined;
-        platform: boolean | undefined;
-        jsPackageName: string | undefined;
-        jsBinding: string | undefined;
-        noJsBinding: boolean | undefined;
-        dts: string | undefined;
-        dtsHeader: string | undefined;
-        noDtsHeader: boolean | undefined;
-        strip: boolean | undefined;
-        release: boolean | undefined;
-        verbose: boolean | undefined;
-        bin: string | undefined;
-        package: string | undefined;
-        crossCompile: boolean | undefined;
-        watch: boolean | undefined;
-        features: string[] | undefined;
-        allFeatures: boolean | undefined;
-        noDefaultFeatures: boolean | undefined;
-    };
-}

package/dist/def/commands/build.js

@@ -1,105 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseBuildCommand extends Command {
-    static paths = [['build']];
-    static usage = Command.Usage({
-        description: 'Build the napi-rs project',
-    });
-    target = Option.String('--target,-t', {
-        description: 'Build for the target triple, bypassed to `cargo build --target`',
-    });
-    cwd = Option.String('--cwd', {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    manifestPath = Option.String('--manifest-path', {
-        description: 'Path to `Cargo.toml`',
-    });
-    packageJsonPath = Option.String('--package-json-path', {
-        description: 'Path to `package.json`',
-    });
-    targetDir = Option.String('--target-dir', {
-        description: 'Directory for all crate generated artifacts, see `cargo build --target-dir`',
-    });
-    outputDir = Option.String('--output-dir,-o', {
-        description: 'Path to where all the built files would be put. Default to the crate folder',
-    });
-    platform = Option.Boolean('--platform', {
-        description: 'Add platform triple to the generated nodejs binding file, eg: `[name].linux-x64-gnu.node`',
-    });
-    jsPackageName = Option.String('--js-package-name', {
-        description: 'Package name in generated js binding file. Only works with `--platform` flag',
-    });
-    jsBinding = Option.String('--js', {
-        description: 'Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.',
-    });
-    noJsBinding = Option.Boolean('--no-js', {
-        description: 'Whether to disable the generation JS binding file. Only works with `--platform` flag.',
-    });
-    dts = Option.String('--dts', {
-        description: 'Path and filename of generated type def file. Relative to `--output_dir`',
-    });
-    dtsHeader = Option.String('--dts-header', {
-        description: 'Custom file header for generated type def file. Only works when `typedef` feature enabled.',
-    });
-    noDtsHeader = Option.Boolean('--no-dts-header', {
-        description: 'Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.',
-    });
-    strip = Option.Boolean('--strip,-s', {
-        description: 'Whether strip the library to achieve the minimum file size',
-    });
-    release = Option.Boolean('--release,-r', {
-        description: 'Build in release mode',
-    });
-    verbose = Option.Boolean('--verbose,-v', {
-        description: 'Verbosely log build command trace',
-    });
-    bin = Option.String('--bin', {
-        description: 'Build only the specified binary',
-    });
-    package = Option.String('--package,-p', {
-        description: 'Build the specified library or the one at cwd',
-    });
-    crossCompile = Option.Boolean('--cross-compile', {
-        description: '[experimental] cross-compile for the specified target with `cargo-xwin` on windows and `cargo-zigbuild` on other platform',
-    });
-    watch = Option.Boolean('--watch,-w', {
-        description: 'watch the crate changes and build continiously with `cargo-watch` crates',
-    });
-    features = Option.Array('--features,-F', {
-        description: 'Space-separated list of features to activate',
-    });
-    allFeatures = Option.Boolean('--all-features', {
-        description: 'Activate all available features',
-    });
-    noDefaultFeatures = Option.Boolean('--no-default-features', {
-        description: 'Do not activate the `default` feature',
-    });
-    getOptions() {
-        return {
-            target: this.target,
-            cwd: this.cwd,
-            manifestPath: this.manifestPath,
-            packageJsonPath: this.packageJsonPath,
-            targetDir: this.targetDir,
-            outputDir: this.outputDir,
-            platform: this.platform,
-            jsPackageName: this.jsPackageName,
-            jsBinding: this.jsBinding,
-            noJsBinding: this.noJsBinding,
-            dts: this.dts,
-            dtsHeader: this.dtsHeader,
-            noDtsHeader: this.noDtsHeader,
-            strip: this.strip,
-            release: this.release,
-            verbose: this.verbose,
-            bin: this.bin,
-            package: this.package,
-            crossCompile: this.crossCompile,
-            watch: this.watch,
-            features: this.features,
-            allFeatures: this.allFeatures,
-            noDefaultFeatures: this.noDefaultFeatures,
-        };
-    }
-}

package/dist/def/commands/create-npm-dirs.d.ts

@@ -1,15 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseCreateNpmDirsCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    npmDir: string;
-    dryRun: boolean;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        npmDir: string;
-        dryRun: boolean;
-    };
-}

package/dist/def/commands/create-npm-dirs.js

@@ -1,29 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseCreateNpmDirsCommand extends Command {
-    static paths = [['create-npm-dirs']];
-    static usage = Command.Usage({
-        description: 'Create npm package dirs for different platforms',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    npmDir = Option.String('--npm-dir', 'npm', {
-        description: 'Path to the folder where the npm packages put',
-    });
-    dryRun = Option.Boolean('--dry-run', false, {
-        description: 'Dry run without touching file system',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            npmDir: this.npmDir,
-            dryRun: this.dryRun,
-        };
-    }
-}

package/dist/def/commands/new.d.ts

@@ -1,27 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseNewCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    $$path: string;
-    $$name?: string;
-    minNodeApiVersion: number;
-    license: string;
-    targets: string[];
-    enableDefaultTargets: boolean;
-    enableAllTargets: boolean;
-    enableTypeDef: boolean;
-    enableGithubActions: boolean;
-    dryRun: boolean;
-    getOptions(): {
-        path: string;
-        name: string | undefined;
-        minNodeApiVersion: number;
-        license: string;
-        targets: string[];
-        enableDefaultTargets: boolean;
-        enableAllTargets: boolean;
-        enableTypeDef: boolean;
-        enableGithubActions: boolean;
-        dryRun: boolean;
-    };
-}

package/dist/def/commands/new.js

@@ -1,53 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-import * as typanion from 'typanion';
-export class BaseNewCommand extends Command {
-    static paths = [['new']];
-    static usage = Command.Usage({
-        description: 'Create a new project with pre-configured boilerplate',
-    });
-    $$path = Option.String({ required: true });
-    $$name = Option.String('--name,-n', {
-        description: 'The name of the project, default to the name of the directory if not provided',
-    });
-    minNodeApiVersion = Option.String('--min-node-api,-v', '4', {
-        validator: typanion.isNumber(),
-        description: 'The minimum Node-API version to support',
-    });
-    license = Option.String('--license,-l', 'MIT', {
-        description: 'License for open-sourced project',
-    });
-    targets = Option.Array('--targets,-t', [], {
-        description: 'All targets the crate will be compiled for.',
-    });
-    enableDefaultTargets = Option.Boolean('--enable-default-targets', true, {
-        description: 'Whether enable default targets',
-    });
-    enableAllTargets = Option.Boolean('--enable-all-targets', false, {
-        description: 'Whether enable all targets',
-    });
-    enableTypeDef = Option.Boolean('--enable-type-def', true, {
-        description: 'Whether enable the `type-def` feature for typescript definitions auto-generation',
-    });
-    enableGithubActions = Option.Boolean('--enable-github-actions', true, {
-        description: 'Whether generate preconfigured GitHub Actions workflow',
-    });
-    dryRun = Option.Boolean('--dry-run', false, {
-        description: 'Whether to run the command in dry-run mode',
-    });
-    getOptions() {
-        return {
-            path: this.$$path,
-            name: this.$$name,
-            minNodeApiVersion: this.minNodeApiVersion,
-            license: this.license,
-            targets: this.targets,
-            enableDefaultTargets: this.enableDefaultTargets,
-            enableAllTargets: this.enableAllTargets,
-            enableTypeDef: this.enableTypeDef,
-            enableGithubActions: this.enableGithubActions,
-            dryRun: this.dryRun,
-        };
-    }
-}

package/dist/def/commands/pre-publish.d.ts

@@ -1,23 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BasePrePublishCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    npmDir: string;
-    tagStyle: string;
-    ghRelease: boolean;
-    ghReleaseName?: string;
-    ghReleaseId?: string;
-    dryRun: boolean;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        npmDir: string;
-        tagStyle: string;
-        ghRelease: boolean;
-        ghReleaseName: string | undefined;
-        ghReleaseId: string | undefined;
-        dryRun: boolean;
-    };
-}

package/dist/def/commands/pre-publish.js

@@ -1,45 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BasePrePublishCommand extends Command {
-    static paths = [['pre-publish']];
-    static usage = Command.Usage({
-        description: 'Update package.json and copy addons into per platform packages',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    npmDir = Option.String('--npm-dir', 'npm', {
-        description: 'Path to the folder where the npm packages put',
-    });
-    tagStyle = Option.String('--tag-style', 'lerna', {
-        description: 'git tag style, `npm` or `lerna`',
-    });
-    ghRelease = Option.Boolean('--gh-release', true, {
-        description: 'Whether create GitHub release',
-    });
-    ghReleaseName = Option.String('--gh-release-name', {
-        description: 'GitHub release name',
-    });
-    ghReleaseId = Option.String('--gh-release-id', {
-        description: 'Existing GitHub release id',
-    });
-    dryRun = Option.Boolean('--dry-run', false, {
-        description: 'Dry run without touching file system',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            npmDir: this.npmDir,
-            tagStyle: this.tagStyle,
-            ghRelease: this.ghRelease,
-            ghReleaseName: this.ghReleaseName,
-            ghReleaseId: this.ghReleaseId,
-            dryRun: this.dryRun,
-        };
-    }
-}

package/dist/def/commands/rename.d.ts

@@ -1,25 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseRenameCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    npmDir: string;
-    $$name?: string;
-    binaryName?: string;
-    packageName?: string;
-    manifestPath: string;
-    repository?: string;
-    description?: string;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        npmDir: string;
-        name: string | undefined;
-        binaryName: string | undefined;
-        packageName: string | undefined;
-        manifestPath: string;
-        repository: string | undefined;
-        description: string | undefined;
-    };
-}

package/dist/def/commands/rename.js

@@ -1,49 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseRenameCommand extends Command {
-    static paths = [['rename']];
-    static usage = Command.Usage({
-        description: 'Rename the napi-rs project',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    npmDir = Option.String('--npm-dir', 'npm', {
-        description: 'Path to the folder where the npm packages put',
-    });
-    $$name = Option.String('--name,-n', {
-        description: 'The new name of the project',
-    });
-    binaryName = Option.String('--binary-name,-b', {
-        description: 'The new binary name *.node files',
-    });
-    packageName = Option.String('--package-name', {
-        description: 'The new package name of the project',
-    });
-    manifestPath = Option.String('--manifest-path', 'Cargo.toml', {
-        description: 'Path to `Cargo.toml`',
-    });
-    repository = Option.String('--repository', {
-        description: 'The new repository of the project',
-    });
-    description = Option.String('--description', {
-        description: 'The new description of the project',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            npmDir: this.npmDir,
-            name: this.$$name,
-            binaryName: this.binaryName,
-            packageName: this.packageName,
-            manifestPath: this.manifestPath,
-            repository: this.repository,
-            description: this.description,
-        };
-    }
-}

package/dist/def/commands/universalize.d.ts

@@ -1,13 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseUniversalizeCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    outputDir: string;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        outputDir: string;
-    };
-}

package/dist/def/commands/universalize.js

@@ -1,25 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseUniversalizeCommand extends Command {
-    static paths = [['universalize']];
-    static usage = Command.Usage({
-        description: 'Combile built binaries into one universal binary',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    outputDir = Option.String('--output-dir,-o', './', {
-        description: 'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            outputDir: this.outputDir,
-        };
-    }
-}

package/dist/def/commands/version.d.ts

@@ -1,13 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseVersionCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    packageJsonPath: string;
-    npmDir: string;
-    getOptions(): {
-        cwd: string;
-        packageJsonPath: string;
-        npmDir: string;
-    };
-}

package/dist/def/commands/version.js

@@ -1,25 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-import { Command, Option } from 'clipanion';
-export class BaseVersionCommand extends Command {
-    static paths = [['version']];
-    static usage = Command.Usage({
-        description: 'Update version in created npm packages',
-    });
-    cwd = Option.String('--cwd', process.cwd(), {
-        description: 'The working directory of where napi command will be executed in, all other paths options are relative to this path',
-    });
-    packageJsonPath = Option.String('--package-json-path', 'package.json', {
-        description: 'Path to `package.json`',
-    });
-    npmDir = Option.String('--npm-dir', 'npm', {
-        description: 'Path to the folder where the npm packages put',
-    });
-    getOptions() {
-        return {
-            cwd: this.cwd,
-            packageJsonPath: this.packageJsonPath,
-            npmDir: this.npmDir,
-        };
-    }
-}

package/dist/def/options/artifacts.d.ts

@@ -1,35 +0,0 @@
-/**
- * Copy artifacts from Github Actions into npm packages and ready to publish
- */
-export interface ArtifactsOptions {
-    /**
-     * The working directory of where napi command will be executed in, all other paths options are relative to this path
-     *
-     * @default process.cwd()
-     */
-    cwd?: string;
-    /**
-     * Path to `package.json`
-     *
-     * @default 'package.json'
-     */
-    packageJsonPath?: string;
-    /**
-     * Path to the folder where all built `.node` files put, same as `--output-dir` of build command
-     *
-     * @default './'
-     */
-    outputDir?: string;
-    /**
-     * Path to the folder where the npm packages put
-     *
-     * @default 'npm'
-     */
-    npmDir?: string;
-}
-export declare function applyDefaultArtifactsOptions(options: ArtifactsOptions): {
-    cwd: string;
-    packageJsonPath: string;
-    outputDir: string;
-    npmDir: string;
-};

package/dist/def/options/artifacts.js

@@ -1,11 +0,0 @@
-// This file is generated by codegen/index.ts
-// Do not edit this file manually
-export function applyDefaultArtifactsOptions(options) {
-    return {
-        cwd: process.cwd(),
-        packageJsonPath: 'package.json',
-        outputDir: './',
-        npmDir: 'npm',
-        ...options,
-    };
-}