tsd：安装本地定义文件

Question

我有一个用 TypeScript 编写的本地节点包，我想在我的实际项目中使用它。使用 npm，我可以像这样安装本地包：

$ npm install --save /path/to/package

或：

$ npm install --save /path/to/package.tar.gz

这会在 node_modules 目录中安装所需的 .js 文件。该包中还有一个生成的 .d.ts 文件，我想将其安装到我的项目中（自动将其链接到 typings/tsd.d.ts）。但是使用下面的命令没有效果：

$ tsd install /path/to/package/package.d.ts --save

它说 >> zero results。那么，在不需要仓库的情况下安装本地定义文件的方法是什么？

更新：

我可以简单地将我的 d.ts 文件复制到 typings 目录和我的文本编辑器（对我来说它是带有 TypeScript 插件的 Sublime Text）它能够找到声明。目录布局是这样的：

/my-project/
  /typings/
    tsd.d.ts - auto-generated by `tsd install`
    node/ - I've installed the node definitions
    my-package.d.ts - copied or symlinked file
  my-project.ts - I'm working here

但是我在导出 module.exports 中的唯一函数（TypeScript 中的 exports = function... ）时遇到了问题。在这种情况下，导出的函数有点像 'anonymous'，甚至没有在 d.ts 文件中命名，所以我需要手动编辑它。

我的测试用例：

'my-package'提供单一函数，通常导入为'myPackage':

export = function myPackage(a: string, b: string) { return a + ' ' + b; };

declaration在tsconfig.json中设置为true，所以tsc命令生成了一个my-package.d.ts文件：

declare var _default: (a: string, b: string) => string;
export = _default;

我的包应该在我的项目中这样使用：

import myPackage = require('my-package');
myPackage('foo', 'bar');

然而，tsc 找不到 myPackage，即使 my-package.d.ts 已被复制到 typings 文件夹中。我需要编辑该文件，使其看起来像这样：

declare var myPackage: (a: string, b: string) => string;
//export = _default; - not needed

或者更好的功能 require():

declare module 'my-package' /* this is the string passed to require() */ {
    export = function(a: string, b: string): string;
}

Answer 1

在您的本地节点包中，在 package.json 中添加一个 typescript > definition 条目：

{
  "name": "your-package",
  ...
  "typescript": {
    "definition": "package.d.ts"
  }
}

然后在您的项目中安装包后，运行命令...

tsd link

...这将在项目的 tsd.d.ts 文件 (reference) 中添加对 package.d.ts 的引用。

此外，根据您的编辑，我建议您将定义文件更改为如下内容（注意 my-package 周围的引号）：

declare module "my-package" {
    function myPackage(a: string, b: string): string;
    export = myPackage;
}

这将使其适用于以下代码：

import myPackage = require('my-package');
myPackage('foo', 'bar');

Answer 2

从 TypeScript 1.6 开始，您可以从您那里引用您的类型定义文件 package.json 并且 TypeScript 的模块解析应该能够挖掘出类型定义。

在您的 package.json 文件（您的本地 npm 模块）中，添加一个 "typings" 条目，例如

{
    "name": "my-package",
    "typings": "./relative/path/to/my-package.d.ts"
}

这样你根本不需要 fiddle 使用 TSD。

参见 TypeScript Wiki：https://github.com/Microsoft/TypeScript/wiki/Typings-for-npm-packages

Answer 3

即使 package.json 的技巧有效，我更喜欢为此制作的工具（tsd 或打字）。

我刚刚找到了打字的答案：
typings install --save --ambient file:./node_modules/.../file.d.ts

我觉得tsd也一样:)

编辑：
由于 TypeScript 2.0 打字是无用的。
只是运行 npm i --save-dev @types/some-library

tsd：安装本地定义文件

tsd: install local definition file

typescript

definitelytyped

tsd