com.google.javascript.jscomp

Class AbstractCommandLineRunner.CommandLineConfig

java.lang.Object

com.google.javascript.jscomp.AbstractCommandLineRunner.CommandLineConfig

Enclosing class:

AbstractCommandLineRunner<A extends Compiler,B extends CompilerOptions>

protected static class AbstractCommandLineRunner.CommandLineConfig
extends Object

Configurations for the command line configs. Designed for easy building, so that we can decouple the flags-parsing library from the actual configuration options. By design, these configurations must match one-to-one with command-line flags.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandLineConfig()

Method Summary

Modifier and Type	Method and Description
AbstractCommandLineRunner.CommandLineConfig	setAngularPass(boolean angularPass) Sets whether to process AngularJS-specific annotations.
AbstractCommandLineRunner.CommandLineConfig	setApplyInputSourceMaps(boolean applyInputSourceMaps) Whether to apply input source maps to the output, i.e.
AbstractCommandLineRunner.CommandLineConfig	setCharset(String charset) Input charset for all files.
AbstractCommandLineRunner.CommandLineConfig	setCodingConvention(CodingConvention codingConvention) Sets rules and conventions to enforce.
AbstractCommandLineRunner.CommandLineConfig	setCreateNameMapFiles(boolean createNameMapFiles) If true, variable renaming and property renaming map files will be produced as {binary name}_vars_map.out and {binary name}_props_map.out.
AbstractCommandLineRunner.CommandLineConfig	setCreateSourceMap(String createSourceMap) If specified, a source map file mapping the generated source files back to the original source file will be output to the specified path.
AbstractCommandLineRunner.CommandLineConfig	setDefine(List<String> define) Override the value of a variable annotated @define.
AbstractCommandLineRunner.CommandLineConfig	setDependencyMode(CompilerOptions.DependencyMode newVal) Sets whether to sort files by their goog.provide/require deps, and prune inputs that are not required.
AbstractCommandLineRunner.CommandLineConfig	setEntryPoints(List<ModuleIdentifier> entryPoints) Set module entry points, which makes the compiler only include those files and sort them in dependency order.
AbstractCommandLineRunner.CommandLineConfig	setExterns(List<String> externs) The file containing JavaScript externs.
AbstractCommandLineRunner.CommandLineConfig	setHideWarningsFor(List<String> hideWarningsFor) Sets the paths for which warnings will be hidden.
AbstractCommandLineRunner.CommandLineConfig	setInstrumentationTemplateFile(String fileName)
AbstractCommandLineRunner.CommandLineConfig	setJs(List<String> js) The JavaScript filename.
AbstractCommandLineRunner.CommandLineConfig	setJscompDevMode(com.google.javascript.jscomp.CompilerOptions.DevMode jscompDevMode) Turns on extra sanity checks
AbstractCommandLineRunner.CommandLineConfig	setJsonStreamMode(com.google.javascript.jscomp.CompilerOptions.JsonStreamMode mode)
AbstractCommandLineRunner.CommandLineConfig	setJsOutputFile(String jsOutputFile) Primary output filename.
AbstractCommandLineRunner.CommandLineConfig	setJsZip(List<String> zip) The JavaScript zip filename.
AbstractCommandLineRunner.CommandLineConfig	setLoggingLevel(String loggingLevel) The logging level (standard java.util.logging.Level values) for Compiler progress.
AbstractCommandLineRunner.CommandLineConfig	setManifestMaps(List<String> manifestMaps) Sets the execPath:rootRelativePath mappings
AbstractCommandLineRunner.CommandLineConfig	setMixedJsSources(List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> mixedJsSources) The JavaScript source file names, including .js and .zip files.
AbstractCommandLineRunner.CommandLineConfig	setModule(List<String> module) A JavaScript module specification.
AbstractCommandLineRunner.CommandLineConfig	setModuleOutputPathPrefix(String moduleOutputPathPrefix) Prefix for filenames of compiled JS modules.
AbstractCommandLineRunner.CommandLineConfig	setModuleRoots(List<String> jsModuleRoots) Sets the module roots.
AbstractCommandLineRunner.CommandLineConfig	setModuleWrapper(List<String> moduleWrapper) An output wrapper for a JavaScript module (optional).
AbstractCommandLineRunner.CommandLineConfig	setNewTypeInference(boolean useNewTypeInference)
AbstractCommandLineRunner.CommandLineConfig	setOutputBundle(List<String> outputBundles) Sets whether to print output bundle files.
AbstractCommandLineRunner.CommandLineConfig	setOutputManifest(List<String> outputManifests) Sets whether to print output manifest files.
AbstractCommandLineRunner.CommandLineConfig	setOutputModuleDependencies(String outputModuleDependencies) Sets whether a JSON file representing the dependencies between modules should be created.
AbstractCommandLineRunner.CommandLineConfig	setOutputWrapper(String outputWrapper) Interpolate output into this string at the place denoted by the marker token %output%, or %output|jsstring%
AbstractCommandLineRunner.CommandLineConfig	setParseInlineSourceMaps(boolean parseInlineSourceMaps)
AbstractCommandLineRunner.CommandLineConfig	setPrintAst(boolean printAst) Prints a dot file describing the internal abstract syntax tree and exits
AbstractCommandLineRunner.CommandLineConfig	setPrintPassGraph(boolean printPassGraph) Prints a dot file describing the passes that will get run and exits
AbstractCommandLineRunner.CommandLineConfig	setProcessCommonJSModules(boolean processCommonJSModules) Sets whether to process CommonJS modules.
AbstractCommandLineRunner.CommandLineConfig	setPropertyMapInputFile(String propertyMapInputFile) File containing the serialized version of the property renaming map produced by a previous compilation
AbstractCommandLineRunner.CommandLineConfig	setPropertyMapOutputFile(String propertyMapOutputFile) File where the serialized version of the property renaming map produced should be saved
AbstractCommandLineRunner.CommandLineConfig	setSkipNormalOutputs(boolean skipNormalOutputs) Sets whether the normal outputs of compilation should be skipped.
AbstractCommandLineRunner.CommandLineConfig	setSourceMapDetailLevel(SourceMap.DetailLevel level) The detail supplied in the source map file, if generated.
AbstractCommandLineRunner.CommandLineConfig	setSourceMapFormat(SourceMap.Format format) The source map format to use, if generated.
AbstractCommandLineRunner.CommandLineConfig	setSourceMapInputFiles(Map<String,String> sourceMapInputFiles)
AbstractCommandLineRunner.CommandLineConfig	setSourceMapLocationMappings(List<SourceMap.LocationMapping> locationMappings) The source map location mappings to use, if generated.
AbstractCommandLineRunner.CommandLineConfig	setStringMapOutputFile(String stringMapOutputPath) File where the serialized version of the string map produced by the ReplaceStrings pass should be saved.
AbstractCommandLineRunner.CommandLineConfig	setSummaryDetailLevel(int summaryDetailLevel) Controls how detailed the compilation summary is.
AbstractCommandLineRunner.CommandLineConfig	setTracerMode(CompilerOptions.TracerMode tracerMode)
AbstractCommandLineRunner.CommandLineConfig	setTransformAMDToCJSModules(boolean transformAMDToCJSModules) Set whether to transform AMD to CommonJS modules.
AbstractCommandLineRunner.CommandLineConfig	setTweak(List<String> tweak) Override the default value of a registered tweak.
AbstractCommandLineRunner.CommandLineConfig	setTweakProcessing(CompilerOptions.TweakProcessing tweakProcessing) Sets the kind of processing to do for goog.tweak functions.
AbstractCommandLineRunner.CommandLineConfig	setVariableMapInputFile(String variableMapInputFile) File containing the serialized version of the variable renaming map produced by a previous compilation
AbstractCommandLineRunner.CommandLineConfig	setVariableMapOutputFile(String variableMapOutputFile) File where the serialized version of the variable renaming map produced should be saved
AbstractCommandLineRunner.CommandLineConfig	setWarningGuards(List<AbstractCommandLineRunner.FlagEntry<CheckLevel>> warningGuards) Add warning guards.
AbstractCommandLineRunner.CommandLineConfig	setWarningsWhitelistFile(String fileName) Sets a whitelist file that suppresses warnings.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineConfig

