Package com.google.javascript.jscomp

Provides the core compiler and its public API.

See: Description

Interface Summary

Interface	Description
AstValidator.ViolationHandler	Violation handler
CheckConformance.Rule
CodePrinter.Builder.CodeGeneratorFactory
CodingConvention	CodingConvention defines a set of hooks to customize the behavior of the Compiler for a specific team/company.
CompilerOptions.AliasTransformation	A Role Specific Interface for the JS Compiler to report aliases used to change the code during a compile.
CompilerOptions.AliasTransformationHandler	A Role Specific Interface for JS Compiler that represents a data holder object which is used to store goog.scope alias code changes to code made during a compile.
CompilerPass	Interface for classes that can compile JS.
ConformanceConfigOrBuilder
CssRenamingMap	Interface used by ReplaceCssNames to substitute CSS class names.
ErrorHandler	The error handler is any generic sink for warnings and errors, after they've passed through any filtering WarningsGuards.
ErrorManager	The error manager is in charge of storing, organizing and displaying errors and warnings generated by the compiler.
FunctionInformationMap.EntryOrBuilder
FunctionInformationMap.ModuleOrBuilder
FunctionInformationMapOrBuilder
HotSwapCompilerPass	Interface for compiler passes that can be used in a hot-swap fashion.
InstrumentationOrBuilder
JsMessage.IdGenerator	ID generator
MessageBundle	An interface for providing alternative values for user-visible messages in JavaScript code.
MessageFormatter	Format warnings and errors.
NodeTraversal.Callback	Callback for tree-based traversals
NodeTraversal.FunctionCallback	Callback for passes that iterate over a list of functions
NodeTraversal.ScopedCallback	Callback that also knows about scope changes
NodeUtil.Visitor	Interface for use with the visit method.
Region	Source code region.
RenamingMap	Interface used by to substitute names.
RequirementOrBuilder
SourceAst	An interface for accessing the AST root of an input.
SourceExcerptProvider	A source excerpt provider is responsible for building source code excerpt of specific locations, such as a specific line or a region around a given line number.
SourceExcerptProvider.ExcerptFormatter	A excerpt formatter is responsible of formatting source excerpts.
SourceFile.Generator	A JavaScript source code provider.
Xid.HashFunction	Strategy for selecting the underlying hash code function to be used by Xid.

Class Summary

