⚠️运行时编译器 API 不稳定(并且需要使用标志来启用它)。
--unstable
运行时编译器 API 允许访问 Deno 的内部,以便能够键入检查、转铺和捆绑 JavaScript 和类型脚本。截至 Deno 1.7,我们合并为单个 API 的几种不同的 API。Deno.emit()
Deno.emit()
这个API在Deno命名空间中定义为:
function emit(
rootSpecifier: string | URL,
options?: EmitOptions,
): Promise<EmitResult>;
emit选项在Deno名称空间中定义为:
interface EmitOptions {
/** Indicate that the source code should be emitted to a single file
* JavaScript bundle that is a single ES module (`"esm"`) or a single file
* self contained script we executes in an immediately invoked function
* when loaded (`"iife"`). */
bundle?: "esm" | "iife";
/** If `true` then the sources will be typed checked, returning any
* diagnostic errors in the result. If `false` type checking will be
* skipped. Defaults to `true`.
*
* *Note* by default, only TypeScript will be type checked, just like on
* the command line. Use the `compilerOptions` options of `checkJs` to
* enable type checking of JavaScript. */
check?: boolean;
/** A set of options that are aligned to TypeScript compiler options that
* are supported by Deno. */
compilerOptions?: CompilerOptions;
/** An [import-map](https://deno.land/manual/linking_to_external_code/import_maps#import-maps)
* which will be applied to the imports. */
importMap?: ImportMap;
/** An absolute path to an [import-map](https://deno.land/manual/linking_to_external_code/import_maps#import-maps).
* Required to be specified if an `importMap` is specified to be able to
* determine resolution of relative paths. If a `importMap` is not
* specified, then it will assumed the file path points to an import map on
* disk and will be attempted to be loaded based on current runtime
* permissions.
*/
importMapPath?: string;
/** A record of sources to use when doing the emit. If provided, Deno will
* use these sources instead of trying to resolve the modules externally. */
sources?: Record<string, string>;
}
emit结果在Deno名称空间中定义为:
interface EmitResult {
/** Diagnostic messages returned from the type checker (`tsc`). */
diagnostics: Diagnostic[];
/** Any emitted files. If bundled, then the JavaScript will have the
* key of `deno:///bundle.js` with an optional map (based on
* `compilerOptions`) in `deno:///bundle.js.map`. */
files: Record<string, string>;
/** An optional array of any compiler options that were ignored by Deno. */
ignoredOptions?: string[];
/** An array of internal statistics related to the emit, for diagnostic
* purposes. */
stats: Array<[string, number]>;
}
这个API 旨在支持以下部分中描述的多个使用案例。
使用外部来源
使用本地和远程的外部源,Deno.emit()可以像Deno缓存在命令行上所做的那样工作,解析这些外部依赖项,输入检查这些依赖项,并提供发出的输出。
默认情况下,Deno.emit()将利用外部资源。作为第一个参数提供的rootSpecifier将确定哪个模块将用作根。根模块类似于您在命令行上提供的模块。
例如,如果您这样做了:
> deno run mod.ts
您可以使用Deno.emit()执行类似的操作:
try {
const { files } = await Deno.emit("mod.ts");
for (const [fileName, text] of Object.entries(files)) {
console.log(`emitted ${fileName} with a length of ${text.length}`);
}
} catch (e) {
// something went wrong, inspect `e` to determine
}
Deno.emit()将对远程模块使用与标准CLI相同的磁盘缓存,并继承执行它的进程的权限和缓存选项。
如果rootSpecifier是相对路径,那么Deno进程的当前工作目录将用于解析该说明符。(不是相对于当前模块!)。
RootSpecifier可以是字符串文件路径、字符串URL或URL。Emit()支持与Deno支持的URL相同的协议,即当前的file、http、https和data。
提供资源
您可以直接向Deno.emit()提供源代码,而不是从外部解析模块。这对于服务器能够提供用户提供的代码的按需编译特别有用,其中Deno进程已经收集了它想要发出的所有代码。
源在Deno.emit()选项参数的Sources属性中传递:
const { files } = await Deno.emit("/mod.ts", {
sources: {
"/mod.ts": `import * as a from "./a.ts";\nconsole.log(a);\n`,
"/a.ts": `export const a: Record<string, string> = {};\n`,
},
});
提供源代码后,Deno将不再从外部查看,并尝试从所提供的源代码映射中解析所有模块,尽管模块解析遵循与模块位于外部相同的规则。例如,所有模块说明符都需要它们的完整文件名。此外,由于没有媒体类型,如果您在源代码中提供远程URL,则路径应以适当的扩展名结尾,以便Deno可以确定如何处理文件。
类型检查和emitting
默认情况下,Deno.emit()将键入check any type cript(和tsx),就像在命令行中一样。它还会尝试转换JSX,但不会使用JavaScript。可以通过更改编译器选项来更改此行为。例如,如果希望Deno也键入check your JavaScript,则可以在编译器选项中将checkJs选项设置为true:
const { files, diagnostics } = await Deno.emit("./mod.js", {
compilerOptions: {
checkJs: true,
},
});
Deno.emit()结果提供有关所提供代码的任何诊断消息。在命令行上,所有诊断消息都记录到stderr中,Deno进程终止,但使用Deno.emit()时,它们会返回给调用者。
通常情况下,您需要检查是否有任何诊断,并对其进行适当处理。您可以单独自省诊断,但有一个方便的格式化函数可用于更容易地将诊断记录到名为Deno.format Diagnostics()的用户的控制台中:
const { files, diagnostics } = await Deno.emit("./mod.ts");
if (diagnostics.length) {
// there is something that impacted the emit
console.warn(Deno.formatDiagnostics(diagnostics));
}
绑定
Deno.emit()还能够在命令行上提供类似于Deno包的输出。这是通过将捆绑选项设置为“ESM”或“LIFE”来启用的。目前,Deno支持作为单个文件ES模块(“ESM”)或单个文件自包含的遗留脚本(“LifeE”)进行捆绑。
const { files, diagnostics } = await Deno.emit("./mod.ts", {
bundle: "esm",
});
结果文件将包含一个名为deno:///bundle.js的键,其值为结果包。
⚠️ 就像使用代码一样,捆绑包不会包括动态导入或辅助脚本等内容,这些内容预计会在代码运行时得到解决并可用。
deno bundle
导入maps
Deno.emit()
支持导入映射,就像在命令行上一样。这是一个非常强大的功能,可以更有效地用于发出和捆绑代码。
由于导入映射的工作方式,在与配合使用时,还必须提供导入映射的绝对URL。这允许Deno解析导入映射中指定的任何相对URL。即使导入映射不包含任何相对URL,也需要提供此URL。URL不需要真正存在,它只是提供给API。Deno.emit()
举个例子,我想使用一个纯说明符来加载我在我的项目中使用的特殊版本的lodash。我可以做以下几件事:
const { files } = await Deno.emit("mod.ts", {
bundle: "esm",
importMap: {
imports: {
"lodash": "https://deno.land/x/lodash",
},
},
importMapPath: "file:///import-map.json",
});
</pre>
⚠️ 如果您没有捆绑代码,发出的代码说明符不会被重写,这意味着任何使用代码的进程(例如Deno或浏览器)都需要支持导入映射,并使该映射在运行时可用。
仅跳过类型检查/转换
Deno.emit()
支持跳过类型检查,类似于命令行上的标志。这是通过将“check*”属性设置为“:--no-check``false
”来实现的。
const { files } = await Deno.emit("./mod.ts", {
check: false,
});
将check设置为false将指示Deno不要使用TypeScript编译器来键入、检查代码并发出它,而是只从Deno内部转换代码。这比进行完整的类型检查要快得多。
编译选项
Deno.emit()
支持相当多的编译器选项,这些选项可能会影响代码的类型检查和发出方式。它们类似于编译器选项部分中tsconfig.json支持的选项,但有几个选项不受支持。这是因为它们要么在Deno中没有意义,要么会导致Deno无法正常工作。Deno.emit()的默认值与命令行上的默认值相同。此处记录了这些选项及其默认值,并内置于Deno类型中。
如果您正在对代码进行类型检查,则会为您检查编译器选项的类型,但如果出于某种原因动态提供了编译器选项或没有进行类型检查,则Deno.emit()的结果将为您提供一个包含忽略选项的数组(如果有的话)。
⚠️ 我们只尝试禁用/删除我们知道不会起作用的选项,这并不意味着我们广泛测试Deno.emit()下所有配置中的所有选项。您可能会发现某些行为与您可以从TSC获得的行为不匹配,或者在其他方面不兼容。如果您确实发现了一些不起作用的东西,请随时提出问题。