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

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

@@ -0,0 +1,65 @@
+/**
+ * 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 `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;
+    /**
+     * Dry run without touching file system
+     *
+     * @default false
+     */
+    dryRun?: boolean;
+}
+export declare function applyDefaultPrePublishOptions(options: PrePublishOptions): {
+    cwd: string;
+    packageJsonPath: string;
+    npmDir: string;
+    tagStyle: string;
+    ghRelease: boolean;
+    /**
+     * GitHub release name
+     */
+    ghReleaseName?: string | undefined;
+    /**
+     * Existing GitHub release id
+     */
+    ghReleaseId?: string | undefined;
+    dryRun: boolean;
+};

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

@@ -0,0 +1,13 @@
+// This file is generated by codegen/index.ts
+// Do not edit this file manually
+export function applyDefaultPrePublishOptions(options) {
+    return {
+        cwd: process.cwd(),
+        packageJsonPath: 'package.json',
+        npmDir: 'npm',
+        tagStyle: 'lerna',
+        ghRelease: true,
+        dryRun: false,
+        ...options,
+    };
+}

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

@@ -0,0 +1,75 @@
+/**
+ * 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 `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;
+    packageJsonPath: string;
+    npmDir: string;
+    /**
+     * The new name of the project
+     */
+    name?: string | undefined;
+    /**
+     * The new binary name *.node files
+     */
+    binaryName?: string | undefined;
+    /**
+     * The new package name of the project
+     */
+    packageName?: string | undefined;
+    manifestPath: string;
+    /**
+     * The new repository of the project
+     */
+    repository?: string | undefined;
+    /**
+     * The new description of the project
+     */
+    description?: string | undefined;
+};

package/dist/def/options/rename.js

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

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

@@ -0,0 +1,28 @@
+/**
+ * Combile built binaries into one universal binary
+ */
+export interface UniversalizeOptions {
+    /**
+     * 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;
+}
+export declare function applyDefaultUniversalizeOptions(options: UniversalizeOptions): {
+    cwd: string;
+    packageJsonPath: string;
+    outputDir: string;
+};

package/dist/def/options/universalize.js

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

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

@@ -0,0 +1,28 @@
+/**
+ * Update version in created npm packages
+ */
+export interface VersionOptions {
+    /**
+     * 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 the npm packages put
+     *
+     * @default 'npm'
+     */
+    npmDir?: string;
+}
+export declare function applyDefaultVersionOptions(options: VersionOptions): {
+    cwd: string;
+    packageJsonPath: string;
+    npmDir: string;
+};

package/dist/def/options/version.js

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

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

@@ -0,0 +1,88 @@
+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;
+    };
+}
+/**
+ * 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 `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;
+    /**
+     * Dry run without touching file system
+     *
+     * @default false
+     */
+    dryRun?: boolean;
+}
+export declare function applyDefaultPrePublishOptions(options: PrePublishOptions): {
+    cwd: string;
+    packageJsonPath: string;
+    npmDir: string;
+    tagStyle: string;
+    ghRelease: boolean;
+    /**
+     * GitHub release name
+     */
+    ghReleaseName?: string | undefined;
+    /**
+     * Existing GitHub release id
+     */
+    ghReleaseId?: string | undefined;
+    dryRun: boolean;
+};

package/dist/def/pre-publish.js

@@ -0,0 +1,56 @@
+// 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,
+        };
+    }
+}
+export function applyDefaultPrePublishOptions(options) {
+    return {
+        cwd: process.cwd(),
+        packageJsonPath: 'package.json',
+        npmDir: 'npm',
+        tagStyle: 'lerna',
+        ghRelease: true,
+        dryRun: false,
+        ...options,
+    };
+}

package/dist/def/rename.d.ts

@@ -0,0 +1,100 @@
+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;
+    };
+}
+/**
+ * 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 `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;
+    packageJsonPath: string;
+    npmDir: string;
+    /**
+     * The new name of the project
+     */
+    name?: string | undefined;
+    /**
+     * The new binary name *.node files
+     */
+    binaryName?: string | undefined;
+    /**
+     * The new package name of the project
+     */
+    packageName?: string | undefined;
+    manifestPath: string;
+    /**
+     * The new repository of the project
+     */
+    repository?: string | undefined;
+    /**
+     * The new description of the project
+     */
+    description?: string | undefined;
+};

package/dist/def/rename.js

@@ -0,0 +1,58 @@
+// 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,
+        };
+    }
+}
+export function applyDefaultRenameOptions(options) {
+    return {
+        cwd: process.cwd(),
+        packageJsonPath: 'package.json',
+        npmDir: 'npm',
+        manifestPath: 'Cargo.toml',
+        ...options,
+    };
+}

package/dist/def/universalize.d.ts

@@ -0,0 +1,41 @@
+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;
+    };
+}
+/**
+ * Combile built binaries into one universal binary
+ */
+export interface UniversalizeOptions {
+    /**
+     * 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;
+}
+export declare function applyDefaultUniversalizeOptions(options: UniversalizeOptions): {
+    cwd: string;
+    packageJsonPath: string;
+    outputDir: string;
+};

package/dist/def/universalize.js

@@ -0,0 +1,33 @@
+// 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,
+        };
+    }
+}
+export function applyDefaultUniversalizeOptions(options) {
+    return {
+        cwd: process.cwd(),
+        packageJsonPath: 'package.json',
+        outputDir: './',
+        ...options,
+    };
+}

package/dist/def/version.d.ts

@@ -0,0 +1,41 @@
+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;
+    };
+}
+/**
+ * Update version in created npm packages
+ */
+export interface VersionOptions {
+    /**
+     * 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 the npm packages put
+     *
+     * @default 'npm'
+     */
+    npmDir?: string;
+}
+export declare function applyDefaultVersionOptions(options: VersionOptions): {
+    cwd: string;
+    packageJsonPath: string;
+    npmDir: string;
+};