protected CommandLineConfig()

Method Detail

setPrintAst

public AbstractCommandLineRunner.CommandLineConfig setPrintAst(boolean printAst)

Prints a dot file describing the internal abstract syntax tree and exits

setPrintPassGraph

public AbstractCommandLineRunner.CommandLineConfig setPrintPassGraph(boolean printPassGraph)

Prints a dot file describing the passes that will get run and exits

setJscompDevMode

public AbstractCommandLineRunner.CommandLineConfig setJscompDevMode(com.google.javascript.jscomp.CompilerOptions.DevMode jscompDevMode)

Turns on extra sanity checks

setLoggingLevel

public AbstractCommandLineRunner.CommandLineConfig setLoggingLevel(String loggingLevel)

The logging level (standard java.util.logging.Level values) for Compiler progress. Does not control errors or warnings for the JavaScript code under compilation

setExterns

public AbstractCommandLineRunner.CommandLineConfig setExterns(List<String> externs)

The file containing JavaScript externs. You may specify multiple.

setJs

public AbstractCommandLineRunner.CommandLineConfig setJs(List<String> js)

The JavaScript filename. You may specify multiple.

setJsZip

public AbstractCommandLineRunner.CommandLineConfig setJsZip(List<String> zip)

The JavaScript zip filename. You may specify multiple.

