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

package/src/def/build.ts

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

@@ -0,0 +1,79 @@
+// This file is generated by codegen/index.ts
+// Do not edit this file manually
+import { Command, Option } from 'clipanion'
+
+export abstract 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,
+    }
+  }
+}
+
+/**
+ * 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 `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 function applyDefaultCreateNpmDirsOptions(
+  options: CreateNpmDirsOptions,
+) {
+  return {
+    cwd: process.cwd(),
+    packageJsonPath: 'package.json',
+    npmDir: 'npm',
+    dryRun: false,
+    ...options,
+  }
+}

package/src/def/new.ts

@@ -0,0 +1,144 @@
+// 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 abstract 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?: string = 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,
+    }
+  }
+}
+
+/**
+ * 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
+  /**
+   * 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
+  /**
+   * Whether to run the command in dry-run mode
+   *
+   * @default false
+   */
+  dryRun?: boolean
+}
+
+export function applyDefaultNewOptions(options: NewOptions) {
+  return {
+    minNodeApiVersion: 4,
+    license: 'MIT',
+    targets: [],
+    enableDefaultTargets: true,
+    enableAllTargets: false,
+    enableTypeDef: true,
+    enableGithubActions: true,
+    dryRun: false,
+    ...options,
+  }
+}

package/src/def/pre-publish.ts

@@ -0,0 +1,120 @@
+// This file is generated by codegen/index.ts
+// Do not edit this file manually
+import { Command, Option } from 'clipanion'
+
+export abstract 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?: string = Option.String('--gh-release-name', {
+    description: 'GitHub release name',
+  })
+
+  ghReleaseId?: string = 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,
+    }
+  }
+}
+
+/**
+ * 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 function applyDefaultPrePublishOptions(options: PrePublishOptions) {
+  return {
+    cwd: process.cwd(),
+    packageJsonPath: 'package.json',
+    npmDir: 'npm',
+    tagStyle: 'lerna',
+    ghRelease: true,
+    dryRun: false,
+    ...options,
+  }
+}

package/src/def/rename.ts

@@ -0,0 +1,122 @@
+// This file is generated by codegen/index.ts
+// Do not edit this file manually
+import { Command, Option } from 'clipanion'
+
+export abstract 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?: string = Option.String('--name,-n', {
+    description: 'The new name of the project',
+  })
+
+  binaryName?: string = Option.String('--binary-name,-b', {
+    description: 'The new binary name *.node files',
+  })
+
+  packageName?: string = 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?: string = Option.String('--repository', {
+    description: 'The new repository of the project',
+  })
+
+  description?: string = 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,
+    }
+  }
+}
+
+/**
+ * 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 function applyDefaultRenameOptions(options: RenameOptions) {
+  return {
+    cwd: process.cwd(),
+    packageJsonPath: 'package.json',
+    npmDir: 'npm',
+    manifestPath: 'Cargo.toml',
+    ...options,
+  }
+}