如何使用typescript中的yargs解析命令行参数

时间:2017-07-13 10:09:20

标签: node.js typescript

这是我尝试的(代码改编自yargs github自述文件中的示例代码):

// main.ts

import {Argv} from "yargs";


console.info(`CLI starter.`);

function serve(port: string) {
    console.info(`Serve on port ${port}.`);
}

require('yargs')
    .command('serve', "Start the server.", (yargs: Argv) => {
        yargs.option('port', {
            describe: "Port to bind on",
            default: "5000",
        }).option('verbose', {
            alias: 'v',
            default: false,
        })
    }, (args: any) => {
        if (args.verbose) {
            console.info("Starting the server...");
        }
        serve(args.port);
    }).argv;

结果:

npm run-script build; node build/main.js --port=432 --verbose

> typescript-cli-starter@0.0.1 build /Users/kaiyin/WebstormProjects/typescript-cli-starter
> tsc -p .

CLI starter.

看起来yargs在这里没有效果。

知道如何让它发挥作用吗?

2 个答案:

答案 0 :(得分:4)

我在yargs github自述文件中修改了示例中的代码,结果证明它并不是一个完整的例子。 _(ツ)_ /¯

无论如何,我想出了怎么做:

#!/usr/bin/env node

import * as yargs from 'yargs'
import {Argv} from "yargs";

let argv =  yargs
    .command('serve', "Start the server.", (yargs: Argv) => {
        return yargs.option('port', {
            describe: "Port to bind on",
            default: "5000",
        }).option('verbose', {
            alias: 'v',
            default: false,
        })
    }).argv;

if (argv.verbose) {
    console.info("Verbose mode on.");
}

serve(argv.port);

function serve(port: string) {
    console.info(`Serve on port ${port}.`);
}

您可以在此处找到完整的typescript-cli-starter个回复:https://github.com/kindlychung/typescript-cli-starter

答案 1 :(得分:1)

一个简单的例子

import * as yargs from 'yargs'

    let args = yargs
        .option('input', {
            alias: 'i',
            demand: true
        })
        .option('year', {
            alias: 'y',
            description: "Year number",
            demand: true
        }).argv;

    console.log(JSON.stringify(args));