[英]How to make typedoc works with deno
我在我的一个项目中使用 Deno,我想用 typedoc 生成文档。 我面临着很多依赖关系的问题,因为它们没有得到正确解决,所以 typedoc 失败了。 我有以下tsconfig.json
:
{
"compilerOptions": {
"module": "amd",
"target": "esnext",
"baseUrl": ".",
"paths": {
"http://*": ["../../../.deno/deps/http/*"],
"https://*": ["../../../.deno/deps/https/*"],
"*.ts": ["*"]
},
"plugins": [
{
"name": "typescript-deno-plugin"
}
]
}
}
paths
的前两个条目解析 Deno 的本机模块(如其断言库)。 当我使用像deps.ts
这样的另一个库时,问题就出现了,在我的deps.ts
文件中像这样导入它:
// @deno-types="https://cdn.jsdelivr.net/gh/justjavac/deno_cheerio/cheerio.d.ts"
import cheerio from "https://dev.jspm.io/cheerio/index";
注意:我必须从外部源导入类型,因为 dev.jspm.io 中声明的类型不起作用,因为它们包含/// reference
指令。
我有以下typedoc.js
配置文件:
// deno-lint-ignore-file
module.exports = {
out: "./docs-build",
mode: "file",
};
如果我运行typedoc src/
,我会收到以下错误:
Using TypeScript 4.0.3 from /home/antonio/.nvm/versions/node/v12.18.1/lib/node_modules/typescript/lib
Error: /home/antonio/manga-api/src/deps.ts(8)
Cannot find module 'https://dev.jspm.io/cheerio/index'. Did you mean to set the 'moduleResolution' option to 'node', or to add aliases to the 'paths' option?
注2:我使用杰诺但typedoc
安装有NPM全球范围内,沿typescript
及typescript-deno-plugin
。
知道如何使typedoc
与typedoc
一起正常工作吗?
Typedoc 不适用于 Deno。 Deno 支持模块解析和 URL 解析,这是 Node(Typedoc 的当前运行时)所缺乏的。 它可以工作的唯一方法是 Typedoc 本身在 Deno 中运行,但目前它不提供支持。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.