@napi-rs/cli 3.0.0-alpha.9 → 3.0.0-alpha.91

package/dist/def/artifacts.d.ts

@@ -3,14 +3,18 @@ export declare abstract class BaseArtifactsCommand extends Command {
     static paths: string[][];
     static usage: import("clipanion").Usage;
     cwd: string;
+    configPath?: string;
     packageJsonPath: string;
     outputDir: string;
     npmDir: string;
+    buildOutputDir?: string;
     getOptions(): {
         cwd: string;
+        configPath: string | undefined;
         packageJsonPath: string;
         outputDir: string;
         npmDir: string;
+        buildOutputDir: string | undefined;
     };
 }
 /**
@@ -23,6 +27,10 @@ export interface ArtifactsOptions {
      * @default process.cwd()
      */
     cwd?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      *
@@ -32,7 +40,7 @@ export interface ArtifactsOptions {
     /**
      * Path to the folder where all built `.node` files put, same as `--output-dir` of build command
      *
-     * @default './'
+     * @default './artifacts'
      */
     outputDir?: string;
     /**
@@ -41,10 +49,22 @@ export interface ArtifactsOptions {
      * @default 'npm'
      */
     npmDir?: string;
+    /**
+     * Path to the build output dir, only needed when targets contains `wasm32-wasi-*`
+     */
+    buildOutputDir?: string;
 }
 export declare function applyDefaultArtifactsOptions(options: ArtifactsOptions): {
     cwd: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     packageJsonPath: string;
     outputDir: string;
     npmDir: string;
+    /**
+     * Path to the build output dir, only needed when targets contains `wasm32-wasi-*`
+     */
+    buildOutputDir?: string;
 };

package/dist/def/build.d.ts

