你如何在 Closure Compiler 中将 node_modules 定义为 externs？

Question

我有一个 Node.js 项目，我想使用 Closure Compiler 进行编译。我不希望它在 browser/use 浏览器中运行。我主要想要类型检查的实用程序。我最初使用以下命令让编译器正常工作：

java -jar compiler.jar -W VERBOSE 
                       --language_in ECMASCRIPT5_STRICT 
                       --externs closure-externs.js 
                       --js="lib/**.js"

其中 closure-externs.js 手动定义了我在 Node.js 中以相当粗略的方式使用的变量和函数：

// closure-externs.js

/** @constructor */function Buffer(something){}
function require(path){}
var process = {};
[...]

事实证明，这完全是靠运气。文件之间没有依赖关系跟踪，因此您可能会遇到 return 类型 {Foo} 并且编译器会抱怨它不存在的情况（取决于机器，取决于编译顺序） .然后我发现我做错了，应该使用 --process_common_js_modules 这样编译器就会在我 require("foo") 的地方进行依赖跟踪。我目前正在这样调用编译器：

java -jar compiler.jar -W VERBOSE 
                       --language_in ECMASCRIPT5_STRICT 
                       --externs externs/fs.js 
                       --js="lib/**.js"
                       --process_common_js_modules 
                       --common_js_entry_module app.js

但这失败了：

 ERROR - required entry point "module$crypto" never provided
 ERROR - required entry point "module$dgram" never provided
 ERROR - required entry point "module$extend" never provided
 ERROR - required entry point "module$fs" never provided
 ERROR - required entry point "module$net" never provided
 ERROR - required entry point "module$q" never provided

其中一些模块是 Node.js 原生的（例如 fs），而其他模块则包含在 node_modules 中，例如 q。我不想通过编译器运行这些外部模块，所以我知道我需要为它们设置 externs 文件。我知道有 https://github.com/dcodeIO/node.js-closure-compiler-externs 用于常见的 Node.js externs，我知道如何在编译器上调用它们，但由于某种原因，当我做类似 --externs externs/fs.js 的错误时 module$fs 遗迹。我做错了什么？

我知道还有其他标志，例如 --module 和 --common_js_module_path_prefix，但我不确定是否需要使用它们来使它正常工作。我的 Google-fu 在这里没有给出正确咒语的任何答案。 :(

Answer 1

问题是您希望编译器以某种方式识别某些 require 调用是内部的，即所需的模块应该由编译器作为源处理，而其他是外部的，因此应该保留独自的。目前没有很好的办法处理这种情况。

解决方法

使用Post-processing添加外部需求语句

在这种情况下，您将完全忽略对外部模块的任何 require 语句。编译器只会处理带有内部 require 语句和模块的代码。编译后，您将在前面添加外部 require 语句：

Header JS 被前置

var crypto = require('crypto');

要编译的源代码

console.log(crypto);

因为crypto是在extern中声明的，所以编译器会正确识别类型和符号名。

别名需要调用

当指定 --process_common_js_modules 时，编译器会识别 require 语句并以与宏在其他语言中的工作方式类似的方式扩展它们。通过别名应该保留在外部的 require 语句，编译器将无法识别它们，因此不会扩展它们。

要编译的源代码

var externalRequire = require;
/** @suppress {duplicate} this is already defined in externs */
var crypto = externalRequire('crypto');
console.log(crypto)

Answer 2

如果您使用 Closure Compiler 仅进行类型检查——即使用 --checks-only 选项——还有另一种解决方法具有优势（优于) 中提到的那些与未修改的第三方 NPM 模块一起正常工作，这些模块又导入内置模块。

使用存根

诀窍是创建存根 NPM 模块来代替内置模块。这些可以是最小的；他们只需要声明您实际使用的 API 的部分。

这是 path 内置模块的示例。

在 externs/path/path.js 中，我有 "externs" 声明（实际上不是 externs，所以例如你不能使用 @nosideeffects）我需要的 path 部分：

/** @const */
var path = {};

/**
 * @param {string} path
 * @return {string}
 */
path.dirname = function(path) {};

/**
 * @param {string} path
 * @return {string}
 */
path.extname = function(path) {};

/**
 * @param {...string} var_args
 * @return {string}
 */
path.join = function(var_args) {};

module.exports = path;

在 externs/path/package.json 中，我有一个最小的 NPM 包配置：

{
  "description": "Fake package.json for require('path')",
  "main": "path.js",
  "name": "path",
}

然后创建一个从 node_modules/path 到 externs/path 的符号链接，并将以下内容添加到我的编译器标志中：

node_modules/path/package.json
node_modules/path/path.js

（您可以将存根实现直接放入 node_modules，但我更愿意将存根与 [=21= 管理的实际模块分开]。我只需要记住手动添加符号链接到我的 Git 仓库，因为它被配置为忽略 node_modules。）

你如何在 Closure Compiler 中将 node_modules 定义为 externs？

How do you define node_modules as externs in Closure Compiler?

javascript

node.js

google-closure-compiler

解决方法

使用Post-processing添加外部需求语句

Header JS 被前置

要编译的源代码

别名需要调用

要编译的源代码

使用存根