@napi-rs/cli 3.1.1 → 3.1.3

package/dist/def/build.d.ts

@@ -1,313 +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;
-    configPath?: string;
-    packageJsonPath?: string;
-    targetDir?: string;
-    outputDir?: string;
-    platform?: boolean;
-    jsPackageName?: string;
-    constEnum?: boolean;
-    jsBinding?: string;
-    noJsBinding?: boolean;
-    dts?: string;
-    dtsHeader?: string;
-    noDtsHeader?: boolean;
-    dtsCache: boolean;
-    esm?: boolean;
-    strip?: boolean;
-    release?: boolean;
-    verbose?: boolean;
-    bin?: string;
-    package?: string;
-    profile?: string;
-    crossCompile?: boolean;
-    useCross?: boolean;
-    useNapiCross?: boolean;
-    watch?: boolean;
-    features?: string[];
-    allFeatures?: boolean;
-    noDefaultFeatures?: boolean;
-    getOptions(): {
-        target: string | undefined;
-        cwd: string | undefined;
-        manifestPath: string | undefined;
-        configPath: string | undefined;
-        packageJsonPath: string | undefined;
-        targetDir: string | undefined;
-        outputDir: string | undefined;
-        platform: boolean | undefined;
-        jsPackageName: string | undefined;
-        constEnum: boolean | undefined;
-        jsBinding: string | undefined;
-        noJsBinding: boolean | undefined;
-        dts: string | undefined;
-        dtsHeader: string | undefined;
-        noDtsHeader: boolean | undefined;
-        dtsCache: boolean;
-        esm: boolean | undefined;
-        strip: boolean | undefined;
-        release: boolean | undefined;
-        verbose: boolean | undefined;
-        bin: string | undefined;
-        package: string | undefined;
-        profile: string | undefined;
-        crossCompile: boolean | undefined;
-        useCross: boolean | undefined;
-        useNapiCross: boolean | undefined;
-        watch: boolean | undefined;
-        features: string[] | undefined;
-        allFeatures: boolean | undefined;
-        noDefaultFeatures: boolean | undefined;
-    };
-}
-/**
- * Build the NAPI-RS project
- */
-export interface BuildOptions {
-    /**
-     * Build for the target triple, bypassed to `cargo build --target`
-     */
-    target?: string;
-    /**
-     * The working directory of where napi command will be executed in, all other paths options are relative to this path
-     */
-    cwd?: string;
-    /**
-     * Path to `Cargo.toml`
-     */
-    manifestPath?: string;
-    /**
-     * Path to `napi` config json file
-     */
-    configPath?: string;
-    /**
-     * Path to `package.json`
-     */
-    packageJsonPath?: string;
-    /**
-     * Directory for all crate generated artifacts, see `cargo build --target-dir`
-     */
-    targetDir?: string;
-    /**
-     * Path to where all the built files would be put. Default to the crate folder
-     */
-    outputDir?: string;
-    /**
-     * Add platform triple to the generated nodejs binding file, eg: `[name].linux-x64-gnu.node`
-     */
-    platform?: boolean;
-    /**
-     * Package name in generated js binding file. Only works with `--platform` flag
-     */
-    jsPackageName?: string;
-    /**
-     * Whether generate const enum for typescript bindings
-     */
-    constEnum?: boolean;
-    /**
-     * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.
-     */
-    jsBinding?: string;
-    /**
-     * Whether to disable the generation JS binding file. Only works with `--platform` flag.
-     */
-    noJsBinding?: boolean;
-    /**
-     * Path and filename of generated type def file. Relative to `--output-dir`
-     */
-    dts?: string;
-    /**
-     * Custom file header for generated type def file. Only works when `typedef` feature enabled.
-     */
-    dtsHeader?: string;
-    /**
-     * Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.
-     */
-    noDtsHeader?: boolean;
-    /**
-     * Whether to enable the dts cache, default to true
-     *
-     * @default true
-     */
-    dtsCache?: boolean;
-    /**
-     * Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.
-     */
-    esm?: boolean;
-    /**
-     * Whether strip the library to achieve the minimum file size
-     */
-    strip?: boolean;
-    /**
-     * Build in release mode
-     */
-    release?: boolean;
-    /**
-     * Verbosely log build command trace
-     */
-    verbose?: boolean;
-    /**
-     * Build only the specified binary
-     */
-    bin?: string;
-    /**
-     * Build the specified library or the one at cwd
-     */
-    package?: string;
-    /**
-     * Build artifacts with the specified profile
-     */
-    profile?: string;
-    /**
-     * [experimental] cross-compile for the specified target with `cargo-xwin` on windows and `cargo-zigbuild` on other platform
-     */
-    crossCompile?: boolean;
-    /**
-     * [experimental] use [cross](https://github.com/cross-rs/cross) instead of `cargo`
-     */
-    useCross?: boolean;
-    /**
-     * [experimental] use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets.
-     */
-    useNapiCross?: boolean;
-    /**
-     * watch the crate changes and build continuously with `cargo-watch` crates
-     */
-    watch?: boolean;
-    /**
-     * Space-separated list of features to activate
-     */
-    features?: string[];
-    /**
-     * Activate all available features
-     */
-    allFeatures?: boolean;
-    /**
-     * Do not activate the `default` feature
-     */
-    noDefaultFeatures?: boolean;
-}
-export declare function applyDefaultBuildOptions(options: BuildOptions): {
-    /**
-     * Build for the target triple, bypassed to `cargo build --target`
-     */
-    target?: string;
-    /**
-     * The working directory of where napi command will be executed in, all other paths options are relative to this path
-     */
-    cwd?: string;
-    /**
-     * Path to `Cargo.toml`
-     */
-    manifestPath?: string;
-    /**
-     * Path to `napi` config json file
-     */
-    configPath?: string;
-    /**
-     * Path to `package.json`
-     */
-    packageJsonPath?: string;
-    /**
-     * Directory for all crate generated artifacts, see `cargo build --target-dir`
-     */
-    targetDir?: string;
-    /**
-     * Path to where all the built files would be put. Default to the crate folder
-     */
-    outputDir?: string;
-    /**
-     * Add platform triple to the generated nodejs binding file, eg: `[name].linux-x64-gnu.node`
-     */
-    platform?: boolean;
-    /**
-     * Package name in generated js binding file. Only works with `--platform` flag
-     */
-    jsPackageName?: string;
-    /**
-     * Whether generate const enum for typescript bindings
-     */
-    constEnum?: boolean;
-    /**
-     * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.
-     */
-    jsBinding?: string;
-    /**
-     * Whether to disable the generation JS binding file. Only works with `--platform` flag.
-     */
-    noJsBinding?: boolean;
-    /**
-     * Path and filename of generated type def file. Relative to `--output-dir`
-     */
-    dts?: string;
-    /**
-     * Custom file header for generated type def file. Only works when `typedef` feature enabled.
-     */
-    dtsHeader?: string;
-    /**
-     * Whether to disable the default file header for generated type def file. Only works when `typedef` feature enabled.
-     */
-    noDtsHeader?: boolean;
-    dtsCache: boolean;
-    /**
-     * Whether to emit an ESM JS binding file instead of CJS format. Only works with `--platform` flag.
-     */
-    esm?: boolean;
-    /**
-     * Whether strip the library to achieve the minimum file size
-     */
-    strip?: boolean;
-    /**
-     * Build in release mode
-     */
-    release?: boolean;
-    /**
-     * Verbosely log build command trace
-     */
-    verbose?: boolean;
-    /**
-     * Build only the specified binary
-     */
-    bin?: string;
-    /**
-     * Build the specified library or the one at cwd
-     */
-    package?: string;
-    /**
-     * Build artifacts with the specified profile
-     */
-    profile?: string;
-    /**
-     * [experimental] cross-compile for the specified target with `cargo-xwin` on windows and `cargo-zigbuild` on other platform
-     */
-    crossCompile?: boolean;
-    /**
-     * [experimental] use [cross](https://github.com/cross-rs/cross) instead of `cargo`
-     */
-    useCross?: boolean;
-    /**
-     * [experimental] use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets.
-     */
-    useNapiCross?: boolean;
-    /**
-     * watch the crate changes and build continuously with `cargo-watch` crates
-     */
-    watch?: boolean;
-    /**
-     * Space-separated list of features to activate
-     */
-    features?: string[];
-    /**
-     * Activate all available features
-     */
-    allFeatures?: boolean;
-    /**
-     * Do not activate the `default` feature
-     */
-    noDefaultFeatures?: boolean;
-};

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

