Use absolute file paths in error messages
See original GitHub issueSearch Terms
absolute
Suggestion
Output absolute paths in type errors for tsc
, or at least a way to specify this.
Use Cases
When type checking in monorepositories, typically tsc
is run for each workspace. tsc
is then run relative to the workspace it is run from, whereas developers are mostly interested in either the absolute path, or the path relative to the project root.
I have configured my terminal emulator so I can CTRL-click a file and then the file is opened in VSCode, even on the correct line. This works for tsc
output in simple TypeScript projects, because the file paths are relative to the project root. This also works for example for ESLint output, because it prints absolute paths. This does not work for tsc
in mono repositories, because the output of yarn workspaces run tsc
is relative to that workspace.
Examples
Clone and install a TypeScript mono repository.
git clone https://gitlab.com/remcohaszing/koas.git
cd koas
yarn
Let’s open the project using VSCode, since its builtin terminal is preconfigured to work with CTRL-click.
Run yarn workspaces run tsc
in the VSCode terminal. This should work fine.
Now mess up any type. I changed an instance of koas.Middleware
to koas.Middlewar
in packages/koas-core/src/index.ts
.
Run yarn workspaces run tsc
in the VSCode terminal again. Now this outputs an error and a file path. The file path is not clickable, because it can’t be resolved.
Checklist
My suggestion meets these guidelines:
- This wouldn’t be a breaking change in existing TypeScript/JavaScript code
- This wouldn’t change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn’t a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript’s Design Goals.
Issue Analytics
- State:
- Created 4 years ago
- Reactions:27
- Comments:6
Top GitHub Comments
This is issue that exhibits for monorepos in IDEs, however also automatic recognition of file errors in GitHub Actions. Having the ability to switch to absolute paths… Either by default, through TSConfig, or through environment variable, would be great thing.
If anyone is looking for a hack to get things working in GitHub actions:
It just prepends $PWD to lines formatted like errors.