package asai

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package asai

asai
- Asai
  - Diagnostic
  - Explication
  - Explicator
    
    Make
    
    Tag
    
    S
    
    Tag
    
    Tag
  - GitHub
    
    Make
    
    Message
  - Range
  - Reporter
    
    Make
    
    Message
    
    Message
    
    S
    
    Message
  - SourceReader
  - StructuredReporter
    
    Make
    
    Message
    
    Message
    
    S
    
    Message
  - Tty
    
    Make
    
    Message

Legend:
Library
Module
Module type
Parameter
Class
Class type

This module provides functions to display or interact with diagnostics in UNIX terminals.

Parameters

module Message : Reporter.Message

Signature

val display : 
  ?terminal_capacity:Notty.Cap.t ->
  ?output:out_channel ->
  ?show_backtrace:bool ->
  ?line_breaking:[ `Unicode | `Traditional ] ->
  ?block_splitting_threshold:int ->
  ?tab_size:int ->
  Message.t Diagnostic.t ->
  unit

display d prints the diagnostic d to the standard output, using terminal control characters for formatting. A message will look like this (but with coloring):

 ￫ warning[hello]
 ╭ ￭ /path/to/file.cool
 ┆ 1 | aaaaaaaaaa
 ┆ 2 | bbbbbbbbbb
 ╯   ^ when stepping into the abyss
 ￭ /path/to/file.cool
 2 | bbbbbbbbbb
 3 | cccccccccc
   ^ could not say hi here

parameter terminal_capacity
Control whether ANSI escape sequences should be used, overwriting the auto-detection. Possible values are Notty.Cap.ansi for using ANSI escape sequences strings and Notty.Cap.dumb for not using them. Note that this handler uses exclusively ANSI escape sequences for highlighting, which means turning them off will lose the precise location.

parameter output
The output channel, such as stdout and stderr. By default, it is stdout, the standard output.

parameter show_backtrace
Whether the backtrace should be shown. The default is true.

parameter line_breaking
The algorithm to recognize (hard) line breaks. The `Unicode algorithm recognizes all Unicode character sequences in Unicode 15.0.0 Table 5-1 as line breaks. The `Traditional algorithm only recognizes U+000A (LF), U+000D (CR), and U+000D U+000A (CRLF) as line breaks. The default is the `Traditional algorithm.

parameter block_splitting_threshold
The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is 5.

parameter tab_size
The number of spaces that should be used to replace a horizontal tab. Note that a horizontal tab is always expanded to the same number of spaces. The result should still be visually appealing as long as horizontal tabs are only used at the beginning of lines. The default value is 8.

raises Invalid_argument
if tab_size < 0.