@@ -5,6 +5,7 @@ export declare abstract class BaseBuildCommand extends Command {
     target?: string;
     cwd?: string;
     manifestPath?: string;
+    configPath?: string;
     packageJsonPath?: string;
     targetDir?: string;
     outputDir?: string;
@@ -16,6 +17,8 @@ export declare abstract class BaseBuildCommand extends Command {
     dts?: string;
     dtsHeader?: string;
     noDtsHeader?: boolean;
+    dtsCache: boolean;
+    esm?: boolean;
     strip?: boolean;
     release?: boolean;
     verbose?: boolean;
@@ -24,6 +27,7 @@ export declare abstract class BaseBuildCommand extends Command {
     profile?: string;
     crossCompile?: boolean;
     useCross?: boolean;
+    useNapiCross?: boolean;
     watch?: boolean;
     features?: string[];
     allFeatures?: boolean;
@@ -32,6 +36,7 @@ export declare abstract class BaseBuildCommand extends Command {
         target: string | undefined;
         cwd: string | undefined;
         manifestPath: string | undefined;
+        configPath: string | undefined;
         packageJsonPath: string | undefined;
         targetDir: string | undefined;
         outputDir: string | undefined;
@@ -43,6 +48,8 @@ export declare abstract class BaseBuildCommand extends Command {
         dts: string | undefined;
         dtsHeader: string | undefined;
         noDtsHeader: boolean | undefined;
+        dtsCache: boolean;
+        esm: boolean | undefined;
         strip: boolean | undefined;
         release: boolean | undefined;
         verbose: boolean | undefined;
@@ -51,6 +58,7 @@ export declare abstract class BaseBuildCommand extends Command {
         profile: string | undefined;
         crossCompile: boolean | undefined;
         useCross: boolean | undefined;
+        useNapiCross: boolean | undefined;
         watch: boolean | undefined;
         features: string[] | undefined;
         allFeatures: boolean | undefined;
@@ -58,7 +66,7 @@ export declare abstract class BaseBuildCommand extends Command {
     };
 }
 /**
- * Build the napi-rs project
+ * Build the NAPI-RS project
  */
 export interface BuildOptions {
     /**
@@ -73,6 +81,10 @@ export interface BuildOptions {
      * Path to `Cargo.toml`
      */
     manifestPath?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      */
@@ -98,7 +110,7 @@ export interface BuildOptions {
      */
     constEnum?: boolean;
     /**
-     * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output_dir`.
+     * Path and filename of generated JS binding file. Only works with `--platform` flag. Relative to `--output-dir`.
      */
     jsBinding?: string;
     /**
@@ -106,7 +118,7 @@ export interface BuildOptions {
      */
     noJsBinding?: boolean;
     /**
-     * Path and filename of generated type def file. Relative to `--output_dir`
+     * Path and filename of generated type def file. Relative to `--output-dir`
      */
     dts?: string;
     /**
@@ -117,6 +129,16 @@ export interface BuildOptions {
      * 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
      */
@@ -150,7 +172,11 @@ export interface BuildOptions {
      */
     useCross?: boolean;
     /**
-     * watch the crate changes and build continiously with `cargo-watch` crates
+     * [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;
     /**
@@ -166,3 +192,122 @@ export interface BuildOptions {
      */
     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

@@ -3,11 +3,13 @@ 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;
@@ -23,6 +25,10 @@ export interface CreateNpmDirsOptions {
      * @default process.cwd()
      */
     cwd?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      *
@@ -44,6 +50,10 @@ export interface CreateNpmDirsOptions {
 }
 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

@@ -2,26 +2,30 @@ import { Command } from 'clipanion';
 export declare abstract class BaseNewCommand extends Command {
     static paths: string[][];
     static usage: import("clipanion").Usage;
-    $$path: string;
+    $$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;
+        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;
     };
 }
@@ -30,9 +34,9 @@ export declare abstract class BaseNewCommand extends Command {
  */
 export interface NewOptions {
     /**
-     * The path where the napi-rs project will be created.
+     * The path where the NAPI-RS project will be created.
      */
-    path: string;
+    path?: string;
     /**
      * The name of the project, default to the name of the directory if not provided
      */
@@ -43,6 +47,12 @@ export interface NewOptions {
      * @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
      *
@@ -79,6 +89,12 @@ export interface NewOptions {
      * @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
      *
@@ -88,19 +104,21 @@ export interface NewOptions {
 }
 export declare function applyDefaultNewOptions(options: NewOptions): {
     /**
-     * The path where the napi-rs project will be created.
+     * The path where the NAPI-RS project will be created.
      */
-    path: string;
+    path?: string;
     /**
      * The name of the project, default to the name of the directory if not provided
      */
-    name?: string | undefined;
+    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

@@ -3,6 +3,7 @@ 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;
@@ -12,6 +13,7 @@ export declare abstract class BasePrePublishCommand extends Command {
     dryRun: boolean;
     getOptions(): {
         cwd: string;
+        configPath: string | undefined;
         packageJsonPath: string;
         npmDir: string;
         tagStyle: string;
@@ -31,6 +33,10 @@ export interface PrePublishOptions {
      * @default process.cwd()
      */
     cwd?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      *
@@ -72,6 +78,10 @@ export interface PrePublishOptions {
 }
 export declare function applyDefaultPrePublishOptions(options: PrePublishOptions): {
     cwd: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     packageJsonPath: string;
     npmDir: string;
     tagStyle: string;
@@ -79,10 +89,10 @@ export declare function applyDefaultPrePublishOptions(options: PrePublishOptions
     /**
      * GitHub release name
      */
-    ghReleaseName?: string | undefined;
+    ghReleaseName?: string;
     /**
      * Existing GitHub release id
      */
-    ghReleaseId?: string | undefined;
+    ghReleaseId?: string;
     dryRun: boolean;
 };

package/dist/def/rename.d.ts

@@ -3,6 +3,7 @@ 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;
@@ -13,6 +14,7 @@ export declare abstract class BaseRenameCommand extends Command {
     description?: string;
     getOptions(): {
         cwd: string;
+        configPath: string | undefined;
         packageJsonPath: string;
         npmDir: string;
         name: string | undefined;
@@ -24,7 +26,7 @@ export declare abstract class BaseRenameCommand extends Command {
     };
 }
 /**
- * Rename the napi-rs project
+ * Rename the NAPI-RS project
  */
 export interface RenameOptions {
     /**
@@ -33,6 +35,10 @@ export interface RenameOptions {
      * @default process.cwd()
      */
     cwd?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      *
@@ -74,27 +80,31 @@ export interface RenameOptions {
 }
 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 | undefined;
+    name?: string;
     /**
      * The new binary name *.node files
      */
-    binaryName?: string | undefined;
+    binaryName?: string;
     /**
      * The new package name of the project
      */
-    packageName?: string | undefined;
+    packageName?: string;
     manifestPath: string;
     /**
      * The new repository of the project
      */
-    repository?: string | undefined;
+    repository?: string;
     /**
      * The new description of the project
      */
-    description?: string | undefined;
+    description?: string;
 };

package/dist/def/universalize.d.ts

@@ -3,10 +3,12 @@ export declare abstract class BaseUniversalizeCommand extends Command {
     static paths: string[][];
     static usage: import("clipanion").Usage;
     cwd: string;
+    configPath?: string;
     packageJsonPath: string;
     outputDir: string;
     getOptions(): {
         cwd: string;
+        configPath: string | undefined;
         packageJsonPath: string;
         outputDir: string;
     };
@@ -21,6 +23,10 @@ export interface UniversalizeOptions {
      * @default process.cwd()
      */
     cwd?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      *
@@ -36,6 +42,10 @@ export interface UniversalizeOptions {
 }
 export declare function applyDefaultUniversalizeOptions(options: UniversalizeOptions): {
     cwd: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     packageJsonPath: string;
     outputDir: string;
 };

package/dist/def/version.d.ts

@@ -3,10 +3,12 @@ export declare abstract class BaseVersionCommand extends Command {
     static paths: string[][];
     static usage: import("clipanion").Usage;
     cwd: string;
+    configPath?: string;
     packageJsonPath: string;
     npmDir: string;
     getOptions(): {
         cwd: string;
+        configPath: string | undefined;
         packageJsonPath: string;
         npmDir: string;
     };
@@ -21,6 +23,10 @@ export interface VersionOptions {
      * @default process.cwd()
      */
     cwd?: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     /**
      * Path to `package.json`
      *
@@ -36,6 +42,10 @@ export interface VersionOptions {
 }
 export declare function applyDefaultVersionOptions(options: VersionOptions): {
     cwd: string;
+    /**
+     * Path to `napi` config json file
+     */
+    configPath?: string;
     packageJsonPath: string;
     npmDir: string;
 };