fix(parseError): use file not path attribute

wraithgar · wraithgar · commit 5002e00d98e3 · 2021-08-18T14:13:43.000-07:00
BREAKING CHANGE: rename file attribute to path

In order to align with the way our other "fast" json parsers work the
err.file attribute needs to be renamed to err.path.

Also other errors i.e. ENOENT attach a path attribute.
diff --git a/read-json.js b/read-json.js
@@ -469,6 +469,6 @@ function parseIndex (data) {
 function parseError (ex, file) {
   var e = new Error('Failed to parse json\n' + ex.message)
   e.code = 'EJSONPARSE'
-  e.file = file
+  e.path = file
   return e
 }
diff --git a/test/fixtures/indexjs-bad/package.json b/test/fixtures/indexjs-bad/package.json
@@ -0,0 +1,3 @@
+{"this is
+
+  Not valid json!!
diff --git a/test/indexjs.js b/test/indexjs.js
@@ -19,8 +19,9 @@ t.test('read from an index.js file', t => {
   })
 })
 
-t.test('read broken json', t => {
-  const fixture = resolve(__dirname, 'fixtures/indexjs-bad/package.json')
+t.test('missing file', t => {
+  // this subdirectory does not exist
+  const fixture = resolve(__dirname, 'fixtures/indexjs-missing/package.json')
   read(fixture, (er, data) => {
     t.match(er, {
       code: 'ENOENT',
@@ -30,3 +31,15 @@ t.test('read broken json', t => {
     t.end()
   })
 })
+
+t.test('EJSONPARSE', t => {
+  const fixture = resolve(__dirname, 'fixtures/indexjs-bad/package.json')
+  read(fixture, (er, data) => {
+    t.match(er, {
+      code: 'EJSONPARSE',
+      path: fixture
+    })
+    t.notOk(data)
+    t.end()
+  })
+})

Original file line number	Diff line number	Diff line change
`@@ -469,6 +469,6 @@ function parseIndex (data) {`
`469`	`469`	`function parseError (ex, file) {`
`470`	`470`	`var e = new Error('Failed to parse json\n' + ex.message)`
`471`	`471`	`e.code = 'EJSONPARSE'`
`472`		`- e.file = file`
	`472`	`+ e.path = file`
`473`	`473`	`return e`
`474`	`474`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{"this is`
	`2`	`+`
	`3`	`+ Not valid json!!`