5.5 运行时编译API

⚠️运行时编译器 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获得的行为不匹配,或者在其他方面不兼容。如果您确实发现了一些不起作用的东西,请随时提出问题。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容