com.google.javascript.jscomp

Class ProcessCommonJSModules

java.lang.Object

com.google.javascript.jscomp.ProcessCommonJSModules

All Implemented Interfaces:

CompilerPass

public final class ProcessCommonJSModules
extends java.lang.Object
implements CompilerPass

Rewrites a CommonJS module http://wiki.commonjs.org/wiki/Modules/1.1.1 into a form that can be safely concatenated. Does not add a function around the module body but instead adds suffixes to global variables to avoid conflicts. Calls to require are changed to reference the required module directly. goog.provide and goog.require are emitted for closure compiler automatic ordering.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	SUSPICIOUS_EXPORTS_ASSIGNMENT
static DiagnosticType	UNKNOWN_REQUIRE_ENSURE

Constructor Summary

Constructors

Constructor and Description
ProcessCommonJSModules(Compiler compiler) Creates a new ProcessCommonJSModules instance which can be used to rewrite CommonJS modules to a concatenable form.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getCommonJsImportPath(Node requireCall)
static boolean	isCommonJsExport(NodeTraversal t, Node export) Recognize if a node is a module export.
static boolean	isCommonJsImport(Node requireCall) Recognize if a node is a module import.
void	process(Node externs, Node root) Module rewriting is done a on per-file basis prior to main compilation.
void	process(Node externs, Node root, boolean forceModuleDetection)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNKNOWN_REQUIRE_ENSURE

public static final DiagnosticType UNKNOWN_REQUIRE_ENSURE

SUSPICIOUS_EXPORTS_ASSIGNMENT

public static final DiagnosticType SUSPICIOUS_EXPORTS_ASSIGNMENT

Constructor Detail

ProcessCommonJSModules

public ProcessCommonJSModules(Compiler compiler)

Creates a new ProcessCommonJSModules instance which can be used to rewrite CommonJS modules to a concatenable form.

Parameters:

compiler - The compiler

Method Detail

process

public void process(Node externs,
                    Node root)

Module rewriting is done a on per-file basis prior to main compilation. The pass must handle ES6+ syntax and the root node for each file is a SCRIPT - not the typical jsRoot of other passes.

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

process

public void process(Node externs,
                    Node root,
                    boolean forceModuleDetection)

isCommonJsImport

public static boolean isCommonJsImport(Node requireCall)

Recognize if a node is a module import. We recognize two forms:

- require("something"); - __webpack_require__(4); // only when the module resolution is WEBPACK

getCommonJsImportPath

public static java.lang.String getCommonJsImportPath(Node requireCall)

isCommonJsExport

public static boolean isCommonJsExport(NodeTraversal t,
                                       Node export)

Recognize if a node is a module export. We recognize several forms:

- module.exports = something; - module.exports.something = something; - exports.something = something; - __webpack_exports__["something"] = something; // only when the module resolution is WEBPACK

In addition, we only recognize an export if the base export object is not defined or is defined in externs.