fix: file path for webpack base on process.cwd (#524)

Use process.cwd as a base path for errors formatting. It's in most cases the same path as a webpack context. It solves issues with VSCode error link support.

Co-authored-by: liubo <[email protected]>

Author: piotr-oles

src/formatter/WebpackFormatter.ts

@@ -5,15 +5,15 @@ import { Formatter } from './Formatter';
 import { formatIssueLocation } from '../issue';
 import forwardSlash from '../utils/path/forwardSlash';
 
-function createWebpackFormatter(formatter: Formatter, context: string): Formatter {
+function createWebpackFormatter(formatter: Formatter): Formatter {
   // mimics webpack error formatter
   return function webpackFormatter(issue) {
     const color = issue.severity === 'warning' ? chalk.yellow.bold : chalk.red.bold;
 
     const severity = issue.severity.toUpperCase();
 
     if (issue.file) {
-      let location = forwardSlash(path.relative(context, issue.file));
+      let location = forwardSlash(path.relative(process.cwd(), issue.file));
       if (issue.location) {
         location += `:${formatIssueLocation(issue.location)}`;
       }

src/hooks/tapDoneToAsyncGetIssues.ts

@@ -64,7 +64,7 @@ function tapDoneToAsyncGetIssues(
     // modify list of issues in the plugin hooks
     issues = hooks.issues.call(issues, stats.compilation);
 
-    const formatter = createWebpackFormatter(configuration.formatter, compiler.context);
+    const formatter = createWebpackFormatter(configuration.formatter);
 
     if (issues.length) {
       // follow webpack's approach - one process.write to stderr with all errors and warnings

test/e2e/TypeScriptContextOption.spec.ts

@@ -1,5 +1,6 @@
 import { readFixture } from './sandbox/Fixture';
 import { join } from 'path';
+import os from 'os';
 import { createSandbox, Sandbox } from './sandbox/Sandbox';
 import {
   createWebpackDevServerDriver,
@@ -28,7 +29,7 @@ describe('TypeScript Context Option', () => {
     { async: false, typescript: '~3.0.0' },
     { async: true, typescript: '~3.6.0' },
     { async: false, typescript: '~3.8.0' },
-  ])('uses context to resolve project files for %p', async ({ async, typescript }) => {
+  ])('uses context and cwd to resolve project files for %p', async ({ async, typescript }) => {
     await sandbox.load([
       await readFixture(join(__dirname, 'fixtures/environment/typescript-basic.fixture'), {
         FORK_TS_CHECKER_WEBPACK_PLUGIN_VERSION: JSON.stringify(
@@ -65,13 +66,18 @@ describe('TypeScript Context Option', () => {
         exclude: ['node_modules'],
       })
     );
+    await sandbox.patch(
+      'webpack.config.js',
+      "entry: './src/index.ts',",
+      "entry: path.resolve(__dirname, './src/index.ts'),"
+    );
     await sandbox.patch(
       'webpack.config.js',
       '      logger: {',
       [
         '      typescript: {',
         '        enabled: true,',
-        '        configFile: "build/tsconfig.json",',
+        '        configFile: path.resolve(__dirname, "build/tsconfig.json"),',
         '        context: __dirname,',
         '      },',
         '      logger: {',
@@ -82,12 +88,21 @@ describe('TypeScript Context Option', () => {
       '          transpileOnly: true',
       [
         '          transpileOnly: true,',
-        '          configFile: "build/tsconfig.json",',
+        '          configFile: path.resolve(__dirname, "build/tsconfig.json"),',
         '          context: __dirname,',
       ].join('\n')
     );
+    // create additional directory for cwd test
+    await sandbox.write('foo/.gitignore', '');
 
-    const driver = createWebpackDevServerDriver(sandbox.spawn('npm run webpack-dev-server'), async);
+    const driver = createWebpackDevServerDriver(
+      sandbox.spawn(
+        `../node_modules/.bin/webpack-dev-server${os.platform() === 'win32' ? '.cmd' : ''}`,
+        {},
+        join(sandbox.context, 'foo')
+      ),
+      async
+    );
 
     // first compilation is successful
     await driver.waitForNoErrors();
@@ -103,7 +118,7 @@ describe('TypeScript Context Option', () => {
     const errors = await driver.waitForErrors();
     expect(errors).toEqual([
       [
-        'ERROR in src/model/User.ts:11:16',
+        'ERROR in ../src/model/User.ts:11:16',
         "TS2339: Property 'firstName' does not exist on type 'User'.",
         '     9 | ',
         '    10 | function getUserName(user: User): string {',
@@ -114,7 +129,7 @@ describe('TypeScript Context Option', () => {
         '    14 | }',
       ].join('\n'),
       [
-        'ERROR in src/model/User.ts:11:32',
+        'ERROR in ../src/model/User.ts:11:32',
         "TS2339: Property 'lastName' does not exist on type 'User'.",
         '     9 | ',
         '    10 | function getUserName(user: User): string {',