pavlitsky/vscode-yard

"use strict";
import { AuthorTag } from "../../tags/author";
import { DescriptionTag } from "../../tags/description";
import { IBaseParser } from "./base_parser";

// Parse class or module definition into documentation entities
export default class ClassOrModule implements IBaseParser {
  // Regexp to extract class/module type and its name
  public readonly regExp = /(class|module)\s+([\w:])?/;
  // Class/module name and type
  private parsedType: string = "";
  private parsedName: string = "";

  constructor(text: string) {
    const match: RegExpExecArray = this.regExp.exec(text);
    if (match) {
      const [, type, name] = match;
      this.parsedType = type;
      this.parsedName = name;
    }
  }

  // Is this parser ready to process the text
  public isApplicable(): boolean {
    return this.parsedType !== "" && this.parsedName !== "";
  }

  // Parse documentation tree
  public parse() {
    return [
      new DescriptionTag(),
      new AuthorTag(),
    ];
  }
}