Typescript 模块中的动态导出

Question

我想使用以下语法从 YAML 字段导入属性：

import { DATABASE_HOST, DATABASE_PORT} from 'my-config.yml';

在幕后，我有代码可以解析 YML 并传递所需的正确值，因此这部分不是问题。

但是，我不确定如何在typings.d.ts 中声明模块以支持这种语法。我试过这样做：

declare module '*.yml' {
    const content: any;
    export = content;
}

它会允许这种语法，这是不理想的：

import config from 'my-config.yml';
console.log(config.DATABASE_HOST);

也试过了，但效果不佳：

declare module '*.yml' {
    const content: any;
    export = content;
}

我尝试过的另一件事，但这完全禁用了类型检查。我希望至少能够定义配置字段类型。

declare module '*.yml' 

在 ts 配置中，我同时启用了 esModuleInterop 和 allowSyntheticDefaultImports。

我已经在顶部提到过，但想再次澄清一下，我将 YAML 导入 TS/JS 上下文没有问题，问题只是输入正确。

Answer 1

我会推荐一种替代方法。您可以在同一文件夹中为每个 yml 文件生成一个 ts 文件，如下所示...

假设您可以生成一个名为 my-config.ts 的文件（记住它是 ts，而不是 d.ts）

import c from './my-config.yml';

export interface IMyConfig {
    DATABASE_HOST: string,
    DATABASE_POR: number
}

const myConfig: IMyConfig = c;

export default myConfig;

您可以使用 gulp 或 grunt 通过查看 yml 文件来生成这些额外的 ts 文件。

用法

// this will load .ts
// which in turn will load the .yml
import myConfig from "my-config";

// you will get intellisense here...

要么这样，要么你可以编写一个打字稿语言服务插件来提供声明，但这确实很耗时，生成 ts 文件要简单得多。

这里有更多关于语言服务插件的信息，https://github.com/microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin

插件不适合一次性使用，因为未来版本的 typescript 可能会破坏插件，但您生成的 ts 文件将适用于未来版本，您可以轻松更改脚本以进行一些修改。