feat(bom): allow processing of json files with BOM

APIDevTools · Mar 6, 2024 · 781c26f · 781c26f
1 parent f9e83c0
commit 781c26f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/lib/parsers/json.ts b/lib/parsers/json.ts
@@ -21,6 +21,11 @@ export default {
    */
   canParse: ".json",
 
+  /**
+   * Allow JSON files with byte order marks (BOM)
+   */
+  allowBOM: true,
+
   /**
    * Parses the given file as JSON
    */
@@ -37,6 +42,17 @@ export default {
         try {
           return JSON.parse(data);
         } catch (e: any) {
+          if (this.allowBOM) {
+            try {
+              // find the first curly brace
+              const firstCurlyBrace = data.indexOf("{");
+              // remove any characters before the first curly brace
+              data = data.slice(firstCurlyBrace);
+              return JSON.parse(data);
+            } catch (e: any) {
+              throw new ParserError(e.message, file.url);
+            }
+          }
           throw new ParserError(e.message, file.url);
         }
       }

diff --git a/lib/types/index.ts b/lib/types/index.ts
@@ -88,6 +88,13 @@ export interface Plugin {
    */
   allowEmpty?: boolean;
 
+  /**
+   * Specifies whether a Byte Order Mark (BOM) is allowed or not. Only applies to JSON parsing
+   *
+   * @type {boolean} @default true
+   */
+  allowBOM?: boolean;
+
   /**
    * The encoding that the text is expected to be in.
    */