@@ -1,60 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseCreateNpmDirsCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    configPath?: string;
-    packageJsonPath: string;
-    npmDir: string;
-    dryRun: boolean;
-    getOptions(): {
-        cwd: string;
-        configPath: string | undefined;
-        packageJsonPath: string;
-        npmDir: string;
-        dryRun: boolean;
-    };
-}
-/**
- * Create npm package dirs for different platforms
- */
-export interface CreateNpmDirsOptions {
-    /**
-     * 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 `napi` config json file
-     */
-    configPath?: string;
-    /**
-     * Path to `package.json`
-     *
-     * @default 'package.json'
-     */
-    packageJsonPath?: string;
-    /**
-     * Path to the folder where the npm packages put
-     *
-     * @default 'npm'
-     */
-    npmDir?: string;
-    /**
-     * Dry run without touching file system
-     *
-     * @default false
-     */
-    dryRun?: boolean;
-}
-export declare function applyDefaultCreateNpmDirsOptions(options: CreateNpmDirsOptions): {
-    cwd: string;
-    /**
-     * Path to `napi` config json file
-     */
-    configPath?: string;
-    packageJsonPath: string;
-    npmDir: string;
-    dryRun: boolean;
-};

package/dist/def/new.d.ts

@@ -1,124 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseNewCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    $$path: string | undefined;
-    $$name?: string;
-    minNodeApiVersion: number;
-    packageManager: string;
-    license: string;
-    targets: string[];
-    enableDefaultTargets: boolean;
-    enableAllTargets: boolean;
-    enableTypeDef: boolean;
-    enableGithubActions: boolean;
-    testFramework: string;
-    dryRun: boolean;
-    getOptions(): {
-        path: string | undefined;
-        name: string | undefined;
-        minNodeApiVersion: number;
-        packageManager: string;
-        license: string;
-        targets: string[];
-        enableDefaultTargets: boolean;
-        enableAllTargets: boolean;
-        enableTypeDef: boolean;
-        enableGithubActions: boolean;
-        testFramework: string;
-        dryRun: boolean;
-    };
-}
-/**
- * Create a new project with pre-configured boilerplate
- */
-export interface NewOptions {
-    /**
-     * The path where the NAPI-RS project will be created.
-     */
-    path?: string;
-    /**
-     * The name of the project, default to the name of the directory if not provided
-     */
-    name?: string;
-    /**
-     * The minimum Node-API version to support
-     *
-     * @default 4
-     */
-    minNodeApiVersion?: number;
-    /**
-     * The package manager to use. Only support yarn 4.x for now.
-     *
-     * @default 'yarn'
-     */
-    packageManager?: string;
-    /**
-     * License for open-sourced project
-     *
-     * @default 'MIT'
-     */
-    license?: string;
-    /**
-     * All targets the crate will be compiled for.
-     *
-     * @default []
-     */
-    targets?: string[];
-    /**
-     * Whether enable default targets
-     *
-     * @default true
-     */
-    enableDefaultTargets?: boolean;
-    /**
-     * Whether enable all targets
-     *
-     * @default false
-     */
-    enableAllTargets?: boolean;
-    /**
-     * Whether enable the `type-def` feature for typescript definitions auto-generation
-     *
-     * @default true
-     */
-    enableTypeDef?: boolean;
-    /**
-     * Whether generate preconfigured GitHub Actions workflow
-     *
-     * @default true
-     */
-    enableGithubActions?: boolean;
-    /**
-     * The JavaScript test framework to use, only support `ava` for now
-     *
-     * @default 'ava'
-     */
-    testFramework?: string;
-    /**
-     * Whether to run the command in dry-run mode
-     *
-     * @default false
-     */
-    dryRun?: boolean;
-}
-export declare function applyDefaultNewOptions(options: NewOptions): {
-    /**
-     * The path where the NAPI-RS project will be created.
-     */
-    path?: string;
-    /**
-     * The name of the project, default to the name of the directory if not provided
-     */
-    name?: string;
-    minNodeApiVersion: number;
-    packageManager: string;
-    license: string;
-    targets: string[];
-    enableDefaultTargets: boolean;
-    enableAllTargets: boolean;
-    enableTypeDef: boolean;
-    enableGithubActions: boolean;
-    testFramework: string;
-    dryRun: boolean;
-};

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

