自动生成环境模块声明

Question

鉴于这2个打字稿文件

api/Token.ts

interface Token { 
    code: string
}
export default Token

和 index.ts

export * from './api/Token'

tsc 1.5与--declarations交换机将生成两个.d.ts文件(具有相似的内容)

api/Token.d.ts

interface Token { 
    code: string;
}
export default Token;

和 index.d.ts

export * from './api/Token';

使用以下选项运行grunt-dts-bundle

    dts_bundle: {
        release: {
            options: {
                name: 'my-module',
                main: 'index.d.ts'
            }
        }
    }

将生成具有my-module.d.ts以下内容的环境模块声明文件

declare module 'my-module' {
    export * from './api/Token';
}

但是,由于以下原因,此声明无法编译: Import or export declaration in an ambient module declaration cannot reference module through relative module name.

如何自动为上面的两个打字稿文件生成环境模块声明？

编辑

请关注https://github.com/Microsoft/TypeScript/issues/2262上的最新更新

Answer 1

我最近写了一篇关于此的博客文章。总而言之，如果您替换为，则可以使用autodts，其中包含以下内容：index.tsapi.ts

export {default as Token} from './api/Token';

确保与目录api.ts位于同一位置api（在目录旁边，而不是在目录内部）。

然后你需要一个package.json文件：

{
  "name": "api",
  "version": "1.0.0",
  "main": "dist/api.js",
  "scripts": {
    "preinstall": "npm install autodts",
    "postinstall": "autodts link",
    "prepublish": "tsc && autodts generate"
  },
  "typescript": {
    "definition": "index.d.ts"
  },
  "dependencies": {
    "autodts": "~0.0.4"
  },
  "devDependencies": {
    "@lib/autodts-generator": "~0.0.1",
    "typescript": "~1.5.3"
  }
}

api包名称与文件api.ts和目录匹配很重要api。这样，在使用您的包时，Node.js 和 TypeScript 编译器都会在相同的位置查找。

最后，你需要一个tsconfig.json文件：

{
    "compilerOptions": {
        "declaration": true,
        "module": "CommonJS",
        "target": "es5",
        "outDir": "dist"
    },
    "files": [
        "api.ts"
    ]
}

现在npm install将编译您的包并生成一个捆绑index.d.ts文件，如 中的definition设置所定义package.json。

要使用您的包，您可以执行以下操作：

/// <reference path = "api/index.d.ts" />

import {Token} from 'api';

class foo {
    key: Token;
}

您可以使用它autodts link来保持reference path最新状态，请查看博客文章和/或 autodts 文档。

结果index.d.ts包含：

/// <reference path="index.ref.d.ts" />
declare module 'api/Token' {
    interface Token {
        code: string;
    }
    export default Token;

}
declare module 'api' {
    export { default as Token } from 'api/Token';

}

index.ref.d.ts并且api.js都是空白的。