refactor: comment

Author: alexander-akait

package-lock.json

@@ -42,7 +42,6 @@
     "webpack": "^4.0.0"
   },
   "dependencies": {
-    "babel-code-frame": "^6.26.0",
     "loader-utils": "^1.0.2",
     "postcss": "^7.0.2",
     "postcss-value-parser": "^3.3.0",

package.json

@@ -1,22 +1,23 @@
-import formatCodeFrame from 'babel-code-frame';
-
 export default class SyntaxError extends Error {
   constructor(error) {
     super(error);
 
-    const { reason, message, line, column, source } = error;
+    const { reason, line, column } = error;
 
     this.name = 'SyntaxError';
-    this.message = reason || message;
+    this.message = reason;
 
     if (line && column) {
       this.message += ` (${line}:${column})`;
+    }
+
+    const code = error.showSourceCode();
 
-      if (source) {
-        this.message += `\n\n${formatCodeFrame(source, line, column)}\n`;
-      }
+    if (code) {
+      this.message += `\n\n${code}\n`;
     }
 
-    Error.captureStackTrace(this, this.constructor);
+    // We don't need stack https://github.com/postcss/postcss/blob/ebaa53640657fb028803d624395ea76a8df11cbe/docs/guidelines/runner.md#31-dont-show-js-stack-for-csssyntaxerror
+    this.stack = false;
   }
 }

src/SyntaxError.js

@@ -5,8 +5,7 @@ export default class Warning extends Error {
     this.name = 'Warning';
     this.message = warning.toString();
 
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, this.constructor);
-    }
+    // We don't need stack https://github.com/postcss/postcss/blob/ebaa53640657fb028803d624395ea76a8df11cbe/docs/guidelines/runner.md#31-dont-show-js-stack-for-csssyntaxerror
+    this.stack = false;
   }
 }

src/Warning.js

@@ -1,6 +1,6 @@
 /* eslint-disable */
 
-// CSS (Loader) Runtime
+// CSS Loader (Runtime)
 module.exports = function(useSourceMap) {
   const list = [];
 

src/runtime.js

@@ -1,46 +1,8 @@
-import SyntaxError from '../src/SyntaxError';
-
 import webpack from './helpers/compiler';
 import { normalizeErrors } from './helpers/utils';
 
 describe('SyntaxError', () => {
-  test('basic', () => {
-    expect(new SyntaxError(new Error()).toString()).toMatchSnapshot();
-    expect(new SyntaxError(new Error('message')).toString()).toMatchSnapshot();
-    expect(
-      new SyntaxError(new Error('message', 'test.css')).toString()
-    ).toMatchSnapshot();
-    expect(
-      new SyntaxError(new Error('message', 'test.css', 100)).toString()
-    ).toMatchSnapshot();
-
-    const errorWithReasong = new Error();
-
-    errorWithReasong.reason = 'reason';
-
-    expect(new SyntaxError(errorWithReasong).toString()).toMatchSnapshot();
-
-    const errorWithLineAndColumn = new Error('message');
-
-    errorWithLineAndColumn.line = 1;
-    errorWithLineAndColumn.column = 1;
-
-    expect(
-      new SyntaxError(errorWithLineAndColumn).toString()
-    ).toMatchSnapshot();
-
-    const errorWithLineAndColumnAndSource = new Error('message');
-
-    errorWithLineAndColumnAndSource.line = 1;
-    errorWithLineAndColumnAndSource.column = 1;
-    errorWithLineAndColumnAndSource.source = '.class { invalid }';
-
-    expect(
-      new SyntaxError(errorWithLineAndColumnAndSource).toString()
-    ).toMatchSnapshot();
-  });
-
-  test('integration', async () => {
+  test('basic', async () => {
     const stats = await webpack('broken.js');
 
     expect(normalizeErrors(stats.compilation.warnings)).toMatchSnapshot(

test/SyntaxError.test.js

@@ -1,37 +1,17 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`SyntaxError basic 1`] = `"SyntaxError"`;
-
-exports[`SyntaxError basic 2`] = `"SyntaxError: message"`;
-
-exports[`SyntaxError basic 3`] = `"SyntaxError: message"`;
-
-exports[`SyntaxError basic 4`] = `"SyntaxError: message"`;
-
-exports[`SyntaxError basic 5`] = `"SyntaxError: reason"`;
-
-exports[`SyntaxError basic 6`] = `"SyntaxError: message (1:1)"`;
-
-exports[`SyntaxError basic 7`] = `
-"SyntaxError: message (1:1)
-
-> 1 | .class { invalid }
-    | ^
-"
-`;
-
-exports[`SyntaxError integration: errors 1`] = `
+exports[`SyntaxError basic: errors 1`] = `
 Array [
   [ModuleBuildError: Module build failed (from \`replaced original path\`):
-SyntaxError: Unknown word (2:3)
+Unknown word (2:3)
 
-  1 | .some {
-> 2 |   invalid css;
-    |   ^
-  3 | }
-  4 | 
+ [90m 1 | [39m[33m.some[39m [33m{[39m
+[31m[1m>[22m[39m[90m 2 | [39m  invalid css[33m;[39m
+ [90m   | [39m  [31m[1m^[22m[39m
+ [90m 3 | [39m[33m}[39m
+ [90m 4 | [39m
 ],
 ]
 `;
 
-exports[`SyntaxError integration: warnings 1`] = `Array []`;
+exports[`SyntaxError basic: warnings 1`] = `Array []`;

test/__snapshots__/SyntaxError.test.js.snap

@@ -225,13 +225,12 @@ exports[`import true from modules: warnings 1`] = `Array []`;
 exports[`import true invalid: errors 1`] = `
 Array [
   [ModuleBuildError: Module build failed (from \`replaced original path\`):
-SyntaxError: Unexpected format  (\`replaced original path\`)
+Unexpected format  (\`replaced original path\`)
 
-> 1 | @import;
-    | ^
-  2 | 
-  3 | .class {
-  4 |   a: b c d;
+> 1 | @import;
+    | ^
+  2 | 
+  3 | .class {
 ],
 ]
 `;