module: add filename to require() json errors

Otherwise it can be quite difficult to figure out which file is busted. Closes #3580.
nodejs · Jul 6, 2012 · ed7fb14 · ed7fb14
1 parent 0dba28b
commit ed7fb14
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/lib/module.js b/lib/module.js
@@ -471,7 +471,12 @@ Module._extensions['.js'] = function(module, filename) {
 // Native extension for .json
 Module._extensions['.json'] = function(module, filename) {
   var content = NativeModule.require('fs').readFileSync(filename, 'utf8');
-  module.exports = JSON.parse(stripBOM(content));
+  try {
+    module.exports = JSON.parse(stripBOM(content));
+  } catch (err) {
+    err.message = filename + ': ' + err.message;
+    throw err;
+  }
 };
 
 

diff --git a/test/fixtures/invalid.json b/test/fixtures/invalid.json
@@ -0,0 +1,5 @@
+{
+  "name": "foo",
+  "version": "0.0.1"
+  "description": "im broken"
+}
diff --git a/test/simple/test-require-json.js b/test/simple/test-require-json.js
@@ -0,0 +1,29 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+var assert = require('assert');
+
+try {
+  require('../fixtures/invalid.json');
+} catch (err) {
+  var i = err.message.indexOf('test/fixtures/invalid.json: Unexpected string')
+  assert(-1 != i, 'require() json error should include path');
+}