@napi-rs/cli 3.0.0-alpha.22 → 3.0.0-alpha.24

package/src/commands/new.ts

@@ -1,4 +1,4 @@
-import path from 'path'
+import path from 'node:path'
 
 import { Option } from 'clipanion'
 import inquirer from 'inquirer'
@@ -16,7 +16,7 @@ import { napiEngineRequirement } from '../utils/version.js'
 const debug = debugFactory('new')
 
 export class NewCommand extends BaseNewCommand {
-  interactive = Option.Boolean('--interactive,-i', false, {
+  interactive = Option.Boolean('--interactive,-i', true, {
     description:
       'Ask project basic information interactively without just using the default.',
   })
@@ -37,9 +37,19 @@ export class NewCommand extends BaseNewCommand {
     const cmdOptions = super.getOptions()
 
     if (this.interactive) {
+      const targetPath: string = cmdOptions.path
+        ? cmdOptions.path
+        : await inquirer
+            .prompt({
+              type: 'input',
+              name: 'path',
+              message: 'Target path to create the project, relative to cwd',
+            })
+            .then(({ path }) => path)
+      cmdOptions.path = targetPath
       return {
         ...cmdOptions,
-        name: await this.fetchName(path.parse(cmdOptions.path).base),
+        name: await this.fetchName(path.parse(targetPath).base),
         minNodeApiVersion: await this.fetchNapiVersion(),
         targets: await this.fetchTargets(),
         license: await this.fetchLicense(),

package/src/def/new.ts

@@ -10,7 +10,7 @@ export abstract class BaseNewCommand extends Command {
     description: 'Create a new project with pre-configured boilerplate',
   })
 
-  $$path = Option.String({ required: true })
+  $$path = Option.String({ required: false })
 
   $$name?: string = Option.String('--name,-n', {
     description:
@@ -22,6 +22,10 @@ export abstract class BaseNewCommand extends Command {
     description: 'The minimum Node-API version to support',
   })
 
+  packageManager = Option.String('--package-manager', 'yarn', {
+    description: 'The package manager to use. Only support yarn 4.x for now.',
+  })
+
   license = Option.String('--license,-l', 'MIT', {
     description: 'License for open-sourced project',
   })
@@ -47,6 +51,11 @@ export abstract class BaseNewCommand extends Command {
     description: 'Whether generate preconfigured GitHub Actions workflow',
   })
 
+  testFramework = Option.String('--test-framework', 'ava', {
+    description:
+      'The JavaScript test framework to use, only support `ava` for now',
+  })
+
   dryRun = Option.Boolean('--dry-run', false, {
     description: 'Whether to run the command in dry-run mode',
   })
@@ -56,12 +65,14 @@ export abstract class BaseNewCommand extends Command {
       path: this.$$path,
       name: this.$$name,
       minNodeApiVersion: this.minNodeApiVersion,
+      packageManager: this.packageManager,
       license: this.license,
       targets: this.targets,
       enableDefaultTargets: this.enableDefaultTargets,
       enableAllTargets: this.enableAllTargets,
       enableTypeDef: this.enableTypeDef,
       enableGithubActions: this.enableGithubActions,
+      testFramework: this.testFramework,
       dryRun: this.dryRun,
     }
   }
@@ -74,7 +85,7 @@ export interface NewOptions {
   /**
    * 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
    */
@@ -85,6 +96,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
    *
@@ -121,6 +138,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
    *
@@ -132,12 +155,14 @@ export interface NewOptions {
 export function applyDefaultNewOptions(options: NewOptions) {
   return {
     minNodeApiVersion: 4,
+    packageManager: 'yarn',
     license: 'MIT',
     targets: [],
     enableDefaultTargets: true,
     enableAllTargets: false,
     enableTypeDef: true,
     enableGithubActions: true,
+    testFramework: 'ava',
     dryRun: false,
     ...options,
   }

package/src/utils/__tests__/__snapshots__/target.spec.ts.md

@@ -114,4 +114,11 @@ Generated by [AVA](https://avajs.dev).
         platformArchABI: 'linux-riscv64-gnu',
         triple: 'riscv64gc-unknown-linux-gnu',
       },
+      {
+        abi: 'wasi',
+        arch: 'wasm32',
+        platform: 'wasi',
+        platformArchABI: 'wasm32-wasi',
+        triple: 'wasm32-wasi-preview1-threads',
+      },
     ]

package/src/utils/cargo.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 import { debug } from './log.js'
 

package/src/utils/config.ts

@@ -4,6 +4,18 @@ import { merge, omit } from 'lodash-es'
 import { fileExists, readFileAsync } from './misc.js'
 import { DEFAULT_TARGETS, parseTriple, Target } from './target.js'
 
+export type ValueOfConstArray<T> = T[Exclude<keyof T, keyof Array<any>>]
+
+export const SupportedPackageManagers = ['yarn'] as const
+export const SupportedTestFrameworks = ['ava'] as const
+
+export type SupportedPackageManager = ValueOfConstArray<
+  typeof SupportedPackageManagers
+>
+export type SupportedTestFramework = ValueOfConstArray<
+  typeof SupportedTestFrameworks
+>
+
 export interface UserNapiConfig {
   /**
    * Name of the binary to be generated, default to `index`
@@ -81,6 +93,10 @@ export interface CommonPackageJsonFields {
 
   dependencies?: Record<string, string>
   devDependencies?: Record<string, string>
+
+  ava?: {
+    timeout?: string
+  }
 }
 
 export type NapiConfig = Required<
@@ -150,14 +166,18 @@ export async function readNapiConfig(
   // compatible with old config
   if (userNapiConfig?.name) {
     console.warn(
-      `[DEPRECATED] napi.name is deprecated, use napi.binaryName instead.`,
+      yellow(
+        `[DEPRECATED] napi.name is deprecated, use napi.binaryName instead.`,
+      ),
     )
     napiConfig.binaryName = userNapiConfig.name
   }
 
   if (!targets.length) {
     let deprecatedWarned = false
-    const warning = `[DEPRECATED] napi.triples is deprecated, use napi.targets instead.`
+    const warning = yellow(
+      `[DEPRECATED] napi.triples is deprecated, use napi.targets instead.`,
+    )
     if (userNapiConfig.triples?.defaults) {
       deprecatedWarned = true
       console.warn(warning)

package/src/utils/metadata.ts

@@ -1,5 +1,5 @@
-import { execSync } from 'child_process'
-import fs from 'fs'
+import { execSync } from 'node:child_process'
+import fs from 'node:fs'
 
 export type CrateTargetKind =
   | 'bin'

package/src/utils/misc.ts

@@ -1,6 +1,14 @@
-import { readFile, writeFile, copyFile, mkdir, unlink, stat, readdir } from 'fs'
-import { createRequire } from 'module'
-import { promisify } from 'util'
+import {
+  readFile,
+  writeFile,
+  copyFile,
+  mkdir,
+  unlink,
+  stat,
+  readdir,
+} from 'node:fs'
+import { createRequire } from 'node:module'
+import { promisify } from 'node:util'
 
 import { debug } from './log.js'
 

package/src/utils/target.ts

@@ -2,6 +2,10 @@ import { execSync } from 'node:child_process'
 
 export type Platform = NodeJS.Platform | 'wasm' | 'wasi'
 
+export const UNIVERSAL_TARGETS = {
+  'universal-apple-darwin': ['aarch64-apple-darwin', 'x86_64-apple-darwin'],
+} as const
+
 export const AVAILABLE_TARGETS = [
   'aarch64-apple-darwin',
   'aarch64-linux-android',
@@ -18,12 +22,14 @@ export const AVAILABLE_TARGETS = [
   'armv7-linux-androideabi',
   'universal-apple-darwin',
   'riscv64gc-unknown-linux-gnu',
+  'wasm32-wasi-preview1-threads',
 ] as const
 
 export type TargetTriple = (typeof AVAILABLE_TARGETS)[number]
 
 export const DEFAULT_TARGETS = [
   'x86_64-apple-darwin',
+  'aarch64-apple-darwin',
   'x86_64-pc-windows-msvc',
   'x86_64-unknown-linux-gnu',
 ] as const
@@ -48,6 +54,7 @@ type NodeJSArch =
   | 'x32'
   | 'x64'
   | 'universal'
+  | 'wasm32'
 
 const CpuToNodeArch: Record<string, NodeJSArch> = {
   x86_64: 'x64',
@@ -80,7 +87,7 @@ export interface Target {
   triple: string
   platformArchABI: string
   platform: Platform
-  arch: NodeJSArch | 'wasm32'
+  arch: NodeJSArch
   abi: string | null
 }
 
@@ -98,7 +105,7 @@ export function parseTriple(rawTriple: string): Target {
   if (rawTriple === 'wasm32-wasi-preview1-threads') {
     return {
       triple: rawTriple,
-      platformArchABI: rawTriple,
+      platformArchABI: 'wasm32-wasi',
       platform: 'wasi',
       arch: 'wasm32',
       abi: 'wasi',

package/dist/api/load-wasi-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"load-wasi-template.js","sourceRoot":"","sources":["../../src/api/load-wasi-template.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,YAAoB,EACpB,qBAA+B,EAC/B,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2KA6BsK,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;EAyBrL,qBAAqB;KACpB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,6BAA6B,IAAI,QAAQ,CAAC;KACxD,IAAI,CAAC,IAAI,CAAC;;CAEZ,CAAA"}

package/dist/api/wasi-worker-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wasi-worker-template.js","sourceRoot":"","sources":["../../src/api/wasi-worker-template.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,oBAAoB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmDnC,CAAA"}