Error Lens

Alexander

|
3,671 installs
|
11,513 downloads
| (10) | Free
Improve highlighting of errors, warnings and other language diagnostics.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

This is a fork of https://github.com/phindle/error-lens. Changes between this and the original repo should be reflected in the CHANGELOG file.

ErrorLens turbo-charges the language diagnostic features, by making diagnostics stand out more prominently, highlighting the entire line wherever a diagnostic is generated by the language and also prints the diagnostic message(s) in-line at the site of the line of code which is generating the diagnostic.

ErrorLens example

Features

  • Highlight lines containing diagnostics.
  • Append diagnostic descriptions to the end of the line.
  • Show icons in gutter.

Settings

  • errorLens.errorBackground: Background color of the entire line containing error.
  • errorLens.errorForeground: Text color used to highlight lines containing errors.
  • errorLens.errorMessageBackground: Background color of the error message.
  • errorLens.warningBackground: Background color of the entire line containing warning.
  • errorLens.warningForeground: Text color used to highlight lines containing warnings.
  • errorLens.warningMessageBackground: Background color of the warning message.
  • errorLens.infoBackground: Background color of the entire line containing info.
  • errorLens.infoForeground: Text color used to highlight lines containing info.
  • errorLens.infoMessageBackground: Background color of the info message.
  • errorLens.hintBackground: Background color of the entire line containing hint.
  • errorLens.hintForeground: Text color used to highlight lines containing hints.
  • errorLens.hintMessageBackground: Background color of the hint message.
  • errorLens.light: Overwrite any of the above colors for light themes
  • errorLens.fontSize: Font size of annotations Not officially supported
  • errorLens.fontFamily: Font family of annotations. Not officially supported
  • errorLens.fontWeight: Font Weight of annotations.
  • errorLens.fontStyleItalic: Show ErrorLens annotations in Italics, or not?
  • errorLens.margin: Distance between the end of the line and the start of annotation. (CSS units)
  • errorLens.enabledDiagnosticLevels: Customize which diagnostic levels to highlight.
  • errorLens.addAnnotationTextPrefixes: If 'true', prefixes the diagnostic severity ('ERROR:', 'WARNING:' etc) to ErrorLens annotations.
  • errorLens.exclude: Specify messages that should not be highlighted.
  • errorLens.delay: Specify delay before showing problems.
  • errorLens.clearDecorations: Works only when delay is set. When set to true extension clears all decorations at the time when diagnostic changes (but it could cause flickering if the delay is < 500). When set to false - decorations are not cleared and delay applied to clearing decorations also (but that causes messages being on screen even if the problem was solved).
  • errorLens.onSave: Update decorations only on document save.
  • errorLens.gutterIconsEnabled: Show gutter icons (In place of debug breakpoint icon).
  • errorLens.gutterIconSize: Customize gutter icon size. Example: "120%"
  • errorLens.gutterIconSet: Customize gutter icon style. Possible values: "default", "defaultOutline", "borderless", "circle".
  • errorLens.errorGutterIconPath: Absolute path for error gutter icon.
  • errorLens.warningGutterIconPath: Absolute path for warning gutter icon.
  • errorLens.infoGutterIconPath: Absolute path for info gutter icon.
  • errorLens.errorGutterIconColor: Error color of circle gutter icon set.
  • errorLens.warningGutterIconColor: Warning color of circle gutter icon set.
  • errorLens.infoGutterIconColor: Info color of circle gutter icon set.
  • errorLens.followCursor: EXPERIMENTAL Highlight only portion of the problems. Possible values: "allLines", "activeLine", "closestProblem".
  • followCursorMore: EXPERIMENTAL Augments followCursor. Adds number of lines to top and bottom when followCursor is activeLine. Adds number of closest problems when followCursor is closestProblem

Commands

  • errorLens.toggle Temporarily Enable/Disable ErrorLens.
  • errorLens.toggleError Temporarily Enable/Disable Error level.
  • errorLens.toggleWarning Temporarily Enable/Disable Warning level.
  • errorLens.toggleInfo Temporarily Enable/Disable Info level.
  • errorLens.toggleHint Temporarily Enable/Disable Hint level.
  • errorLens.copyProblemMessage Copy problem message to clipboard (at the active line).

Extra

Example of using source & code or diagnostic message to exclude a problem:

"errorLens.exclude": [
    // Use source and code
    {
        "code": "6133",// is declared but its value is never read.
        "source": "ts",
    },
    // Use diagnostic message
    "Unknown configuration setting"
],

Remove built-in editor problem decorations (squiggly / double underline) from settings.json:

"workbench.colorCustomizations": {
    "editorError.border": "#fff0",
    "editorError.foreground": "#fff0",
    "editorWarning.border": "#fff0",
    "editorWarning.foreground": "#fff0",
    // ...
}