YamlParser

reference

1 min readUpdated 2026-07-28

Kind: Class

Source: atloria-monorepo/libs/parser-core/src/parsers/config-docs/yaml.parser.ts

YAML Parser implementation

Implements: IParser

Methods

Method	Signature	Returns
`initialize`	`initialize(_config: ParserConfig)`	`Promise<void>`
`canParse`	`canParse(filePath: string)`	`boolean`
`parseFile`	`parseFile(filePath: string, content: string)`	`Promise<ParseResult>`
`parseFiles`	`parseFiles(files: ParseFileInput[])`	`Promise<ParseResult[]>`
`destroy`	`destroy()`	`Promise<void>`

YamlParser stops the work with an early return when fileName.includes('docker-compose') || fileName.includes('compose.y').
YamlParser stops the work with an early return when firstDoc['services'] || firstDoc['version'].
YamlParser stops the work with an early return when fileName.includes('.github/workflows/') || fileName.includes('/.github/workflows/').
YamlParser stops the work with an early return when firstDoc['on'] && firstDoc['jobs'].
YamlParser stops the work with an early return when fileName.includes('.gitlab-ci').
YamlParser stops the work with an early return when firstDoc['stages'] || firstDoc['image'].

YamlParser handles failure in 2 places: it logs it and continues in 1, and turns it into a return value in 1.