"tree/ast/astUtils" | @atomist/automation-client

Index

Type aliases

MatchTester

MatchTester: (n: LocatedTreeNode) => boolean

Tests matches within this file, using their tree node basis.

Type declaration

- (n: LocatedTreeNode): boolean
- Parameters
  - n: LocatedTreeNode
  Returns boolean

MatchTesterMaker

MatchTesterMaker: (f: File) => Promise<MatchTester>

Create a MatchTester to use against this file, caching any parsed or otherwise computed resources.

Type declaration

- (f: File): Promise<MatchTester>
- Parameters
 - f: File
 Returns Promise<MatchTester>

Functions

allPredicates

allPredicates(pe: PathExpression): Predicate[]

- Defined in lib/tree/ast/astUtils.ts:457
Parameters
- pe: PathExpression
Returns Predicate[]

applyActionToMatches

applyActionToMatches(fh: FileHit, action: (m: MatchResult) => void): void

- Defined in lib/tree/ast/astUtils.ts:425
Parameters
- fh: FileHit
- action: (m: MatchResult) => void
  - - (m: MatchResult): void
    - Parameters
      - m: MatchResult
      Returns void
Returns void

doWithAllMatches

doWithAllMatches(p: P, parserOrRegistry: FileParser | FileParserRegistry, globPatterns: GlobOptions, pathExpression: string | PathExpression, action: (m: MatchResult) => void): Promise

- Defined in lib/tree/ast/astUtils.ts:413
Integrate path expressions with project operations to find all matches of a path expression and perform a mutation on them them. Use with care!

Type parameters
- P: ProjectAsync = ProjectAsync
Parameters
- p: P
 
 project
- parserOrRegistry: FileParser | FileParserRegistry
 
 parser for files
- globPatterns: GlobOptions
 
 file glob pattern
- pathExpression: string | PathExpression
 
 path expression string or parsed
- action: (m: MatchResult) => void
 
 what to do with matches
 - - (m: MatchResult): void
 - Parameters
 - m: MatchResult
 Returns void
Returns Promise

hit record for each matching file

fileHitIterator

fileHitIterator(p: Project, opts: PathExpressionQueryOptions): AsyncIterable<FileHit>

- Defined in lib/tree/ast/astUtils.ts:247
Generator style iteration over file matches

Parameters
- p: Project
 
 project
- opts: PathExpressionQueryOptions
 
 options for query
Returns AsyncIterable<FileHit>

fileMatches

fileMatches(p: ProjectAsync, peqo: PathExpressionQueryOptions): Promise<FileHit[]>

- Defined in lib/tree/ast/astUtils.ts:171
Integrate path expressions with project operations to find all matches and their files

Parameters
- p: ProjectAsync
 
 project
- peqo: PathExpressionQueryOptions
 
 query options
Returns Promise<FileHit[]>

hits for each file

fillInSourceLocations

fillInSourceLocations(f: File, nodes: TreeNode[]): Promise<LocatedTreeNode[]>

- Defined in lib/tree/ast/astUtils.ts:344
Use file content to fill in LocatedTreeNode.sourceLocation

Parameters
- f: File
- nodes: TreeNode[]
Returns Promise<LocatedTreeNode[]>

findParser

findParser(pathExpression: PathExpression, fp: FileParser | FileParserRegistry): FileParser

- Defined in lib/tree/ast/astUtils.ts:431
Parameters
- pathExpression: PathExpression
- fp: FileParser | FileParserRegistry
Returns FileParser

findValues

findValues(p: ProjectAsync, parserOrRegistry: FileParser | FileParserRegistry, globPatterns: GlobOptions, pathExpression: string | PathExpression, functionRegistry?: FunctionRegistry): Promise<string[]>

- Defined in lib/tree/ast/astUtils.ts:368
Convenient method to find all values of matching nodes-- typically, terminals such as identifiers

Parameters
- p: ProjectAsync
 
 project
- parserOrRegistry: FileParser | FileParserRegistry
 
 parser for files
- globPatterns: GlobOptions
 
 file glob pattern
- pathExpression: string | PathExpression
 
 path expression string or parsed
- Optional functionRegistry: FunctionRegistry
 
 registry to look for path expression functions in
Returns Promise<string[]>

hit record for each matching file

gather

gather<T>(p: ProjectAsync, peqo: PathExpressionQueryOptions & { mapper: (m: MatchResult) => T }): Promise<T[]>

- Defined in lib/tree/ast/astUtils.ts:124
Integrate path expressions with project operations to gather mapped values from all matches. Choose the files with globPatterns; choose the portions of code to match with the pathExpression. Choose what to return based on each match with the mapper function. Returns all of the values returned by the mapper (except undefined).

Type parameters
- T
Parameters
- p: ProjectAsync
 
 project
- peqo: PathExpressionQueryOptions & { mapper: (m: MatchResult) => T }
 
 options
Returns Promise<T[]>

matches

gatherWithLocation

gatherWithLocation<T>(p: ProjectAsync, peqo: PathExpressionQueryOptions & { mapper: (m: MatchResult) => T }): Promise<Array<Gathered<T>>>

- Defined in lib/tree/ast/astUtils.ts:149
Like gather but keep location

Type parameters
- T
Parameters
- p: ProjectAsync
- peqo: PathExpressionQueryOptions & { mapper: (m: MatchResult) => T }
Returns Promise<Array<Gathered<T>>>

