History

Ayaz Hafiz 4db959260b docs(ivy): Add README to indexer module (#31260 )

Describe the indexer module for Angular compiler developers. Include
scope of analysis provided by the module and the indexers it targets as
first-party.

PR Close #31260

2019-07-31 11:37:11 -07:00

src

fix(ivy): correctly bind targetToIdentifier to the TemplateVisitor (#31861 )

2019-07-26 12:03:16 -07:00

test

fix(ivy): correctly bind targetToIdentifier to the TemplateVisitor (#31861 )

2019-07-26 12:03:16 -07:00

BUILD.bazel

feat(ivy): integrate indexing pipeline with NgtscProgram (#31151 )

2019-06-24 18:47:56 -07:00

index.ts

feat(ivy): setup boilerplate for component indexing API (#30961 )

2019-06-14 10:48:12 -07:00

README.md

docs(ivy): Add README to indexer module (#31260 )

2019-07-31 11:37:11 -07:00

README.md

`indexer`

The indexer module generates semantic analysis about components used in an Angular project. The module is consumed by a semantic analysis API on an Angular program, which can be invoked separately from the regular Angular compilation pipeline.

The module is not a fully-featured source code indexer. Rather, it is designed to produce semantic information about an Angular project that can then be used by language analysis tools to generate, for example, cross-references in Angular templates.

The indexer module is developed primarily with the Kythe ecosystem in mind as an indexing service.

Scope of Analysis

The scope of analysis performed by the module includes

indexing template syntax identifiers in a component template
generating information about directives used in a template
generating metadata about component and template source files

The module does not support indexing TypeScript source code.