在打字稿中使用指挥官

Question

>我尝试在打字稿中使用指挥官，我想为我的cli提供一个合适的类型。所以我从这段代码开始：

import * as program from "commander";
const cli = program
.version("1.0.0")
.usage("[options]")
.option("-d, --debug", "activate more debug messages. Can be set by env var DEBUG.", false)
.parse(process.argv);
console.log(cli.debug)

但是我收到此错误：

example.ts(9,17): error TS2339: Property 'debug' does not exist on type 'Command'.

所以我尝试添加一个接口，如下所述：

import * as program from "commander";
interface InterfaceCLI extends commander.Command {
debug?: boolean;
}
const cli: InterfaceCLI = program
.version("1.0.0")
.usage("[options]")
.option("-d, --debug", "activate more debug messages. Can be set by env var DEBUG.", false)
.parse(process.argv);
console.log(cli.debug)

我收到此错误：

example.ts(3,32): error TS2503: Cannot find namespace 'commander'.

据我了解，cli实际上是一个commander.Command类型的类 所以我尝试添加一个类：

import * as program from "commander";
class Cli extends program.Command {
public debug: boolean;
}
const cli: Cli = program
.version("1.0.0")
.usage("[options]")
.option("-d, --debug", "activate more debug messages. Can be set by env var DEBUG.", false)
.parse(process.argv);
console.log(cli.debug)

这给了我这个错误：

example.ts(7,7): error TS2322: Type 'Command' is not assignable to type 'Cli'.
Property 'debug' is missing in type 'Command'.

我不知道如何在我的文件或新的 .d.ts 文件中向Command类添加属性。

Answer 1

使用您的第一个代码片段和以下依赖项，我没有收到错误：

"dependencies": {
"commander": "^2.11.0"
},
"devDependencies": {
"@types/commander": "^2.9.1",
"typescript": "^2.4.1"
}

打字稿将cli.debug解释为any。我想类型声明已更新。所以，如果你对any很好，问题就解决了。

如果你真的想告诉Typescriptdebug的类型，声明合并原则上是要走的路。它基本上是这样工作的：

class C {
public foo: number;
}
interface C {
bar: number;
}
const c = new C();
const fooBar = c.foo + c.bar;

但是，存在一个问题：program.Command不是一个类型，而是一个变量。因此，您不能这样做：

interface program.Command {
debug: boolean;
}

虽然您可以这样做：

function f1(): typeof program.Command {
return program.Command;
}
type T = typeof program.Command;
function f2(): T {
return program.Command;
}

您也不能这样做：

interface typeof program.Command {
}

也不是这个：

type T = typeof program.Command;
interface T {
}

我不知道这个问题是否可以解决。

Answer 2

我想我找到了解决方案，我真的不知道这是否是一种好的做法，但并非如此。

import { Command } from 'commander';
const cli = new Command();
interface InterfaceCLI{
debug?: boolean;
}
cli
.version("1.0.0")
.usage("[options]")
.option("-d, --debug", "activate more debug messages. Can be set by env var DEBUG.", false)
.parse(process.argv);
const { debug } : InterfaceCli = <InterfaceCli><unknown>cli;
console.log(debug) // here debug is your cli.debug, I just used object destructuring

在我使用类型转换的上一行之前，我首先对非重叠类型进行 unkown 转换，然后最后，强制转换为我们的接口 -InterfaceCli.