micro.json

{
    "$comment": "https://github.com/micro-editor/micro",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "options",
    "description": "A micro editor config schema",
    "type": "object",
    "properties": {
        "autoindent": {
            "description": "Whether to use the same indentation as a previous line\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "autosave": {
            "description": "A delay between automatic saves\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "minimum": 0,
            "default": 0
        },
        "autosu": {
            "description": "Whether to attempt to use super user privileges\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "backup": {
            "description": "Whether to backup all open buffers\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "backupdir": {
            "description": "A directory to store backups\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": ""
        },
        "basename": {
            "description": "Whether to show a basename instead of a full path\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "clipboard": {
            "description": "A way to access the system clipboard\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "external",
                "terminal",
                "internal"
            ],
            "default": "external"
        },
        "colorcolumn": {
            "description": "A position to display a column\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "minimum": 0,
            "default": 0
        },
        "colorscheme": {
            "description": "A color scheme\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "atom-dark",
                "bubblegum",
                "cmc-16",
                "cmc-tc",
                "darcula",
                "default",
                "dracula-tc",
                "dukedark-tc",
                "dukelight-tc",
                "dukeubuntu-tc",
                "geany",
                "gotham",
                "gruvbox",
                "gruvbox-tc",
                "material-tc",
                "monokai-dark",
                "monokai",
                "one-dark",
                "railscast",
                "simple",
                "solarized",
                "solarized-tc",
                "sunny-day",
                "twilight",
                "zenburn"
            ],
            "default": "default"
        },
        "cursorline": {
            "description": "Whether to highlight a line with a cursor with a different color\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "detectlimit": {
            "description": "Number of first lines in a file that are matched to determine the filetype\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "default": 100
        },
        "diffgutter": {
            "description": "Whether to display diff indicators before lines\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "divchars": {
            "description": "Divider chars for vertical and horizontal splits\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "|-"
        },
        "divreverse": {
            "description": "Whether to use inversed color scheme colors for splits\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "encoding": {
            "description": "An encoding used to open and save files\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "utf-8"
        },
        "eofnewline": {
            "description": "Whether to add a missing trailing new line\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "fakecursor": {
            "description": "Whether to render the cursor using terminal colors instead of the actual terminal cursor\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "fastdirty": {
            "description": "Whether to use a fast algorithm to determine whether a file is changed\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "fileformat": {
            "description": "A line ending format\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "unix",
                "dos"
            ],
            "default": "unix"
        },
        "filetype": {
            "description": "A filetype for the current buffer\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "unknown"
        },
        "helpsplit": {
            "description": "A split type to be used by the `help` command\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "vsplit",
                "hsplit"
            ],
            "default": "hsplit"
        },
        "hlsearch": {
            "description": "Whether to highlight all instances of a searched text after a successful search\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "hltaberrors": {
            "description": "Whether to highlight tabs when spaces are expected, and spaces when tabs are expected\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "hltrailingws": {
            "description": "Whether to highlight trailing whitespaces at the end of lines\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "ignorecase": {
            "description": "Whether to perform case-insensitive searches\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "incsearch": {
            "description": "Whether to enable an incremental search in `Find` prompt\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "indentchar": {
            "description": "An indentation character\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "maxLength": 1,
            "default": " "
        },
        "infobar": {
            "description": "Whether to enable a line at the bottom where messages are printed\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "keepautoindent": {
            "description": "Whether to add a whitespace while using autoindent\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "keymenu": {
            "description": "Whether to display nano-style key menu at the bottom\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "lockbindings": {
            "description": "Whether to prevent plugins and lua scripts from binding any keys\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "matchbrace": {
            "description": "Whether to show matching braces\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "matchbraceleft": {
            "description": "Whether to also match the brace character to the left of the cursor when there is no brace character directly under the cursor\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "matchbracestyle": {
            "description": "Whether to underline or highlight matching braces\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "underline",
                "highlight"
            ],
            "default": "underline"
        },
        "mkparents": {
            "description": "Whether to create missing directories\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "mouse": {
            "description": "Whether to enable mouse support\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "multiopen": {
            "description": "A way to layout multiple files opened at startup\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "tab",
                "vsplit",
                "hsplit"
            ],
            "default": "tab"
        },
        "pageoverlap": {
            "description": "Number of lines from the current view to keep in view when paging up or down\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "default": 2
        },
        "parsecursor": {
            "description": "Whether to extract a line number and a column to open files with from file names\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "paste": {
            "description": "Whether to treat characters sent from the terminal in a single chunk as a paste event\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "permbackup": {
            "description": "Whether to permanently save backups\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "pluginchannels": {
            "description": "Plugin channels\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "description": "A file with list of plugin repositories\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
                "type": "string"
            },
            "default": [
                "https://raw.githubusercontent.com/micro-editor/plugin-channel/master/channel.json"
            ]
        },
        "pluginrepos": {
            "description": "Plugin repositories\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "description": "A plugin repository\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
                "type": "string"
            },
            "default": []
        },
        "readonly": {
            "description": "Whether to forbid buffer editing\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "relativeruler": {
            "description": "Whether to display relative line numbers\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "reload": {
            "description": "A reload behavior for the current buffer in case the file has changed\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "prompt",
                "auto",
                "disabled"
            ],
            "default": "prompt"
        },
        "rmtrailingws": {
            "description": "Whether to remove trailing whitespaces\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "ruler": {
            "description": "Whether to display line numbers\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "savecursor": {
            "description": "Whether to save cursor position in files\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "savehistory": {
            "description": "Whether to save command history between closing and re-opening editor\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "saveundo": {
            "description": "Whether to save undo after closing file\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "scrollbar": {
            "description": "Whether to display a scroll bar\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "scrollbarchar": {
            "description": "A character used for displaying the scrollbar\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "|"
        },
        "scrollmargin": {
            "description": "A margin at which a view starts scrolling when a cursor approaches an edge of a view\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "default": 3
        },
        "scrollspeed": {
            "description": "Line count to scroll for one scroll event\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "default": 2
        },
        "showchars": {
            "description": "Characters to be shown to display various invisible characters in the file\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": ""
        },
        "smartpaste": {
            "description": "Whether to add a leading whitespace while pasting multiple lines\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "softwrap": {
            "description": "Whether to wrap long lines\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "splitbottom": {
            "description": "Whether to create a new horizontal split below the current one\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "splitright": {
            "description": "Whether to create a new vertical split right of the current one\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "statusformatl": {
            "description": "Format string of left-justified part of the statusline\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "$(filename) $(modified)($(line),$(col)) $(status.paste)| ft:$(opt:filetype) | $(opt:fileformat) | $(opt:encoding)"
        },
        "statusformatr": {
            "description": "Format string of right-justified part of the statusline\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "$(bind:ToggleKeyMenu): bindings, $(bind:ToggleHelp): help"
        },
        "statusline": {
            "description": "Whether to display a status line\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "sucmd": {
            "description": "A super user command\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "default": "sudo",
            "examples": [
                "sudo",
                "doas"
            ]
        },
        "syntax": {
            "description": "Whether to enable a syntax highlighting\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "tabhighlight": {
            "description": "Whether to invert tab character colors\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "tabmovement": {
            "description": "Whether to navigate spaces at the beginning of lines as if they are tabs\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "tabreverse": {
            "description": "Whether to reverse tab bar colors\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "tabsize": {
            "description": "A tab size\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "integer",
            "default": 4
        },
        "tabstospaces": {
            "description": "Whether to use spaces instead of tabs\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "truecolor": {
            "description": "Whether to use true colors (24-bit colors) when using a colorscheme with true colors\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "string",
            "enum": [
                "auto",
                "on",
                "off"
            ],
            "default": "auto"
        },
        "useprimary": {
            "description": "Whether to use primary clipboard to copy selections in the background\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": true
        },
        "wordwrap": {
            "description": "Whether to wrap long lines by words\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        },
        "xterm": {
            "description": "Whether to assume that the current terminal is `xterm`\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}