rf: Raise more issue-like objects for JSON

Author: effigies

src/files/json.test.ts

@@ -40,7 +40,7 @@ Deno.test('Test JSON error conditions', async (t) => {
     await loadJSON(BOMfile).catch((e) => {
       error = e
     })
-    assertObjectMatch(error, { key: 'INVALID_JSON_ENCODING' })
+    assertObjectMatch(error, { code: 'INVALID_JSON_ENCODING' })
   })
 
   await t.step('Error on UTF-16', async () => {
@@ -49,7 +49,7 @@ Deno.test('Test JSON error conditions', async (t) => {
     await loadJSON(UTF16file).catch((e) => {
       error = e
     })
-    assertObjectMatch(error, { key: 'INVALID_JSON_ENCODING' })
+    assertObjectMatch(error, { code: 'INVALID_JSON_ENCODING' })
   })
 
   await t.step('Error on invalid JSON syntax', async () => {
@@ -58,6 +58,6 @@ Deno.test('Test JSON error conditions', async (t) => {
     await loadJSON(badJSON).catch((e) => {
       error = e
     })
-    assertObjectMatch(error, { key: 'JSON_INVALID' })
+    assertObjectMatch(error, { code: 'JSON_INVALID' })
   })
 })

src/files/json.ts

@@ -14,7 +14,7 @@ async function readJSONText(file: BIDSFile): Promise<string> {
     }
     return text
   } catch (error) {
-    throw { key: 'INVALID_JSON_ENCODING' }
+    throw { code: 'INVALID_JSON_ENCODING' }
   } finally {
     decoder.decode() // Reset decoder
   }
@@ -26,12 +26,12 @@ export async function loadJSON(file: BIDSFile): Promise<Record<string, unknown>>
   try {
     parsedText = JSON.parse(text)
   } catch (error) {
-    throw { key: 'JSON_INVALID' } // Raise syntax errors
+    throw { code: 'JSON_INVALID' } // Raise syntax errors
   }
   if (Array.isArray(parsedText) || typeof parsedText !== 'object') {
     throw {
-      key: 'JSON_NOT_AN_OBJECT',
-      evidence: text.substring(0, 10) + (text.length > 10 ? '...' : ''),
+      code: 'JSON_NOT_AN_OBJECT',
+      issueMessage: text.substring(0, 10) + (text.length > 10 ? '...' : ''),
     }
   }
   return parsedText

src/schema/context.ts

@@ -210,8 +210,8 @@ export class BIDSContext implements Context {
     }
     for (const file of sidecars) {
       const json = await loadJSON(file).catch((error) => {
-        if (error.key) {
-          this.dataset.issues.add({ code: error.key, location: file.path })
+        if (error.code) {
+          this.dataset.issues.add({ ...error, location: file.path })
           return {}
         } else {
           throw error
@@ -272,8 +272,8 @@ export class BIDSContext implements Context {
       return
     }
     this.json = await loadJSON(this.file).catch((error) => {
-      if (error.key) {
-        this.dataset.issues.add({ code: error.key, location: this.file.path })
+      if (error.code) {
+        this.dataset.issues.add({ ...error, location: this.file.path })
         return {}
       } else {
         throw error

src/validators/bids.ts

@@ -57,8 +57,8 @@ export async function validate(
   const dsContext = new BIDSContextDataset({ options, schema, tree: fileTree })
   if (ddFile) {
     dsContext.dataset_description = await loadJSON(ddFile).catch((error) => {
-      if (error.key) {
-        dsContext.issues.add({ code: error.key, location: ddFile.path })
+      if (error.code) {
+        dsContext.issues.add({ ...error, location: ddFile.path })
         return {} as Record<string, unknown>
       } else {
         throw error