feat: add eslint prefix to CLI output for better debugging (#155)

* feat: add eslint prefix to CLI output for better debugging * fix: message * test: remove eslint from parse message * chore: update lock file
webpack-contrib · Jun 22, 2022 · 67efb34 · 67efb34
1 parent 315fe0e
commit 67efb34
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 12 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/ESLintError.js b/src/ESLintError.js
@@ -3,7 +3,7 @@ class ESLintError extends Error {
    * @param {string=} messages
    */
   constructor(messages) {
-    super(messages);
+    super(`[eslint] ${messages}`);
     this.name = 'ESLintError';
     this.stack = '';
   }

diff --git a/src/linter.js b/src/linter.js
@@ -64,7 +64,8 @@ function linter(key, options, compilation) {
     }
     rawResults.push(
       lintFiles(files).catch((e) => {
-        compilation.errors.push(e);
+        // @ts-ignore
+        compilation.errors.push(new ESLintError(e.message));
         return [];
       })
     );

diff --git a/test/formatter-custom.test.js b/test/formatter-custom.test.js
@@ -10,7 +10,9 @@ describe('formatter eslint', () => {
       expect(stats.hasWarnings()).toBe(false);
       expect(stats.hasErrors()).toBe(true);
       expect(stats.compilation.errors[0].message).toBeTruthy();
-      const message = JSON.parse(stats.compilation.errors[0].message);
+      const message = JSON.parse(
+        stats.compilation.errors[0].message.replace('[eslint] ', '')
+      );
       expect(message.formatter).toEqual('mock');
       expect(message.results).toBeTruthy();
       done();
@@ -26,7 +28,9 @@ describe('formatter eslint', () => {
       expect(stats.hasWarnings()).toBe(false);
       expect(stats.hasErrors()).toBe(true);
       expect(stats.compilation.errors[0].message).toBeTruthy();
-      const message = JSON.parse(stats.compilation.errors[0].message);
+      const message = JSON.parse(
+        stats.compilation.errors[0].message.replace('[eslint] ', '')
+      );
       expect(message.formatter).toEqual('mock');
       expect(message.results).toBeTruthy();
       done();

diff --git a/test/formatter-write.test.js b/test/formatter-write.test.js
@@ -26,7 +26,7 @@ describe('formatter write', () => {
       expect(err).toBeNull();
       expect(stats.hasWarnings()).toBe(false);
       expect(stats.hasErrors()).toBe(true);
-      expect(stats.compilation.errors[0].message).toBe(contents);
+      expect(stats.compilation.errors[0].message).toBe(`[eslint] ${contents}`);
       done();
     });
   });
@@ -49,7 +49,7 @@ describe('formatter write', () => {
       expect(err).toBeNull();
       expect(stats.hasWarnings()).toBe(false);
       expect(stats.hasErrors()).toBe(true);
-      expect(stats.compilation.errors[0].message).toBe(contents);
+      expect(stats.compilation.errors[0].message).toBe(`[eslint] ${contents}`);
       done();
     });
   });