Typescript 在 node_modules 文件夹的定义文件中找不到类型

Question

我有一个具有这种结构的项目：

project/
├── package.config
├── node_modules/
│   ├── interactjs/
│   ├── ├── index.d.ts
├── src/
│   ├── browser/
│   |   ├── tsconfig.json
│   |   ├── index.ts

我有以下./package.json：

{
    ...
    "dependencies": {
        "interactjs": "1.3.4"
    },
    "devDependencies": {
        "typescript": "3.2.2"
    }
}

我的./src/browser/tsconfig.json 是：

{
    "compilerOptions": {
        "target": "es5",
        "module": "none",
        "declaration": true,
        "strict": true,
        "strictNullChecks": false,
        "outDir": "./out"
    },
    "typeRoots": [
        "../../node_modules",
        "../../node_modules/@types",
        "../definitions"
    ],
    "include": [
        "./**/*"
    ]
}

如您所见，我还包括文件夹 definitions，因为我想在项目的所有 Typescript 文件中包含一些手动定义。

问题

以下编译失败：

const p : interact.Position = { x: 1, y: 2 };

有错误：

index.ts:9:11 - error TS2503: Cannot find namespace 'interact'.

9 const s : interact.Position = { x: 1, y: 2 };
            ~~~~~~~~

即使在node_modules/interactjs 文件中index.d.ts 包含所有定义，也找不到interact。

有什么问题？

Answer 1

如果您希望将模块分辨率保持为无，将输入文件添加到 "include" 部分应该会给您所需的输出。

tsconfig.json

{
    "compilerOptions": {
        "target": "es5",
        "module": "none",
        "declaration": true,
        "strict": true,
        "strictNullChecks": false,
        "outDir": "./out",
        "noImplicitAny": false //<------ to ignore the errors in interactjs/index.d.ts
    },
    "typeRoots": [
        "../../node_modules",
        "../../node_modules/@types",
        "../definitions"
    ],
    "include": [
        "../../node_modules/interactjs/index.d.ts", //<----- include interact in the global scope
        "./**/*"
    ]
}

index.ts

const p : interact.Position = { x: 1, y: 2 };
const s : interact.SnapPosition = { x: 1, y: 2, range: 0 };

const listener : interact.Listener = (e: interact.InteractEvent)=>{
    console.log(e);
};

interact.on("cancel", listener)

构建index.js

"use strict";
var p = { x: 1, y: 2 };
var s = { x: 1, y: 2, range: 0 };
var listener = function (e) {
    console.log(e);
};
interact.on("cancel", listener);

Answer 2

您的 tsconfig.json 中似乎缺少 "moduleResolution":"node", 行。

这是我的一个 tsconfig.json 文件的样子。

{
  "compileOnSave": false,
  "compilerOptions": {
  "baseUrl": "./",
  "outDir": "./dist/out-tsc",
  "sourceMap": true,
  "declaration": false,
  "module": "es2015",
  "moduleResolution": "node",
  "emitDecoratorMetadata": true,
  "experimentalDecorators": true,
  "target": "es5",
  "typeRoots": [
    "node_modules/@types"
  ],
  "lib": [
    "es2017",
    "dom"
   ]
  }
}

Answer 3

当您导入包时，Typescript（和 Node）通过在包中包含的 package.json 文件中查找 main 字段来确定要从该包中导入哪个文件/模块。 interactjs 中的package.json 文件包括这一行：

"main": "dist/interact.js",

也就是说interactjs包中的主模块名为interact.js，在dist/目录下。

如果包的package.json 文件没有明确指定类型定义文件的位置，Typescript 将假定类型定义文件与包的主模块具有相同的基本名称和位置。给定interactjs 中主模块的位置，Typescript 将在文件dist/interact.d.ts 中查找类型定义。尝试将类型定义文件从index.d.ts 重命名为interact.d.ts，并确保它位于dist/ 目录中。

如果您正在创作一个包含 Typescript 定义的包，那么通过在 package.json 字段中包含 types 字段来明确定义文件的位置会很有帮助，如 publishing guide 中所述