Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Update and fix options in data/micro.json and runtime/help/options.md #3985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
omarelladen wants to merge 4 commits into micro-editor:master
base: master
Choose a base branch
Loading
from omarelladen:master
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 115 additions & 24 deletions data/micro.json
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"default": 0
},
"autosu": {
"description": "Whether attempt to use super user privileges\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"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
},
Expand Down Expand Up @@ -89,8 +89,13 @@
"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 inticators before lines\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"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
},
Expand All @@ -114,6 +119,11 @@
"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",
Expand All @@ -133,21 +143,40 @@
"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
},
"incsearch": {
"description": "Whether to enable an incremental search in `Find` prompt\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"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": true
"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",
Expand All @@ -160,7 +189,7 @@
"default": true
},
"keepautoindent": {
"description": "Whether add a whitespace while using autoindent\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"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
},
Expand All @@ -169,11 +198,21 @@
"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",
Expand All @@ -193,32 +232,54 @@
"type": "boolean",
"default": true
},
"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
"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": "A file with list of plugin channels\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"
"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 pluging repository\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"description": "A plugin repository\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"type": "string"
},
"default": []
Expand All @@ -228,6 +289,21 @@
"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",
Expand All @@ -238,11 +314,6 @@
"type": "boolean",
"default": true
},
"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
},
"savecursor": {
"description": "Whether to save cursor position in files\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"type": "boolean",
Expand All @@ -259,10 +330,15 @@
"default": false
},
"scrollbar": {
"description": "Whether to save undo after closing file\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"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",
Expand All @@ -273,6 +349,11 @@
"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",
Expand Down Expand Up @@ -322,13 +403,13 @@
"type": "boolean",
"default": true
},
"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",
"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
},
"tabhighlight": {
"description": "Whether to invert tab character colors\nhttps://github.com/micro-editor/micro/blob/master/runtime/help/options.md#options",
"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
},
Expand All @@ -347,6 +428,16 @@
"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",
Expand Down
8 changes: 5 additions & 3 deletions runtime/help/options.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Here are the available options:
A higher limit means better accuracy of guessing the filetype, but also
taking more time.

default value: `100`
default value: `100`

* `diffgutter`: display diff indicators before lines.

Expand Down Expand Up @@ -342,7 +342,7 @@ Here are the available options:
* `reload`: controls the reload behavior of the current buffer in case the file
has changed. The available options are `prompt`, `auto` & `disabled`.

default value: `prompt`
default value: `prompt`

* `rmtrailingws`: micro will automatically trim trailing whitespaces at ends of
lines.
Expand Down Expand Up @@ -500,7 +500,7 @@ Here are the available options:

Note: The change will take effect after the next start of `micro`.

default value: `auto`
default value: `auto`

* `useprimary` (only useful on unix): defines whether or not micro will use the
primary clipboard to copy selections in the background. This does not affect
Expand Down Expand Up @@ -591,6 +591,7 @@ so that you can see what the formatting should look like.
"keymenu": false,
"linter": true,
"literate": true,
"lockbindings": false,
"matchbrace": true,
"matchbraceleft": true,
"matchbracestyle": "underline",
Expand Down Expand Up @@ -633,6 +634,7 @@ so that you can see what the formatting should look like.
"tabreverse": false,
"tabsize": 4,
"tabstospaces": false,
"truecolor": "auto",
"useprimary": true,
"wordwrap": false,
"xterm": false
Expand Down

AltStyle によって変換されたページ (->オリジナル) /