fix: update command defaults and descriptions (#677)

Author: BobbieGoede

src/commands/_shared.ts

@@ -0,0 +1,20 @@
+import type { ArgDef } from 'citty'
+import { resolve } from 'pathe'
+
+export const sharedArgs = {
+  // cwd falls back to rootDir's default (indirect default)
+  cwd: {
+    type: 'string',
+    valueHint: 'directory',
+    description: 'Specify the working directory, this takes precedence over ROOTDIR (default: `.`)',
+    default: undefined,
+  },
+  rootDir: {
+    type: 'positional',
+    description: 'Specifies the working directory (default: `.`)',
+    required: false,
+    default: '.',
+  },
+} as const satisfies Record<string, ArgDef>
+
+export const resolveCwdArg = (args: { cwd?: string, rootDir?: string }) => resolve(args.cwd || args.rootDir || '.')

src/commands/build.ts

@@ -16,51 +16,49 @@ import { defineCommand } from 'citty'
 import { convertCompilerOptionsFromJson } from 'typescript'
 
 import { name, version } from '../../package.json'
+import { resolveCwdArg, sharedArgs } from './_shared'
 
 export default defineCommand({
   meta: {
     name: 'build',
     description: 'Build module for distribution',
   },
   args: {
-    cwd: {
-      type: 'string',
-      description: 'Current working directory',
-    },
-    rootDir: {
-      type: 'positional',
-      description: 'Root directory',
-      required: false,
-    },
+    ...sharedArgs,
     outDir: {
       type: 'string',
+      default: 'dist',
+      description: 'Build directory',
     },
     sourcemap: {
       type: 'boolean',
+      default: false,
+      description: 'Generate sourcemaps',
     },
     stub: {
       type: 'boolean',
+      default: false,
+      description: 'Stub dist instead of actually building it for development',
     },
   },
   async run(context) {
     const { build } = await import('unbuild')
 
-    const cwd = resolve(context.args.cwd || context.args.rootDir || '.')
+    const cwd = resolveCwdArg(context.args)
 
     const jiti = createJiti(cwd)
-    const outDir = context.args.outDir || 'dist'
 
     await build(cwd, false, {
       declaration: 'node16',
       sourcemap: context.args.sourcemap,
       stub: context.args.stub,
       stubOptions: { absoluteJitiPath: true },
-      outDir,
+      outDir: context.args.outDir,
       entries: [
         'src/module',
         {
           input: 'src/runtime/',
-          outDir: `${outDir}/runtime`,
+          outDir: `${context.args.outDir}/runtime`,
           addRelativeDeclarationExtensions: true,
           ext: 'js',
           pattern: [

src/commands/prepare.ts

@@ -1,27 +1,20 @@
 import type { NuxtConfig } from '@nuxt/schema'
 import { defineCommand } from 'citty'
 import { resolve } from 'pathe'
+import { resolveCwdArg, sharedArgs } from './_shared'
 
 export default defineCommand({
   meta: {
     name: 'prepare',
     description: 'Prepare @nuxt/module-builder environment by writing types and stubs',
   },
   args: {
-    cwd: {
-      type: 'string',
-      description: 'Current working directory',
-    },
-    rootDir: {
-      type: 'positional',
-      description: 'Root directory',
-      required: false,
-    },
+    ...sharedArgs,
   },
   async run(context) {
     const { runCommand } = await import('@nuxt/cli')
 
-    const cwd = resolve(context.args.cwd || context.args.rootDir || '.')
+    const cwd = resolveCwdArg(context.args)
 
     return runCommand('prepare', [cwd], {
       overrides: {