Class	Description
AbstractCommandLineRunner<A extends Compiler,B extends CompilerOptions>	Implementations of AbstractCommandLineRunner translate flags into Java API calls on the Compiler.
AbstractCommandLineRunner.CommandLineConfig	Configurations for the command line configs.
AbstractCommandLineRunner.FlagEntry<T>	A pair from flag to its value.
AbstractCommandLineRunner.JsModuleSpec	Represents a specification for a js module.
AbstractCommandLineRunner.JsonFileSpec	Representation of a source file from an encoded json stream input
AbstractCompiler	An abstract compiler, to help remove the circular dependency of passes on JSCompiler.
AbstractMessageFormatter	Abstract message formatter providing default behavior for implementations of MessageFormatter needing a SourceExcerptProvider.
AccessControlUtils	Helper functions for computing the visibility of names and properties in JavaScript source code.
AstValidator	This class walks the AST and validates that the structure is correct.
BasicErrorManager	A basic error manager that sorts all errors and warnings reported to it to generate a sorted report when the BasicErrorManager.generateReport() method is called.
BranchCoverageInstrumentationCallback	Instrument branch coverage for javascript.
ByPathWarningsGuard	An implementation of a WarningsGuard that can modify the CheckLevel based on the file that caused the warning, and whether this file matches a set of paths (specified either as include or exclude of path name parts).
CallGraph	A pass the uses a DefinitionProvider to compute a call graph for an AST.
CheckConformance	Provides a framework for checking code against a set of user configured conformance rules.
CheckEventfulObjectDisposal	Check to ensure there exists a path to dispose of each eventful object created.
CheckPathsBetweenNodes<N,E>	See constructor, #CheckPathsBetweenNodes(DiGraph, DiGraphNode, DiGraphNode, Predicate, Predicate), for a description of this algorithm.
ClosureCheckModule	Checks that goog.module() is used correctly.
ClosureCodingConvention	This describes the Closure-specific JavaScript coding conventions.
ClosureCodingConvention.AssertFunctionByTypeName	A function that will throw an exception when the value is not an instanceof the given type name, for instance "Element".
ClosureCodingConvention.AssertInstanceofSpec	A function that will throw an exception when if the value is not an instanceof a specific type.
CodeConsumer	Abstracted consumer of the CodeGenerator output.
CodeGenerator	CodeGenerator generates codes from a parse tree, sending it to the specified CodeConsumer.
CodePrinter	CodePrinter prints out JS code in either pretty format or compact format.
CodePrinter.Builder
CodingConvention.AssertionFunctionSpec	A function that will throw an exception when either: -One or more of its parameters evaluate to false.
CodingConvention.Bind	Bind class
CodingConvention.Cache	Cache class
CodingConvention.DelegateRelationship	Delegates provides a mechanism and structure for identifying where classes can call out to optional code to augment their functionality.
CodingConvention.ObjectLiteralCast	An object literal cast provides a mechanism to cast object literals to other types without a warning.
CodingConvention.SubclassRelationship	Record subclass relations
CodingConventions	Helper classes for dealing with coding conventions.
CodingConventions.Proxy	A convention that wraps another.
CommandLineRunner	CommandLineRunner translates flags into Java API calls on the Compiler.
Compiler	Compiler (and the other classes in this package) does the following: parses JS code checks for undefined variables performs optimizations such as constant folding and constants inlining renames variables (to short names) outputs compact JavaScript code External variables are declared in 'externs' files.
Compiler.CodeBuilder	Stores a buffer of text to which more can be appended.
CompilerInput	A class for the internal representation of an input to the compiler.
CompilerOptions	Compiler options
ComposeWarningsGuard	WarningsGuard that represents just a chain of other guards.
Conformance
ConformanceConfig	Protobuf type jscomp.ConformanceConfig
ConformanceConfig.Builder	Protobuf type jscomp.ConformanceConfig
ConformanceRules	Standard conformance rules.
ConformanceRules.AbstractRule	A conformance rule implementation to support things common to all rules such as whitelisting and reporting.
ConformanceRules.BanExpose	Banned @expose
ConformanceRules.BanGlobalVars	Banned global var declarations.
ConformanceRules.BanNullDeref	Banned dereferencing null or undefined types.
ConformanceRules.BanThrowOfNonErrorTypes	Banned throw of non-error object types.
ConformanceRules.BanUnknownDirectThisPropsReferences	Banned unknown type references of the form "this.prop" unless - it is immediately cast, - it is a @template type (until template type restricts are enabled) or - the value is unused.
ConformanceRules.BanUnknownThis	Banned unknown "this" types.
ConformanceRules.BanUnknownTypedClassPropsReferences	Banned unknown type references of the form "instance.prop" unless (a) it is immediately cast/asserted, or (b) it is a @template type (until template type restrictions are enabled), or (c) the value is unused, or (d) the source object type is unknown (to avoid error cascades)
ConformanceRules.BanUnresolvedType	Banned accessing properties from objects that are unresolved forward-declared type names.
ConformanceRules.ConformanceResult	Classes extending AbstractRule must return ConformanceResult from their checkConformance implementation.
ConformanceRules.NoImplicitlyPublicDecls	Requires top-level Closure-style "declarations" (example: foo.bar.Baz = ...;) to have explicit visibility annotations, either at the declaration site or in the @fileoverview block.
ConformanceRules.RequireFileoverviewVisibility	Requires source files to contain a top-level @fileoverview block with an explicit visibility annotation.
ConformanceRules.RequireUseStrict	Require "use strict" rule
ControlFlowGraph<N>	Control flow graph.
ControlFlowGraph.AbstractCfgNodeTraversalCallback	Abstract callback to visit a control flow graph node without going into subtrees of the node that are also represented by other control flow graph nodes.
CssRenamingMap.ByPart	ByPart renaming map
CssRenamingMap.ByWhole	ByWhole renaming map
DartSuperAccessorsPass	Converts super getter and setter calls in order to support the output of the Dart Dev Compiler (https://github.com/dart-lang/dev_compiler).
DeadPropertyAssignmentElimination	An optimization pass that finds and removes dead property assignments within functions.
DefaultExterns	Contains information on default externs files.
DefaultPassConfig	Pass factories and meta-data for native JSCompiler passes.
DefinitionUseSiteFinder	Built on top of the NameBasedDefinitionProvider, this class additionally collects the use sites for each definition.
DependencyOptions	Options for how to manage dependencies between input files.
DiagnosticGroup	Group a set of related diagnostic types together, so that they can be toggled on and off as one unit.
DiagnosticGroups	Named groups of DiagnosticTypes exposed by Compiler.
DiagnosticGroupWarningsGuard	Sets the level for a particular DiagnosticGroup.
DiagnosticType	The type of a compile or analysis error.
DotFormatter	DotFormatter prints out a dot file of the Abstract Syntax Tree.
EmptyMessageBundle	An implementation of MessageBundle that has no translations.
Es6ConvertSuper	Converts super nodes.
Es6ExtractClasses	Extracts ES6 classes defined in function calls to local constants.
Es6RenameVariablesInParamLists	Renames declarations and references in function bodies to avoid shadowing names referenced in the parameter list, in default values or computed properties.
Es6RewriteArrowFunction	Converts ES6 arrow functions to standard anonymous ES3 functions.
Es6RewriteBlockScopedDeclaration	Rewrite "let"s and "const"s as "var"s.
Es6RewriteDestructuring	Rewrites ES6 destructuring patterns and default parameters to valid ES3 code.
Es6RewriteGenerators	Converts ES6 generator functions to valid ES3 code.
Es6SplitVariableDeclarations	Splits variable declarations that declare multiple variables into separate declarations, if at least one of the declarations is a destructuring declaration.
Es6ToEs3ClassSideInheritance	Rewrites static inheritance to explicitly copy inherited properties from superclass to subclass so that the typechecker knows the subclass has those properties.
Es6ToEs3Converter	Converts ES6 code to valid ES5 code.
Es6TypedToEs6Converter	Converts Node.getDeclaredTypeExpression() to JSDocInfo.getType() type annotations.
ExportTestFunctions	Generates goog.exportSymbol for test functions, so they can be recognized by the test runner, even if the code is compiled.
FieldCleanupPass	A CleanupPass implementation that will remove all field declarations on JSTypes contributed by the original file.
FunctionInfo
FunctionInformationMap	Protobuf type jscomp.FunctionInformationMap
FunctionInformationMap.Builder	Protobuf type jscomp.FunctionInformationMap
FunctionInformationMap.Entry	Protobuf type jscomp.FunctionInformationMap.Entry
FunctionInformationMap.Entry.Builder	Protobuf type jscomp.FunctionInformationMap.Entry
FunctionInformationMap.Module	Protobuf type jscomp.FunctionInformationMap.Module
FunctionInformationMap.Module.Builder	Protobuf type jscomp.FunctionInformationMap.Module
GoogleCodingConvention	This describes the Google-specific JavaScript coding conventions.
GoogleJsMessageIdGenerator	An JsMessage.IdGenerator designed to play nicely with Google's Translation systems.
GwtProperties	GWT-compatible helper for dealing with Java .properties files.
IdMappingUtil	A utility class for generating and parsing id mappings held by ReplaceIdGenerators.
ImplicitNullabilityCheck	Warn about types in JSDoc that are implicitly nullable.
Instrumentation	Protobuf type jscomp.Instrumentation
Instrumentation.Builder	Protobuf type jscomp.Instrumentation
InstrumentationTemplate
J2clClinitPrunerPass	An optimization pass to prune J2CL clinits.
J2clConstantHoisterPass	An optimization pass for J2CL-generated code to hoist some constant assignments out clinit method to declaration phase so they could be used by other optimization passes for static evaliation.
J2clEqualitySameRewriterPass	An optimization pass to re-write J2CL Equality.$same.
J2clPass	Rewrites/inlines some J2CL constructs to be more optimizable.
J2clPropertyInlinerPass	This pass targets j2cl output.
JqueryCodingConvention	This describes the jQuery specific JavaScript coding conventions.
JsAst	Generates an AST for a JavaScript source file.
JsAst.ParseResult	Simple class to share parse results between compilation jobs
JsAst.RhinoError
JSDocInfoPrinter	Prints a JSDocInfo, used for preserving type annotations in ES6 transpilation.
JsdocToEs6TypedConverter	Converts JS with types in jsdocs to an extended JS syntax that includes types.
JsdocToEs6TypedConverter.TypeDeclarationsIRFactory	Converts root nodes of JSTypeExpressions into TypeDeclaration ASTs.
JSError	Compile error description
JsMessage	A representation of a translatable message in JavaScript source code.
JsMessage.Builder	Contains functionality for creating JS messages.
JsMessage.PlaceholderReference	A reference to a placeholder in a translatable message.
JsMessageDefinition	Container class that holds information about JS message source.
JsMessageExtractor	Extracts messages and message comments from JS code.
JsMessageVisitor	Traverses across parsed tree and finds I18N messages.
JSModule	A JavaScript module has a unique name, consists of a list of compiler inputs, and can depend on other modules.
JSModuleGraph	A JSModule dependency graph that assigns a depth to each module and can answer depth-related queries about them.
LazyParsedDependencyInfo	A DependencyInfo class that determines load flags by parsing the AST just-in-time.
LightweightMessageFormatter	Lightweight message formatter.
Linter	Minimal binary that just runs the "lint" checks which can be run on a single file at a time.
LoggerErrorManager	An error manager that logs errors and warnings using a logger in addition to collecting them in memory.
ModuleIdentifier	Basic information on an entry point module.
NameBasedDefinitionProvider	Simple name-based definition gatherer that implements DefinitionProvider.
NodeTraversal	NodeTraversal allows an iteration through the nodes in the parse tree, and facilitates the optimizations on the parse tree.
NodeTraversal.AbstractModuleCallback	Abstract callback that knows when goog.modules (and in the future ES6 modules) are entered and exited.
NodeTraversal.AbstractNodeTypePruningCallback	Abstract callback to visit a pruned set of nodes.
NodeTraversal.AbstractPostOrderCallback	Abstract callback to visit all nodes in postorder.
NodeTraversal.AbstractPreOrderCallback	Abstract callback to visit all nodes in preorder.
NodeTraversal.AbstractScopedCallback	Abstract scoped callback to visit all nodes in postorder.
NodeTraversal.AbstractShallowCallback	Abstract callback to visit all nodes but not traverse into function bodies.
NodeTraversal.AbstractShallowStatementCallback	Abstract callback to visit all structure and statement nodes but doesn't traverse into functions or expressions.
NodeUtil	NodeUtil contains generally useful AST utilities.
PassConfig	Pass factories and meta-data for native Compiler passes.
PassConfig.State	Intermediate state for a running pass configuration.
PassFactory	A factory for creating JSCompiler passes based on the Options injected.
PassFactory.HotSwapPassFactory	A pass-factory that is good for HotSwapCompilerPass passes.
PerformanceTracker	A PerformanceTracker collects statistics about the runtime of each pass, and how much a pass impacts the size of the compiled output, before and after gzip.
PerformanceTracker.Stats	A Stats object contains statistics about a pass run, such as running time, size changes, etc
PrintStreamErrorManager	An error manager that prints errors and warnings to the print stream provided in addition to the functionality of the BasicErrorManager.
ProcessCommonJSModules	Rewrites a CommonJS module http://wiki.commonjs.org/wiki/Modules/1.1.1 into a form that can be safely concatenated.
ProcessEs6Modules	Rewrites a ES6 module into a form that can be safely concatenated.
RandomNameGenerator	A class for generating unique, randomized JavaScript variable/property names.
RecoverableJsAst	An implementation of SourceAst that avoids re-creating the AST unless it was manually cleared.
RemoveSuperMethodsPass	A pass for deleting methods that only make a super call with no change in arguments.
ReplacedStringsDecoder	A decoder for strings encoded by the ReplaceStrings JS compiler pass.
Requirement	Protobuf type jscomp.Requirement
Requirement.Builder	Protobuf type jscomp.Requirement
ResourceLoader	Utility class that handles resource loading.
Result	Compilation results
RewritePolyfills	Injects polyfill libraries to ensure that ES6 library functions are available.
Scope	Scope contains information about a variable scope in JavaScript.
ShowByPathWarningsGuard	Control whether warnings should be restricted or suppressed for specified paths.
SimpleRegion	Simple region.
SourceFile	An abstract representation of a source file that provides access to language-neutral features.
SourceFile.Builder	A builder interface for source files.
SourceMap	Collects information mapping the generated (compiled) source back to its original source for debugging purposes.
SourceMap.LocationMapping	A simple pair of path prefixes to the desired "destination" location to use within the source map.
SourceMapInput	A lazy-loaded SourceMapConsumerV3 instance.
StrictWarningsGuard	All warnings should be reported as errors.
SymbolTable	A symbol table for people that want to use Closure Compiler as an indexer.
SymbolTable.Reference	Reference
SymbolTable.Symbol	A symbol-table entry
SymbolTable.SymbolScope	Scope of a symbol
SyntheticAst	An AST generated totally by the compiler.
TemplateAstMatcher	A matcher that can take an arbitrary AST and use it as a template to find matches in another.
TransformAMDToCJSModule	Rewrites an AMD module https://github.com/amdjs/amdjs-api/wiki/AMD to a CommonJS module.
TranspilationPasses	Provides a single place to manage transpilation passes.
TypeCheck	Checks the types of JS expressions against any declared type information.
TypedScope	TypedScope contains information about variables and their types.
TypedVar	Several methods in this class, such as isVar throw an exception when called, and several methods are currently identical to the ones in Var.
TypeMatchingStrategy.MatchResult	The result of comparing two different TypeI instances.
Var	Used by Scope to store information about variables.
VariableMap	Stores the mapping from original variable name to new variable names.
WarningsGuard	Class that allows to flexibly manage what to do with a reported warning/error.
WhitelistWarningsGuard	An extension of WarningsGuard that provides functionality to maintain a list of warnings (white-list).
WhitespaceWrapGoogModules	Replicates the effect of ClosureBundler in whitespace-only mode and wraps goog.modules in goog.loadModule calls.
Xid	A simple utility for shortening identifiers in a stable way.
XtbMessageBundle	A MessageBundle that parses messages from an XML Translation Bundle (XTB) file.

Enum Summary

Enum	Description
AbstractCommandLineRunner.JsSourceType	Flag types for js source files.
AnonymousFunctionNamingPolicy	Strategies for how to do naming of anonymous functions that occur as r-values in assignments and variable declarations.
CheckLevel	Controls checking levels of certain options.
CheckLevelLegacy	Enum used in flags to control the behavior of JS compiler checks.
CodeGenerator.Context	Information on the current context.
CodePrinter.Format	Specifies a format for code generation.
CodingConvention.SubclassType	Specify the kind of inheritance
CompilationLevel	A CompilationLevel represents the level of optimization that should be applied when compiling JavaScript code.
CompilerOptions.DisposalCheckingPolicy	Policies to determine the disposal checking level.
CompilerOptions.Environment	An environment specifies the built-in externs that are loaded for a given compilation.
CompilerOptions.ExtractPrototypeMemberDeclarationsMode
CompilerOptions.J2clPassMode	A mode enum used to indicate whether J2clPass should be enabled, disabled, or enabled automatically if there is any J2cl source file (i.e.
CompilerOptions.LanguageMode	A language mode applies to the whole compilation job.
CompilerOptions.Reach	A common enum for compiler passes that can run either globally or locally.
CompilerOptions.TracerMode	How much tracing we want to do
CompilerOptions.TweakProcessing	Option for the ProcessTweaks pass
ConformanceRules.ConformanceLevel	Possible check check results
ControlFlowGraph.Branch	The edge object for the control flow graph.
CssRenamingMap.Style	Kind of renaming map
CustomPassExecutionTime	Custom pass type.
ErrorFormat	Error formats available.
JsMessage.Style	Message style that could be used for JS code parsing.
PropertyRenamingPolicy	Policies to determine how properties should be renamed.
Requirement.Type	Protobuf enum jscomp.Requirement.Type
ShowByPathWarningsGuard.ShowType	Controls whether warnings should be restricted to a specified path or suppressed within the specified path.
SourceExcerptProvider.SourceExcerpt	Source excerpt variety.
SourceMap.DetailLevel	Source maps can be very large different levels of detail can be specified.
SourceMap.Format	An enumeration of available source map formats
TypeMatchingStrategy	The different strategies for matching the TypeI of nodes.
VariableRenamingPolicy	Policies to determine which variables should be renamed.
WarningLevel	Convert the warnings level to an Options object.
WarningsGuard.Priority	Priority

Exception Summary

Exception	Description
AbstractCommandLineRunner.FlagUsageException	An exception thrown when command-line flags are used incorrectly.
CheckConformance.InvalidRequirementSpec
JSModuleGraph.MissingModuleException	Another exception class
JSModuleGraph.ModuleDependenceException	Exception class for declaring when the modules being fed into a JSModuleGraph as input aren't in dependence order, and so can't be processed for caching of various dependency-related queries.

Package com.google.javascript.jscomp Description

Provides the core compiler and its public API.