@@ -1,107 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BasePrePublishCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    configPath?: string;
-    packageJsonPath: string;
-    npmDir: string;
-    tagStyle: string;
-    ghRelease: boolean;
-    ghReleaseName?: string;
-    ghReleaseId?: string;
-    skipOptionalPublish: boolean;
-    dryRun: boolean;
-    getOptions(): {
-        cwd: string;
-        configPath: string | undefined;
-        packageJsonPath: string;
-        npmDir: string;
-        tagStyle: string;
-        ghRelease: boolean;
-        ghReleaseName: string | undefined;
-        ghReleaseId: string | undefined;
-        skipOptionalPublish: boolean;
-        dryRun: boolean;
-    };
-}
-/**
- * Update package.json and copy addons into per platform packages
- */
-export interface PrePublishOptions {
-    /**
-     * 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 `napi` config json file
-     */
-    configPath?: string;
-    /**
-     * Path to `package.json`
-     *
-     * @default 'package.json'
-     */
-    packageJsonPath?: string;
-    /**
-     * Path to the folder where the npm packages put
-     *
-     * @default 'npm'
-     */
-    npmDir?: string;
-    /**
-     * git tag style, `npm` or `lerna`
-     *
-     * @default 'lerna'
-     */
-    tagStyle?: 'npm' | 'lerna';
-    /**
-     * Whether create GitHub release
-     *
-     * @default true
-     */
-    ghRelease?: boolean;
-    /**
-     * GitHub release name
-     */
-    ghReleaseName?: string;
-    /**
-     * Existing GitHub release id
-     */
-    ghReleaseId?: string;
-    /**
-     * Whether skip optionalDependencies packages publish
-     *
-     * @default false
-     */
-    skipOptionalPublish?: boolean;
-    /**
-     * Dry run without touching file system
-     *
-     * @default false
-     */
-    dryRun?: boolean;
-}
-export declare function applyDefaultPrePublishOptions(options: PrePublishOptions): {
-    cwd: string;
-    /**
-     * Path to `napi` config json file
-     */
-    configPath?: string;
-    packageJsonPath: string;
-    npmDir: string;
-    tagStyle: string;
-    ghRelease: boolean;
-    /**
-     * GitHub release name
-     */
-    ghReleaseName?: string;
-    /**
-     * Existing GitHub release id
-     */
-    ghReleaseId?: string;
-    skipOptionalPublish: boolean;
-    dryRun: boolean;
-};

