Skip to content

Commit

Permalink
feat(vite-node): make CLI arguments parsing behavior consistent with …
Browse files Browse the repository at this point in the history
…node/tsx/ts-node (#3574)
  • Loading branch information
rxliuli authored Jul 28, 2023
1 parent 3c85187 commit 1cd4eb0
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 4 deletions.
29 changes: 25 additions & 4 deletions packages/vite-node/src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,31 @@ import { installSourcemapsSupport } from './source-map'
const cli = cac('vite-node')

cli
.version(version)
.option('-r, --root <path>', 'Use specified root directory')
.option('-c, --config <path>', 'Use specified config file')
.option('-m, --mode <mode>', 'Set env mode')
.option('-w, --watch', 'Restart on file changes, similar to "nodemon"')
.option('--script', 'Use vite-node as a script runner')
.option('--options <options>', 'Use specified Vite server options')
.help()
.option('-v, --version', 'Output the version number')
.option('-h, --help', 'Display help for command')

cli
.command('[...files]')
.allowUnknownOptions()
.action(run)

cli.parse()
cli.parse(process.argv, { run: false })

if (cli.args.length === 0) {
cli.runMatchedCommand()
}
else {
const i = cli.rawArgs.indexOf(cli.args[0]) + 1
const scriptArgs = cli.rawArgs.slice(i).filter(it => it !== '--')
const executeArgs = [...cli.rawArgs.slice(0, i), '--', ...scriptArgs]
cli.parse(executeArgs)
}

export interface CliOptions {
root?: string
Expand All @@ -35,6 +45,8 @@ export interface CliOptions {
mode?: string
watch?: boolean
options?: ViteNodeServerOptionsCLI
version?: boolean
help?: boolean
'--'?: string[]
}

Expand All @@ -48,9 +60,18 @@ async function run(files: string[], options: CliOptions = {}) {
process.argv = [...process.argv.slice(0, 2), ...(options['--'] || [])]
}

if (options.version) {
cli.version(version)
cli.outputVersion()
process.exit(0)
}
if (options.help) {
cli.version(version).outputHelp()
process.exit(0)
}
if (!files.length) {
console.error(c.red('No files specified.'))
cli.outputHelp()
cli.version(version).outputHelp()
process.exit(1)
}

Expand Down
2 changes: 2 additions & 0 deletions test/vite-node/src/cli-parse-args.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// eslint-disable-next-line no-console
console.log(process.argv)
38 changes: 38 additions & 0 deletions test/vite-node/test/cli.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { execa } from 'execa'
import { resolve } from 'pathe'
import { expect, it } from 'vitest'

const cliPath = resolve(__dirname, '../../../packages/vite-node/src/cli.ts')
const entryPath = resolve(__dirname, '../src/cli-parse-args.js')

const parseResult = (s: string) => JSON.parse(s.replaceAll('\'', '"'))

it('basic', async () => {
const result = await execa('npx', ['esno', cliPath, entryPath], { reject: true })
expect(result.stdout).include('node')
expect(parseResult(result.stdout)).length(2)
}, 60_000)

it('--help', async () => {
const r1 = await execa('npx', ['esno', cliPath, '--help', entryPath], { reject: true })
expect(r1.stdout).include('help')
const r2 = await execa('npx', ['esno', cliPath, '-h', entryPath], { reject: true })
expect(r2.stdout).include('help')
}, 60_000)

it('--version', async () => {
const r1 = await execa('npx', ['esno', cliPath, '--version', entryPath], { reject: true })
expect(r1.stdout).include('vite-node/')
const r2 = await execa('npx', ['esno', cliPath, '-v', entryPath], { reject: true })
expect(r2.stdout).include('vite-node/')
}, 60_000)

it('script args', async () => {
const r1 = await execa('npx', ['esno', cliPath, entryPath, '--version', '--help'], { reject: true })
expect(parseResult(r1.stdout)).include('--version').include('--help')
}, 60_000)

it('script args in -- after', async () => {
const r1 = await execa('npx', ['esno', cliPath, entryPath, '--', '--version', '--help'], { reject: true })
expect(parseResult(r1.stdout)).include('--version').include('--help')
}, 60_000)

0 comments on commit 1cd4eb0

Please sign in to comment.