Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Diagnostics #3

Closed
sebmck opened this issue Feb 20, 2020 · 0 comments
Closed

Diagnostics #3

sebmck opened this issue Feb 20, 2020 · 0 comments
Labels
A-Documentation Area: documentation

Comments

@sebmck
Copy link
Contributor

sebmck commented Feb 20, 2020

Diagnostics are an extremely powerful feature of Rome that allow the generic construction and presentation of errors in source code.

  • Types can be found in packages/@romejs/diagnostics/types.ts.
  • Diagnostics can take two forms. The PartialDiagnostic type, which has a lot of optional properties and allows building up diagnostics in a more raw manner. The Diagnostic type has required properties that during normalization from PartialDiagnostic are inferred if necessary. This format is what is exposed to consumers and formatting logic.
  • The package @romejs/diagnostics contains the type definitions, normalization logic, and other utilities.
  • The package @romejs/cli-diagnostics contains the terminal formatting logic.
@sebmck sebmck added the A-Documentation Area: documentation label Feb 20, 2020
This was referenced Feb 20, 2020
@sebmck sebmck mentioned this issue Feb 20, 2020
sebmck pushed a commit that referenced this issue Mar 4, 2020
@sebmck sebmck closed this as completed Apr 30, 2020
sebmck pushed a commit that referenced this issue May 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Documentation Area: documentation
Projects
None yet
Development

No branches or pull requests

1 participant