"project/util/parseUtils" | @atomist/automation-client

Index

Classes

UpdatingFileHits

Interfaces

Type aliases

Match

Functions

Object literals

DefaultOpts

Type aliases

Match

Match<M>: M & PatternMatch

Type parameters

Functions

doWithAtMostOneMatch

doWithAtMostOneMatch<M, P>(p: P, globPatterns: GlobOptions, microgrammar: Grammar<M>, action: (m: M) => void, opts?: Opts): Promise

- Defined in lib/project/util/parseUtils.ts:198
Similar to doWithUniqueMatch, but accepts zero matches without error

Type parameters
- M
- P: ProjectAsync = ProjectAsync
Parameters
- p: P
 
 project
- globPatterns: GlobOptions
- microgrammar: Grammar<M>
- action: (m: M) => void
 - - (m: M): void
 - Parameters
 - m: M
 Returns void
- Default value opts: Opts = DefaultOpts
Returns Promise

doWithFileMatches

doWithFileMatches<M, P>(p: P, globPatterns: GlobOptions, microgrammar: Grammar<M>, action: (fh: FileWithMatches<M>) => void, opts?: Opts): Promise

- Defined in lib/project/util/parseUtils.ts:112
Manipulate each file match containing an actual match. Will automatically match if necessary.

Type parameters
- M
- P: ProjectAsync = ProjectAsync
Parameters
- p: P
 
 project
- globPatterns: GlobOptions
- microgrammar: Grammar<M>
- action: (fh: FileWithMatches<M>) => void
 - - (fh: FileWithMatches<M>): void
 - Parameters
 - fh: FileWithMatches<M>
 Returns void
- Default value opts: Opts = DefaultOpts
 
 options
Returns Promise

doWithMatches

doWithMatches<M, P>(p: P, globPatterns: GlobOptions, microgrammar: Grammar<M>, action: (m: M) => void, opts?: Opts): Promise

- Defined in lib/project/util/parseUtils.ts:145
Convenience function to operate on matches in the project. Works regardless of the number of matches

Type parameters
- M
- P: ProjectAsync = ProjectAsync
Parameters
- p: P
 
 project
- globPatterns: GlobOptions
- microgrammar: Grammar<M>
- action: (m: M) => void
 - - (m: M): void
 - Parameters
 - m: M
 Returns void
- Default value opts: Opts = DefaultOpts
Returns Promise

doWithUniqueMatch

doWithUniqueMatch<M, P>(p: P, globPatterns: GlobOptions, microgrammar: Grammar<M>, action: (m: M) => void, opts?: Opts): Promise

- Defined in lib/project/util/parseUtils.ts:165
Convenience function to operate on the sole match in the project. Fail if zero or more than one.

Type parameters
- M
- P: ProjectAsync = ProjectAsync
Parameters
- p: P
 
 project
- globPatterns: GlobOptions
- microgrammar: Grammar<M>
- action: (m: M) => void
 - - (m: M): void
 - Parameters
 - m: M
 Returns void
- Default value opts: Opts = DefaultOpts
Returns Promise

findFileMatches

findFileMatches<M>(p: ProjectAsync, globPatterns: GlobOptions, microgrammar: Grammar<M>, opts?: Opts): Promise<Array<FileWithMatches<M>>>

- Defined in lib/project/util/parseUtils.ts:85
Integrate microgrammars with project operations to find all matches

Type parameters
- M
Parameters
- p: ProjectAsync
 
 project
- globPatterns: GlobOptions
 
 file glob patterns
- microgrammar: Grammar<M>
 
 microgrammar to run against each eligible file
- Default value opts: Opts = DefaultOpts
 
 options
Returns Promise<Array<FileWithMatches<M>>>

findMatches

findMatches<M>(p: ProjectAsync, globPatterns: GlobOptions, microgrammar: Grammar<M>, opts?: Opts): Promise<Array<Match<M>>>

- Defined in lib/project/util/parseUtils.ts:66
Integrate microgrammars with project operations to find all matches

Type parameters
- M
Parameters
- p: ProjectAsync
 
 project
- globPatterns: GlobOptions
 
 file glob patterns
- microgrammar: Grammar<M>
 
 microgrammar to run against each eligible file
- Default value opts: Opts = DefaultOpts
 
 options
Returns Promise<Array<Match<M>>>

transformIfNecessary

transformIfNecessary(rawContent: string, opts: Opts): string

- Defined in lib/project/util/parseUtils.ts:255
Transform content before processing if necessary

Parameters
- rawContent: string
- opts: Opts
Returns string

Index

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

Match

Type parameters

M

Functions

doWithAtMostOneMatch

Type parameters

M

P: ProjectAsync = ProjectAsync

Parameters

p: P

globPatterns: GlobOptions

microgrammar: Grammar<M>

action: (m: M) => void

Parameters

m: M

Returns void

Default value opts: Opts = DefaultOpts

Returns Promise<P>

doWithFileMatches

Type parameters

M

P: ProjectAsync = ProjectAsync

Parameters

p: P

globPatterns: GlobOptions

microgrammar: Grammar<M>

action: (fh: FileWithMatches<M>) => void

Parameters

fh: FileWithMatches<M>

Returns void

Default value opts: Opts = DefaultOpts

Returns Promise<P>

doWithMatches

Type parameters

M

P: ProjectAsync = ProjectAsync

Parameters

p: P

globPatterns: GlobOptions

microgrammar: Grammar<M>

action: (m: M) => void

Parameters

m: M

Returns void

Default value opts: Opts = DefaultOpts

Returns Promise<P>

doWithUniqueMatch

Type parameters

M

P: ProjectAsync = ProjectAsync

Parameters

p: P

globPatterns: GlobOptions

microgrammar: Grammar<M>

action: (m: M) => void

Parameters

m: M

Returns void

Default value opts: Opts = DefaultOpts

Returns Promise<P>

findFileMatches

Type parameters

M

Parameters

p: ProjectAsync

globPatterns: GlobOptions

microgrammar: Grammar<M>

Default value opts: Opts = DefaultOpts

Returns Promise<Array<FileWithMatches<M>>>

findMatches

Type parameters

M

Parameters