diff --git a/docs/content/docs/cli.mdx b/docs/content/docs/cli.mdx index b24d5d69e..6dbdaf381 100644 --- a/docs/content/docs/cli.mdx +++ b/docs/content/docs/cli.mdx @@ -84,8 +84,11 @@ Verifies and reads the installed precompiled runtime objects and vendor archives
--emit <ir|llvm|asm|obj|exe>ir and llvm need only Node. asm and obj use a matching bundled LLVM helper on supported macOS, Linux, and Windows hosts and for WASI; they need no installed C compiler. exe is the default.--print <native-link-info>--emit=obj) and print its machine-readable external link recipe as JSON instead of printing the artifact path. The document names the exact installed precompiled runtime pack and all link inputs, but does not invoke a linker.--print <native-link-info|diagnostics>native-link-info: build an object (equivalent to --emit=obj) and print its machine-readable external link recipe as JSON instead of printing the artifact path. The document names the exact installed precompiled runtime pack and all link inputs, but does not invoke a linker. diagnostics: for build and coverage, print the versioned JSON diagnostics document described in Coverage Reports instead of the human output.--fail-on <blockers|divergences>divergences, also when it has Node divergence warnings. See Gating builds and CI.--dynamicany-typed code. Static compilation is the default; without this flag, dynamic-tier sites produce compilation errors. See npm Dependencies.blockers--dynamic does not resolve these blockers.--dynamic does not resolve these blockers.in unreached codediffers from Node| Field | +Meaning | +
|---|---|
schemaVersion |
+ Incremented when a field is renamed or removed or its meaning changes. New optional fields, categories, and codes keep the version. | +
success |
+ Coverage: no blockers on the entry path (and, with --fail-on=divergences, no divergences). Build: an artifact was produced, named by artifact. |
+
phase |
+ preflight when type checking, configuration, or the module graph stopped the command; compile when blockers remain; native when native code generation or linking failed; otherwise complete. |
+
stats |
+ Coverage only, absent after a preflight failure: the report's statement counts. | +
category |
+ invalid-source (the program has a TypeScript or JSON error), unsupported (valid code scriptc cannot compile yet), dynamic-only (compiles with --dynamic), divergence (compiles, but can behave differently from Node.js), environment (project configuration, scriptc's type world, toolchain, or target), or internal (a compiler bug). |
+
severity |
+ error, or warning for divergences. |
+
scope |
+ preflight, reached (fails a build), unreached (code the entry never reaches), or deferred (a JavaScript statement that compiles to a throw of its diagnostic, which happens only if it executes). |
+
line, column |
+ 1-based line and UTF-16 column; start and end are 0-based UTF-16 offsets. |
+
group |
+ The id of the root-cause group the diagnostic belongs to. A group's primary site is its first in source order. |
+