microsoft / microsoft/TypeScript-wiki

Clarify --diagnostics report units

Offen
#293 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
759
Forks
315
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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!

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne bei der --diagnostics-Ausgabe des TypeScript-Compilers und ermittle die Dokumentation und Metrikdefinitionen für parse, bind, check, emit, total time und memory used. Kläre die möglichen Einheiten jeder Metrik und ob die Zeitangaben wall time oder CPU time verwenden; abgeschlossen ist die Aufgabe, wenn die Dokumentation diese Fragen für jemanden beantwortet, der den Bericht analysiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.