的变通方法

Question

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

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 = {};
[...]

事实证明，这只能通过纯粹的运气来实现。文件之间没有依赖关系跟踪，因此您可能会遇到返回类型{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个文件。我知道常见的Node.js externs有https://github.com/dcodeIO/node.js-closure-compiler-externs，我知道如何在编译器上调用它们，但出于某些原因，当我执行--externs externs/fs.js之类的操作时，module$fs的错误仍然存在。我做错了什么？

我知道还有其他标志，如--module和--common_js_module_path_prefix，但我不确定是否需要使用它们才能使其工作。我的Google-fu未能在这里找到关于正确咒语的任何答案。：（

Answer 1

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

的变通方法

使用后处理添加外部需求声明

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

要添加的标题JS

var crypto = require('crypto');

要编译的来源

console.log(crypto);

因为在extern中声明crypto，编译器将正确识别类型和符号名称。

Alias Require Calls

当指定--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选项），还有另一种替代方法具有优势（相对于{ {3}}）可以正常使用未修改的第三方NPM模块，这些模块又可以导入内置模块。

使用存根

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

这是path内置模块的示例。

在externs/path/path.js中，我有path所需的部分“ externs”声明（实际上不是externs，因此您不能使用@nosideeffects）：

/** @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中，但我更愿意将存根与npm管理的实际模块分开。我只需要记住手动将符号链接添加到我的Git存储库，因为它已配置为忽略node_modules。）

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

2 个答案:

的变通方法

使用后处理添加外部需求声明

要添加的标题JS

要编译的来源

Alias Require Calls

要编译的来源

使用存根