com.google.javascript.jscomp

Class ProcessCommonJSModules

java.lang.Object

com.google.javascript.jscomp.ProcessCommonJSModules

All Implemented Interfaces:

CompilerPass

public final class ProcessCommonJSModules
extends 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	COMMON_JS_MODULE_LOAD_ERROR
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.
ProcessCommonJSModules(Compiler compiler, boolean reportDependencies) Creates a new ProcessCommonJSModules instance which can be used to rewrite CommonJS modules to a concatenable form.

Method Summary

Methods

Modifier and Type	Method and Description
void	process(Node externs, Node root) Module rewriting is done a on per-file basis prior to main compilation.

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_JS_MODULE_LOAD_ERROR

public static final DiagnosticType COMMON_JS_MODULE_LOAD_ERROR

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

ProcessCommonJSModules

public ProcessCommonJSModules(Compiler compiler,
                      boolean reportDependencies)

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

Parameters:

compiler - The compiler

reportDependencies - Whether the rewriter should report dependency information to the Closure dependency manager. This needs to be true if we want to sort CommonJS module inputs correctly. Note that goog.provide and goog.require calls will still be generated if this argument is false.

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