Added file identifier to error messages

Author: KyrylR

src/ExtendedCircomParser.ts

@@ -12,16 +12,24 @@ export class ExtendedCircomParser extends CircomParser {
   parserErrorListener: ErrorListener<Token>;
   lexerErrorListener: ErrorListener<number>;
 
-  constructor(tokens: antlr4.CommonTokenStream, lexer: CircomLexer) {
+  fileIdentifier: string;
+
+  constructor(
+    fileIdentifier: string,
+    tokens: antlr4.CommonTokenStream,
+    lexer: CircomLexer,
+  ) {
     super(tokens);
 
     this.lexer = lexer;
-    this.lexerErrorListener = new ErrorListener();
-    this.parserErrorListener = new ErrorListener();
+    this.lexerErrorListener = new ErrorListener(fileIdentifier);
+    this.parserErrorListener = new ErrorListener(fileIdentifier);
 
     this.initErrorListeners();
 
     this.buildParseTrees = true;
+
+    this.fileIdentifier = fileIdentifier;
   }
 
   circuit() {
@@ -42,11 +50,11 @@ export class ExtendedCircomParser extends CircomParser {
   }
 
   initErrorListeners() {
-    this.parserErrorListener = new ErrorListener();
+    this.parserErrorListener = new ErrorListener(this.fileIdentifier);
     this.removeErrorListeners();
     this.addErrorListener(this.parserErrorListener);
 
-    this.lexerErrorListener = new ErrorListener();
+    this.lexerErrorListener = new ErrorListener(this.fileIdentifier);
     this.lexer.removeErrorListeners();
     this.lexer.addErrorListener(this.lexerErrorListener);
   }

src/ExtendedCircomVisitor.ts

@@ -15,7 +15,7 @@ export class ExtendedCircomVisitor<Result> extends CircomVisitor<Result> {
 
   protected addError(message: string, context: ParserRuleContext) {
     this.errors.push({
-      templateName: this.templateIdentifier,
+      fileIdentifier: this.templateIdentifier,
       message,
       line: context.start.line,
       column: context.start.column,

src/errors/ErrorListener.ts

@@ -5,13 +5,12 @@ import { ParserErrorItem } from "../types";
 class ErrorListener<TSymbol> extends AntlrErrorListener<TSymbol> {
   private readonly _errors: ParserErrorItem[];
 
-  constructor() {
+  constructor(public fileIdentifier: string) {
     super();
 
     this._errors = [];
   }
 
-  // TODO: improve error handling
   syntaxError(
     recognizer: Recognizer<TSymbol>,
     offendingSymbol: TSymbol,
@@ -23,8 +22,8 @@ class ErrorListener<TSymbol> extends AntlrErrorListener<TSymbol> {
       message,
       line,
       column,
+      fileIdentifier: this.fileIdentifier,
       context: null as any,
-      templateName: null,
     });
   }
 

src/index.ts

@@ -6,14 +6,19 @@ import { CircomLexer } from "./generated";
 import { ExtendedCircomParser } from "./ExtendedCircomParser";
 
 export function getCircomParser(source: string): ExtendedCircomParser {
-  const inputStream = fs.existsSync(source)
-    ? antlr4.CharStreams.fromPathSync(source, "utf8")
-    : antlr4.CharStreams.fromString(source);
+  let inputStream: antlr4.CharStream;
+  let fileIdentifier = "Built from source";
+  if (fs.existsSync(source)) {
+    inputStream = antlr4.CharStreams.fromPathSync(source, "utf8");
+    fileIdentifier = source;
+  } else {
+    inputStream = antlr4.CharStreams.fromString(source);
+  }
 
   const lexer = new CircomLexer(inputStream);
   const tokens = new antlr4.CommonTokenStream(lexer);
 
-  return new ExtendedCircomParser(tokens, lexer);
+  return new ExtendedCircomParser(fileIdentifier, tokens, lexer);
 }
 
 export * from "./types";

src/types/errors.ts

@@ -1,7 +1,7 @@
 import { ParserRuleContext } from "antlr4";
 
 export type ParserErrorItem = {
-  templateName: string | null;
+  fileIdentifier: string;
   message: string;
   line: number;
   column: number;