isAttributeEqualityPredicate

isAttributeEqualityPredicate(p: Predicate): p is AttributeEqualityPredicate

- Defined in lib/tree/ast/astUtils.ts:476
Parameters
- p: Predicate
Returns p is AttributeEqualityPredicate

isNestedPredicate

isNestedPredicate(p: Predicate): p is NestedPathExpressionPredicate

- Defined in lib/tree/ast/astUtils.ts:481
Parameters
- p: Predicate
Returns p is NestedPathExpressionPredicate

literalValues

literalValues(pex: PathExpression): string[]

- Defined in lib/tree/ast/astUtils.ts:449
Return literal values that must be present in a file for this path expression to match. Return the empty array if there are no literal @values or if we cannot determine whether there may be for this path expression.

Parameters
- pex: PathExpression
Returns string[]

matchIterator

matchIterator<T>(p: Project, opts: PathExpressionQueryOptions): AsyncIterable<MatchResult & T>

- Defined in lib/tree/ast/astUtils.ts:101
Generator style iteration over matches in a project. Modifications made to matches will be made on the project.

Type parameters
- T
Parameters
- p: Project
 
 project
- opts: PathExpressionQueryOptions
 
 options for query
Returns AsyncIterable<MatchResult & T>

matches

matches<T>(p: ProjectAsync, peqo: PathExpressionQueryOptions): Promise<Array<MatchResult & T>>

- Defined in lib/tree/ast/astUtils.ts:89
Integrate path expressions with project operations to find all matches

Type parameters
- T
Parameters
- p: ProjectAsync
 
 project
- peqo: PathExpressionQueryOptions
 
 query options
Returns Promise<Array<MatchResult & T>>

matches

parseFile

parseFile(parser: FileParser, pex: PathExpression, functionRegistry: FunctionRegistry, p: ProjectAsync, file: File, valuesToCheckFor: string[], matchTester: MatchTesterMaker, cacheAst: boolean): Promise<FileHit>

- Defined in lib/tree/ast/astUtils.ts:271
Parameters
- parser: FileParser
- pex: PathExpression
- functionRegistry: FunctionRegistry
- p: ProjectAsync
- file: File
- valuesToCheckFor: string[]
- matchTester: MatchTesterMaker
- cacheAst: boolean
Returns Promise<FileHit>

pathExpressionFileMatches

pathExpressionFileMatches(p: ProjectAsync, peqos: PathExpressionQueryOptions[]): Promise<PathExpressionFileHits[]>

- Defined in lib/tree/ast/astUtils.ts:196
Iterate over provided path expression query options and return FileHits for each path expression.

Parameters
- p: ProjectAsync
 
 project
- peqos: PathExpressionQueryOptions[]
 
 Array of query options
Returns Promise<PathExpressionFileHits[]>

hits for each file for each query option

zapAllMatches

zapAllMatches(p: P, parserOrRegistry: FileParser | FileParserRegistry, globPatterns: GlobOptions, pathExpression: string | PathExpression, opts?: NodeReplacementOptions): Promise

- Defined in lib/tree/ast/astUtils.ts:393
Integrate path expressions with project operations to find all matches of a path expression and zap them. Use with care!

Type parameters
- P: ProjectAsync = ProjectAsync
Parameters
- p: P
 
 project
- parserOrRegistry: FileParser | FileParserRegistry
 
 parser for files
- globPatterns: GlobOptions
 
 file glob pattern
- pathExpression: string | PathExpression
 
 path expression string or parsed
- Default value opts: NodeReplacementOptions = {}
 
 options for handling whitespace
Returns Promise

hit record for each matching file

Index

Interfaces

Type aliases

Functions

Type aliases

MatchTester

Type declaration

Parameters

n: LocatedTreeNode

Returns boolean

MatchTesterMaker

Type declaration

Parameters

f: File

Returns Promise<MatchTester>

Functions

allPredicates

Parameters

pe: PathExpression

Returns Predicate[]

applyActionToMatches

Parameters

fh: FileHit

action: (m: MatchResult) => void

Parameters

m: MatchResult

Returns void

Returns void

doWithAllMatches

Type parameters

P: ProjectAsync = ProjectAsync

Parameters

p: P

parserOrRegistry: FileParser | FileParserRegistry

globPatterns: GlobOptions

pathExpression: string | PathExpression

action: (m: MatchResult) => void

Parameters

m: MatchResult

Returns void

Returns Promise<P>

fileHitIterator

Parameters

p: Project

opts: PathExpressionQueryOptions

Returns AsyncIterable<FileHit>

fileMatches

Parameters

p: ProjectAsync

peqo: PathExpressionQueryOptions

Returns Promise<FileHit[]>

fillInSourceLocations

Parameters

f: File

nodes: TreeNode[]

Returns Promise<LocatedTreeNode[]>

findParser

Parameters

pathExpression: PathExpression

fp: FileParser | FileParserRegistry

Returns FileParser

findValues

Parameters

p: ProjectAsync

parserOrRegistry: FileParser | FileParserRegistry

globPatterns: GlobOptions

pathExpression: string | PathExpression

Optional functionRegistry: FunctionRegistry

Returns Promise<string[]>

gather

Type parameters

T

Parameters

p: ProjectAsync

peqo: PathExpressionQueryOptions & { mapper: (m: MatchResult) => T }

Returns Promise<T[]>

gatherWithLocation

Type parameters

T

Parameters