setMixedJsSources

public AbstractCommandLineRunner.CommandLineConfig setMixedJsSources(List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> mixedJsSources)

The JavaScript source file names, including .js and .zip files. You may specify multiple.

setJsOutputFile

public AbstractCommandLineRunner.CommandLineConfig setJsOutputFile(String jsOutputFile)

Primary output filename. If not specified, output is written to stdout

setModule

public AbstractCommandLineRunner.CommandLineConfig setModule(List<String> module)

A JavaScript module specification. The format is <name>:<num-js-files>[:[<dep>,...][:]]]. Module names must be unique. Each dep is the name of a module that this module depends on. Modules must be listed in dependency order, and JS source files must be listed in the corresponding order. Where --module flags occur in relation to --js flags is unimportant

setSourceMapInputFiles

public AbstractCommandLineRunner.CommandLineConfig setSourceMapInputFiles(Map<String,String> sourceMapInputFiles)

setParseInlineSourceMaps

public AbstractCommandLineRunner.CommandLineConfig setParseInlineSourceMaps(boolean parseInlineSourceMaps)

setVariableMapInputFile

public AbstractCommandLineRunner.CommandLineConfig setVariableMapInputFile(String variableMapInputFile)

File containing the serialized version of the variable renaming map produced by a previous compilation

setPropertyMapInputFile

public AbstractCommandLineRunner.CommandLineConfig setPropertyMapInputFile(String propertyMapInputFile)

File containing the serialized version of the property renaming map produced by a previous compilation

setVariableMapOutputFile

public AbstractCommandLineRunner.CommandLineConfig setVariableMapOutputFile(String variableMapOutputFile)

File where the serialized version of the variable renaming map produced should be saved

setCreateNameMapFiles

public AbstractCommandLineRunner.CommandLineConfig setCreateNameMapFiles(boolean createNameMapFiles)

If true, variable renaming and property renaming map files will be produced as {binary name}_vars_map.out and {binary name}_props_map.out. Note that this flag cannot be used in conjunction with either variable_map_output_file or property_map_output_file

setPropertyMapOutputFile

public AbstractCommandLineRunner.CommandLineConfig setPropertyMapOutputFile(String propertyMapOutputFile)

File where the serialized version of the property renaming map produced should be saved

setStringMapOutputFile

public AbstractCommandLineRunner.CommandLineConfig setStringMapOutputFile(String stringMapOutputPath)

File where the serialized version of the string map produced by the ReplaceStrings pass should be saved.

setCodingConvention

public AbstractCommandLineRunner.CommandLineConfig setCodingConvention(CodingConvention codingConvention)

Sets rules and conventions to enforce.

setSummaryDetailLevel

public AbstractCommandLineRunner.CommandLineConfig setSummaryDetailLevel(int summaryDetailLevel)

Controls how detailed the compilation summary is. Values: 0 (never print summary), 1 (print summary only if there are errors or warnings), 2 (print summary if type checking is on, see --check_types), 3 (always print summary). The default level is 1

setOutputWrapper

public AbstractCommandLineRunner.CommandLineConfig setOutputWrapper(String outputWrapper)

Interpolate output into this string at the place denoted by the marker token %output%, or %output|jsstring%

setModuleWrapper

public AbstractCommandLineRunner.CommandLineConfig setModuleWrapper(List<String> moduleWrapper)

An output wrapper for a JavaScript module (optional). See the flag description for formatting requirements.

setModuleOutputPathPrefix

public AbstractCommandLineRunner.CommandLineConfig setModuleOutputPathPrefix(String moduleOutputPathPrefix)

Prefix for filenames of compiled JS modules. <module-name>.js will be appended to this prefix. Directories will be created as needed. Use with --module

setCreateSourceMap

public AbstractCommandLineRunner.CommandLineConfig setCreateSourceMap(String createSourceMap)

If specified, a source map file mapping the generated source files back to the original source file will be output to the specified path. The %outname% placeholder will expand to the name of the output file that the source map corresponds to.

setSourceMapDetailLevel

public AbstractCommandLineRunner.CommandLineConfig setSourceMapDetailLevel(SourceMap.DetailLevel level)

The detail supplied in the source map file, if generated.

setSourceMapFormat

public AbstractCommandLineRunner.CommandLineConfig setSourceMapFormat(SourceMap.Format format)

The source map format to use, if generated.

setSourceMapLocationMappings

