com.google.javascript.jscomp

Class DependencyOptions

java.lang.Object

com.google.javascript.jscomp.DependencyOptions

All Implemented Interfaces:

Serializable

public final class DependencyOptions
extends Object
implements Serializable

Options for how to manage dependencies between input files. Dependency information is usually pulled out from the JS code by looking for primitive dependency functions (like Closure Library's goog.provide/goog.require). Analysis of this dependency information is controlled by CodingConvention, which lets you define those dependency primitives. This options class determines how we use that dependency information to change how code is built.

Author:

[email protected] (Nick Santos)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DependencyOptions.ModuleIdentifier Basic information on an entry point module.

Constructor Summary

Constructors

Constructor and Description
DependencyOptions()

Method Summary

Modifier and Type	Method and Description
boolean	isEs6ModuleOrder()
DependencyOptions	setDependencyPruning(boolean enabled) Enables or disables dependency pruning mode.
DependencyOptions	setDependencySorting(boolean enabled) Enables or disables dependency sorting mode.
DependencyOptions	setEntryPoints(Collection<DependencyOptions.ModuleIdentifier> symbols) Adds a collection of symbols to always keep.
DependencyOptions	setEs6ModuleOrder(boolean es6ModuleOrder) Enables or disables ES6 module style ordering.
DependencyOptions	setMoocherDropping(boolean enabled) Enables or disables moocher dropping mode.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyOptions

public DependencyOptions()

Method Detail

setDependencySorting

public DependencyOptions setDependencySorting(boolean enabled)

Enables or disables dependency sorting mode. If true, we will sort the input files based on dependency information in them. Otherwise, we will use the order of files specified on the command-line.

Returns:

this for easy building.

setDependencyPruning

public DependencyOptions setDependencyPruning(boolean enabled)

Enables or disables dependency pruning mode. In dependency pruning mode, we will look for all files that provide a symbol. Unless that file is a transitive dependency of a file that we're using, we will remove it from the compilation job. This does not affect how we handle files that do not provide symbols. See setMoocherDropping for information on how these are handled.

Returns:

this for easy chaining.

setEs6ModuleOrder

public DependencyOptions setEs6ModuleOrder(boolean es6ModuleOrder)

Enables or disables ES6 module style ordering. This ordering differs from classic ordering in that inputs are sorted using a depth first instead of breadth first graph traversal and circular references are allowed.

Returns:

this for easy building.

setMoocherDropping

public DependencyOptions setMoocherDropping(boolean enabled)

Enables or disables moocher dropping mode. A 'moocher' is a file that does not provide any symbols (though they may require symbols). This is usually because they don't want to tie themselves to a particular dependency system (e.g., Closure's goog.provide, CommonJS modules). So they rely on other people to manage dependencies on them. If true, we drop these files when we prune dependencies. If false, we always keep these files an anything they depend on. The default is false. Notice that this option only makes sense if dependency pruning is on, and a set of entry points is specified.

Returns:

this for easy chaining.

setEntryPoints

public DependencyOptions setEntryPoints(Collection<DependencyOptions.ModuleIdentifier> symbols)

Adds a collection of symbols to always keep. In dependency pruning mode, we will automatically keep all the transitive dependencies of these symbols. The syntactic form of a symbol depends on the type of dependency primitives we're using. For example, goog.provide('foo.bar') provides the symbol 'foo.bar'. Entry points can be scoped to a module by specifying 'mod2:foo.bar'.

Returns:

this for easy chaining.

isEs6ModuleOrder

public boolean isEs6ModuleOrder()

toString

public String toString()

Overrides:

toString in class Object