package/dist/def/rename.d.ts

@@ -1,110 +0,0 @@
-import { Command } from 'clipanion';
-export declare abstract class BaseRenameCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    cwd: string;
-    configPath?: string;
-    packageJsonPath: string;
-    npmDir: string;
-    $$name?: string;
-    binaryName?: string;
-    packageName?: string;
-    manifestPath: string;
-    repository?: string;
-    description?: string;
-    getOptions(): {
-        cwd: string;
-        configPath: string | undefined;
-        packageJsonPath: string;
-        npmDir: string;
-        name: string | undefined;
-        binaryName: string | undefined;
-        packageName: string | undefined;
-        manifestPath: string;
-        repository: string | undefined;
-        description: string | undefined;
-    };
-}
-/**
- * Rename the NAPI-RS project
- */
-export interface RenameOptions {
-    /**
-     * 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 `napi` config json file
-     */
-    configPath?: string;
-    /**
-     * Path to `package.json`
-     *
-     * @default 'package.json'
-     */
-    packageJsonPath?: string;
-    /**
-     * Path to the folder where the npm packages put
-     *
-     * @default 'npm'
-     */
-    npmDir?: string;
-    /**
-     * The new name of the project
-     */
-    name?: string;
-    /**
-     * The new binary name *.node files
-     */
-    binaryName?: string;
-    /**
-     * The new package name of the project
-     */
-    packageName?: string;
-    /**
-     * Path to `Cargo.toml`
-     *
-     * @default 'Cargo.toml'
-     */
-    manifestPath?: string;
-    /**
-     * The new repository of the project
-     */
-    repository?: string;
-    /**
-     * The new description of the project
-     */
-    description?: string;
-}
-export declare function applyDefaultRenameOptions(options: RenameOptions): {
-    cwd: string;
-    /**
-     * Path to `napi` config json file
-     */
-    configPath?: string;
-    packageJsonPath: string;
-    npmDir: string;
-    /**
-     * The new name of the project
-     */
-    name?: string;
-    /**
-     * The new binary name *.node files
-     */
-    binaryName?: string;
-    /**
-     * The new package name of the project
-     */
-    packageName?: string;
-    manifestPath: string;
-    /**
-     * The new repository of the project
-     */
-    repository?: string;
-    /**
-     * The new description of the project
-     */
-    description?: string;
-};