Add test for filename prefix on rendering error message (#167)

lib/__snapshots__/index.test.js.snap

@@ -1,5 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`metalsmith-in-place should prefix rendering errors with the filename 1`] = `"index.hbs: Something went wrong while rendering"`;
+
 exports[`metalsmith-in-place should return an error for an invalid pattern 1`] = `"invalid pattern, the pattern option should be a string or array of strings. See https://www.npmjs.com/package/metalsmith-in-place#pattern"`;
 
 exports[`metalsmith-in-place should return an error when there are no valid files to process 1`] = `"no files to process. See https://www.npmjs.com/package/metalsmith-in-place#no-files-to-process"`;

lib/util.js → lib/get-transformer.js

@@ -18,6 +18,4 @@ function getTransformer(ext) {
   return cache[ext];
 }
 
-module.exports = {
-  getTransformer
-};
+module.exports = getTransformer;

lib/index.js

@@ -1,7 +1,7 @@
 const debug = require('debug')('metalsmith-in-place');
 const match = require('multimatch');
 const isUtf8 = require('is-utf8');
-const { getTransformer } = require('./util');
+const getTransformer = require('./get-transformer');
 
 /**
  * Engine, renders file contents with all available transformers

lib/index.test.js

@@ -7,6 +7,10 @@ const path = require('path');
 const plugin = require('./index');
 
 describe('metalsmith-in-place', () => {
+  beforeEach(() => {
+    jest.resetModules();
+  });
+
   it('should process a single file', done => {
     const base = path.join(process.cwd(), 'test', 'fixtures', 'single-file');
     const actual = path.join(base, 'build');
@@ -214,4 +218,22 @@ describe('metalsmith-in-place', () => {
       return done();
     });
   });
+
+  it('should prefix rendering errors with the filename', done => {
+    jest.doMock('./get-transformer', () =>
+      jest.fn(() => ({
+        renderAsync: () => Promise.reject(new Error('Something went wrong while rendering'))
+      }))
+    );
+    const plugin = require('./index'); // eslint-disable-line global-require, no-shadow
+
+    const base = path.join(process.cwd(), 'test', 'fixtures', 'rendering-error');
+    const metalsmith = new Metalsmith(base);
+
+    return metalsmith.use(plugin()).build(err => {
+      expect(err).toBeInstanceOf(Error);
+      expect(err.message).toMatchSnapshot();
+      done();
+    });
+  });
 });

package.json

@@ -44,7 +44,7 @@
     "eslint-config-prettier": "^2.9.0",
     "eslint-plugin-import": "^2.13.0",
     "husky": "^0.14.3",
-    "jest": "^23.4.1",
+    "jest": "^24.7.1",
     "jstransformer-handlebars": "^1.0.0",
     "jstransformer-marked": "^1.0.2",
     "lint-staged": "^7.0.0",