Errors and warnings

The shape of a Guchho diagnostic.

#

A diagnostic is a Message:

interface Message {
  id: string
  pluginName: string
  text: string
  location: Location | null
  notes: Note[]
  detail: any
}
interface Location {
  file: string
  namespace: string
  line: number        // 1-based
  column: number      // 0-based, in bytes
  length: number      // in bytes
  lineText: string
  suggestion: string
}

interface Note {
  text: string
  location: Location | null
}

pluginName is empty on a message the engine itself produced. detail is whatever a plugin put there, passed through untouched.

Where they appear

#
  • A build result carries errors and warnings arrays.
  • A failed build throws a BuildFailure, which carries the same two arrays.
  • A failure to reach the service throws a ServiceError, which is about the installation rather than the code.

A build with warnings is a build that worked; result.success reflects the errors list, not the warnings list.

See also

#

Edit this page on GitHub