Documentation

Add a segment to the current Report logging context.

Set the current Report logging context.

Convert a value to Report via Reportable and send it to the log.

Send a Report to the log given a user and log message, with serverity Info.

Send a Report to the log given a user and log message, with serverity Warn.

Send a Report to the log given a user and log message, with serverity Error.

Eliminate Stop err by converting err to a Report and logging it, continuing execution for a unit action.

Resume an effect by converting the error to a Report and logging it, continuing execution for a unit action.

Resume all plugin effects.

Get all reports.

Add a report to the store.

This internal effect stores all errors in memory that have been created through the Report system.

The type used by request handlers and expected by the RPC dispatcher.

An report with different messages intended to be sent to Neovim and the log, respectively.

Used by request handlers and expected by the RPC dispatcher.

Also contains the Severity of the report, or minimum log level, which determines whether the report should be logged and echoed in Neovim, and what kind of highlighting should be used in Neovim (red for errors, orange for warnings, none for infomrational errors).

The log message may span multiple lines.

The provenance of a report, for use in logs.

The class of types that are convertible to a Report.

This is used to create a uniform format for handlers, since control flow is passed on to the internal machinery when they return. If an error would be thrown that is not caught by the request dispatcher, the entire plugin would stop, so all Stop and Resumable effects need to be converted to Report before returning (see Errors).

The combinators associated with this class make this task a little less arduous:

data NumbersError = InvalidNumber

instance Reportable NumbersError where
  toReport InvalidNumber = Report "Invalid number!" ["The user entered an invalid number"] Warn

count :: Int -> Sem r Int
count i =
  resumeReport @Rpc $ mapReport @NumbersError do
    when (i == 0) (stop InvalidNumber)
    nvimGetVar ("number_" <> show i)

Here resumeReport converts a potential RpcError from nvimGetVar to Report (e.g. if the variable is not set), while mapReport uses the instance Reportable NumbersError to convert the call to stop.