atom-nuclide/pkg/nuclide-diagnostics-ui/README.md

A unified developer experience for web and mobile development, built as a suite of features on top of Atom to provide hackability and the support of an active community.

# nuclide-diagnostics-ui

Provides a default UI for diagnostics stored in [`nuclide-diagnostics-store`](
https://atom.io/packages/nuclide-diagnostics-store).

As shown in the screenshot, this feature adds the following UI to Atom:

1. For diagnostics that correspond to a particular file, a marker will appear in the gutter of
the corresponding text editor. Mousing over the marker will display the details of the diagnostic.
2. A checkbox can be used to filter the list of diagnostics to show only those that apply to the
file for the active text editor.
3. List view showing all of the diagnostics.
4. Clicking on the diagnostics count in the status bar will toggle the display of the list view.

![screenshot of diagnostics UI](./docs/diagnostics-ui-with-callouts.png)

As shown in the upper-right-hand corner of the table, the default keyboard shortcut to toggle the
list of diagnostics is `alt-shift-d`.
The name of the command is `nuclide-diagnostics-ui:toggle-table` if you want to remap this in
your `~/.atom/keymap.cson` file.