README.md

Parser

Specification

A parser must implement the following interface:

interface IParser {
  parse: (file: IFile) => IParseResult
}

The output should be in the following format:

interface IParseResult {
  comments: IComment[],
  type: string,
  file: IFile
}

These interfaces are defined in parser/interface.ts.