microsoft / microsoft/TypeScript-wiki
Clarify --diagnostics report units
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 759
- Forks
- 315
- PR merge metrics
- No merged PRs in 30d
Description
I've been recently looking at parsing --diagnostics output to report to out metrics service so that we can monitor compile times and while attempting to normalize values to a common unit (e.g. durations to seconds and memory used to MB), I've noticed that the docs are not very clear about the metric definitions and their respective units.
I would love if the docs specified what are the possible units that may be reported for each metric. For instance, can Total time be reported in milliseconds or even minutes right now? I see that memory used is reported as K, I assume that is kilobytes, but I'm not sure.
Less importantly, but in a similar vein, the duration timings (parse, bind, check, emit and total time) do not specify if these metrics are reported in wall time or CPU time. (it doesnt make much difference for our purposes, but it would be good to know how the metric may be affected).
If someone can point me to the relevant files where these metrics are measured, I would happy to take a stab at opening a PR :)
Thanks so much!
Contributor guide
No contributing guide indexed for this repository
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 at the TypeScript compiler's --diagnostics output and locate the documentation and metric definitions for parse, bind, check, emit, total time, and memory used. Clarify each metric's possible units and whether timings use wall time or CPU time; done means the documentation answers these questions for someone parsing the report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100