public AbstractCommandLineRunner.CommandLineConfig setSourceMapLocationMappings(List<SourceMap.LocationMapping> locationMappings)

The source map location mappings to use, if generated.

setApplyInputSourceMaps

public AbstractCommandLineRunner.CommandLineConfig setApplyInputSourceMaps(boolean applyInputSourceMaps)

Whether to apply input source maps to the output, i.e. map back to original inputs from input files that have source maps applied to them.

setWarningGuards

public AbstractCommandLineRunner.CommandLineConfig setWarningGuards(List<AbstractCommandLineRunner.FlagEntry<CheckLevel>> warningGuards)

Add warning guards.

setDefine

public AbstractCommandLineRunner.CommandLineConfig setDefine(List<String> define)

Override the value of a variable annotated @define. The format is <name>[=<val>], where <name> is the name of a @define variable and <val> is a boolean, number, or a single-quoted string that contains no single quotes. If [=<val>] is omitted, the variable is marked true

setTweak

public AbstractCommandLineRunner.CommandLineConfig setTweak(List<String> tweak)

Override the default value of a registered tweak. The format is <name>[=<val>], where <name> is the ID of a tweak and <val> is a boolean, number, or a single-quoted string that contains no single quotes. If [=<val>] is omitted, then true is assumed.

setTweakProcessing

public AbstractCommandLineRunner.CommandLineConfig setTweakProcessing(CompilerOptions.TweakProcessing tweakProcessing)

Sets the kind of processing to do for goog.tweak functions.

setCharset

public AbstractCommandLineRunner.CommandLineConfig setCharset(String charset)

Input charset for all files.

setDependencyMode

public AbstractCommandLineRunner.CommandLineConfig setDependencyMode(CompilerOptions.DependencyMode newVal)

Sets whether to sort files by their goog.provide/require deps, and prune inputs that are not required.

setEntryPoints

public AbstractCommandLineRunner.CommandLineConfig setEntryPoints(List<ModuleIdentifier> entryPoints)

Set module entry points, which makes the compiler only include those files and sort them in dependency order.

setOutputManifest

public AbstractCommandLineRunner.CommandLineConfig setOutputManifest(List<String> outputManifests)

Sets whether to print output manifest files. Filter out empty file names.

setOutputModuleDependencies

public AbstractCommandLineRunner.CommandLineConfig setOutputModuleDependencies(String outputModuleDependencies)

Sets whether a JSON file representing the dependencies between modules should be created.

setOutputBundle

public AbstractCommandLineRunner.CommandLineConfig setOutputBundle(List<String> outputBundles)

Sets whether to print output bundle files.

setSkipNormalOutputs

public AbstractCommandLineRunner.CommandLineConfig setSkipNormalOutputs(boolean skipNormalOutputs)

Sets whether the normal outputs of compilation should be skipped.

setManifestMaps

public AbstractCommandLineRunner.CommandLineConfig setManifestMaps(List<String> manifestMaps)

Sets the execPath:rootRelativePath mappings

setTransformAMDToCJSModules

public AbstractCommandLineRunner.CommandLineConfig setTransformAMDToCJSModules(boolean transformAMDToCJSModules)

Set whether to transform AMD to CommonJS modules.

setProcessCommonJSModules

public AbstractCommandLineRunner.CommandLineConfig setProcessCommonJSModules(boolean processCommonJSModules)

Sets whether to process CommonJS modules.

setModuleRoots

public AbstractCommandLineRunner.CommandLineConfig setModuleRoots(List<String> jsModuleRoots)

Sets the module roots.

setWarningsWhitelistFile

public AbstractCommandLineRunner.CommandLineConfig setWarningsWhitelistFile(String fileName)

Sets a whitelist file that suppresses warnings.

setHideWarningsFor

public AbstractCommandLineRunner.CommandLineConfig setHideWarningsFor(List<String> hideWarningsFor)

Sets the paths for which warnings will be hidden.

setAngularPass

public AbstractCommandLineRunner.CommandLineConfig setAngularPass(boolean angularPass)

Sets whether to process AngularJS-specific annotations.

setTracerMode

public AbstractCommandLineRunner.CommandLineConfig setTracerMode(CompilerOptions.TracerMode tracerMode)

setNewTypeInference

public AbstractCommandLineRunner.CommandLineConfig setNewTypeInference(boolean useNewTypeInference)

setInstrumentationTemplateFile

public AbstractCommandLineRunner.CommandLineConfig setInstrumentationTemplateFile(String fileName)

setJsonStreamMode

public AbstractCommandLineRunner.CommandLineConfig setJsonStreamMode(com.google.javascript.jscomp.CompilerOptions.JsonStreamMode mode)