Include standard webpack start/end locations in emitted errors (#1255)

Author: lorenzodallavecchia

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v8.0.17
+* [Included correct webpack source location in emitted errors](https://github.com/TypeStrong/ts-loader/issues/1199) - thanks @lorenzodallavecchia
+
 ## v8.0.16
 * [Re-Fixed missing errors in watch mode in webpack5](https://github.com/TypeStrong/ts-loader/issues/1204) - thanks @appzuka
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-loader",
-  "version": "8.0.16",
+  "version": "8.0.17",
   "description": "TypeScript loader for webpack",
   "main": "index.js",
   "types": "dist",

src/interfaces.ts

@@ -13,12 +13,25 @@ export interface ErrorInfo {
   context: string;
 }
 
-export type FileLocation = { line: number; character: number };
+export type FileLocation = {
+  /** 1-based */
+  line: number;
+  /** 1-based */
+  character: number;
+};
 
+export type WebpackSourcePosition = {
+  /** 1-based */
+  line: number;
+  /** 0-based */
+  column?: number;
+};
 export interface WebpackError {
   module?: any;
   file?: string;
   message: string;
+  loc?: { start: WebpackSourcePosition; end?: WebpackSourcePosition };
+  /* ts-loader extra properties */
   location?: FileLocation;
   loaderSource: string;
 }

src/utils.ts

@@ -7,6 +7,7 @@ import * as typescript from 'typescript';
 import constants = require('./constants');
 import {
   ErrorInfo,
+  FileLocation,
   FilePathKey,
   LoaderOptions,
   ResolvedModule,
@@ -15,6 +16,7 @@ import {
   TSInstance,
   WebpackError,
   WebpackModule,
+  WebpackSourcePosition,
 } from './interfaces';
 import { getInputFileNameFromOutput } from './instances';
 /**
@@ -75,10 +77,10 @@ export function formatErrors(
         })
         .map<WebpackError>(diagnostic => {
           const file = diagnostic.file;
-          const position =
-            file === undefined
-              ? undefined
-              : file.getLineAndCharacterOfPosition(diagnostic.start!);
+          const { start, end } =
+            file === undefined || diagnostic.start === undefined
+              ? { start: undefined, end: undefined }
+              : getFileLocations(file, diagnostic.start, diagnostic.length);
           const errorInfo: ErrorInfo = {
             code: diagnostic.code,
             severity: compiler.DiagnosticCategory[
@@ -89,8 +91,8 @@ export function formatErrors(
               constants.EOL
             ),
             file: file === undefined ? '' : path.normalize(file.fileName),
-            line: position === undefined ? 0 : position.line + 1,
-            character: position === undefined ? 0 : position.character + 1,
+            line: start === undefined ? 0 : start.line,
+            character: start === undefined ? 0 : start.character,
             context,
           };
 
@@ -103,15 +105,35 @@ export function formatErrors(
             loaderOptions,
             message,
             merge.file === undefined ? errorInfo.file : merge.file,
-            position === undefined
-              ? undefined
-              : { line: errorInfo.line, character: errorInfo.character }
+            start,
+            end
           );
 
           return Object.assign(error, merge) as WebpackError;
         });
 }
 
+function getFileLocations(
+  file: typescript.SourceFile,
+  position: number,
+  length = 0
+) {
+  const startLC = file.getLineAndCharacterOfPosition(position);
+  const start: FileLocation = {
+    line: startLC.line + 1,
+    character: startLC.character + 1,
+  };
+  const endLC =
+    length > 0
+      ? file.getLineAndCharacterOfPosition(position + length)
+      : undefined;
+  const end: FileLocation | undefined =
+    endLC === undefined
+      ? undefined
+      : { line: endLC.line + 1, character: endLC.character + 1 };
+  return { start, end };
+}
+
 export function fsReadFile(
   fileName: string,
   encoding: string | undefined = 'utf8'
@@ -128,16 +150,36 @@ export function makeError(
   loaderOptions: LoaderOptions,
   message: string,
   file: string | undefined,
-  location?: { line: number; character: number }
+  location?: FileLocation,
+  endLocation?: FileLocation
 ): WebpackError {
   return {
     message,
-    location,
     file,
+    loc:
+      location === undefined
+        ? undefined
+        : makeWebpackLocation(location, endLocation),
+    location,
     loaderSource: tsLoaderSource(loaderOptions),
   };
 }
 
+function makeWebpackLocation(
+  location: FileLocation,
+  endLocation?: FileLocation
+) {
+  const start: WebpackSourcePosition = {
+    line: location.line,
+    column: location.character - 1,
+  };
+  const end: WebpackSourcePosition | undefined =
+    endLocation === undefined
+      ? undefined
+      : { line: endLocation.line, column: endLocation.character - 1 };
+  return { start, end };
+}
+
 export function tsLoaderSource(loaderOptions: LoaderOptions) {
   return `ts-loader-${loaderOptions.instance}`;
 }

test/comparison-tests/aliasResolution/expectedOutput-4.1/output.txt

@@ -5,6 +5,6 @@ Entrypoint main = bundle.js
 [./common/components/myComponent.ts] 46 bytes {main} [built]
 
 ERROR in app.ts
-./app.ts
+./app.ts 2:30-55
 [tsl] ERROR in app.ts(2,31)
       TS2307: Cannot find module 'components/myComponent2' or its corresponding type declarations.

test/comparison-tests/aliasResolution/expectedOutput-4.1/patch0/output.txt

@@ -5,6 +5,6 @@ Entrypoint main = bundle.js
 [./common/components/myComponent.ts] 45 bytes {main} [built]
 
 ERROR in app.ts
-./app.ts
+./app.ts 2:30-55
 [tsl] ERROR in app.ts(2,31)
       TS2307: Cannot find module 'components/myComponent2' or its corresponding type declarations.

test/comparison-tests/allowJs-ts-check/expectedOutput-4.1/output.txt

@@ -6,6 +6,6 @@ Entrypoint main = bundle.js
 [./src/index.js] 207 bytes {main} [built]
 
 ERROR in src/error2.js
-./src/error2.js
+./src/error2.js 4:9-12
 [tsl] ERROR in src/error2.js(4,10)
       TS2339: Property 'bar' does not exist on type 'Class2'.

test/comparison-tests/basic/expectedOutput-4.1/patch0/output.txt

@@ -6,6 +6,6 @@ Entrypoint main = bundle.js
 [./submodule/submodule.ts] 149 bytes {main}
 
 ERROR in app.ts
-./app.ts
+./app.ts 3:12-24
 [tsl] ERROR in app.ts(3,13)
       TS2551: Property 'doSomething2' does not exist on type 'typeof externalLib'. Did you mean 'doSomething'?

test/comparison-tests/colors/expectedOutput-4.1/output.txt

@@ -13,6 +13,6 @@ You may need an additional loader to handle the result of these loaders.
 | 
 
 ERROR in app.ts
-./app.ts
+./app.ts 1:6-8
 [tsl] ERROR in app.ts(1,7)
       TS1005: ',' expected.

test/comparison-tests/colors/expectedOutput-transpile-4.1/output.txt

@@ -13,6 +13,6 @@ You may need an additional loader to handle the result of these loaders.
 | 
 
 ERROR in app.ts
-./app.ts
+./app.ts 1:6-8
 [tsl] ERROR in app.ts(1,7)
       TS1005: ',' expected.