YamlParser

reference

1 min readUpdated 2026-07-29

Kind: Class

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

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 Error when !content — “Content is required for parsing”.
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 handles failure in 1 place: it turns it into a return value in all 1.