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.

Constructor Summary

Constructors

Constructor and Description
ProcessCommonJSModules(Compiler compiler, ES6ModuleLoader loader) Creates a new ProcessCommonJSModules instance which can be used to rewrite CommonJS modules to a concatenable form.
ProcessCommonJSModules(Compiler compiler, ES6ModuleLoader loader, boolean reportDependencies) 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
void	process(Node externs, Node root) Process the JS with root node root.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessCommonJSModules

public ProcessCommonJSModules(Compiler compiler,
                              ES6ModuleLoader loader)

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

Parameters:

compiler - The compiler

loader - The module loader which is used to locate CommonJS modules

ProcessCommonJSModules

public ProcessCommonJSModules(Compiler compiler,
                              ES6ModuleLoader loader,
                              boolean reportDependencies)

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

Parameters:

compiler - The compiler

loader - The module loader which is used to locate CommonJS modules

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)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree