microsoft / microsoft/TypeScript
[Feature Request] Print project directory when diagnostics enabled
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
diagnostics, project directory
Suggestion
I have about 40+ sub-projects in a composite project right now and when building, it takes about 10 minutes.
It's hard to troubleshoot which projects are the bottleneck when I don't even know which projects are being built.
Enabling diagnostics only tells me how long a project took but doesn't tell me what that project is.
So, my feature request is to print the project directory when diagnostics is enabled.
At the moment, I've modified my own tsc.js,
//Find this line
reportTimeStatistic("Total time", programTime + bindTime + checkTime + emitTime);
//Replace with this snippet
reportTimeStatistic("Total time", programTime + bindTime + checkTime + emitTime);
if (program.getRootFileNames().length > 0) {
const path = program.getRootFileNames()[0].replace(/\/[^/]+?\.[^.]+?$/, "");
reportStatisticalValue("Project", (
path.indexOf(program.getCurrentDirectory()) == 0 ?
path.substr(program.getCurrentDirectory().length) :
path
));
}
It works enough for me,
Files: 2944
Lines: 279749
Nodes: 1473021
Identifiers: 417022
Symbols: 295304
Types: 73
Memory used: 748010K
Assignability cache size: 0
Identity cache size: 0
Subtype cache size: 0
I/O Read time: 0.02s
Parse time: 0.21s
Program time: 0.84s
Bind time: 0.18s
printTime time: 0.01s
Emit time: 0.01s
I/O Write time: 0.01s
Total time: 1.03s
Project: /src/app-route-handler
I don't really know much about the TypeScript API. There's probably a proper way to get this information but with my limited knowledge, I managed to hack that together.
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the diagnostics reporting code around reportTimeStatistic in tsc.js and inspect how program.getRootFileNames() and program.getCurrentDirectory() are available. The change is complete when diagnostics output identifies the project directory for each reported project; use the existing reportStatisticalValue pattern as the reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, compilers
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100