id       = "micro"
name     = "micro"
homepage = "https://micro-editor.github.io"
description = "A terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of modern terminals."
# The mark-only version of the project's logo, from its repository.
icon     = "https://raw.githubusercontent.com/zyedidia/micro/master/assets/micro-logo-mark.svg"
executables   = ["micro"]

[dotfiles]

# internal/config/config.go, InitConfigDir(): $MICRO_CONFIG_HOME wins,
# otherwise $XDG_CONFIG_HOME/micro, otherwise homedir.Dir() + "/.config/micro".
# There is no platform branch — micro builds the same path on Windows — so
# ~/.config/micro/ is the only spelling. `help options` says the same:
# "Micro uses $MICRO_CONFIG_HOME as the configuration directory. If this
# environment variable is not set, it uses $XDG_CONFIG_HOME/micro instead."
#
# The directory holds settings.json, bindings.json, init.lua and the user's
# own colorschemes/ and syntax/ files.
paths = ["~/.config/micro/"]

# Everything micro generates for itself inside that directory:
# - plug/ is where `> plugin install` checks plugins out
#   (`help plugins`: "Plugins are stored in ~/.config/micro/plug").
# - buffers/ holds cursor positions, undo history and the command history
#   (`help options`, savecursor / savehistory: "~/.config/micro/buffers/",
#   "Information is saved to ~/.config/micro/buffers/history").
# - backups/ is the crash-recovery copy of every open buffer
#   (`help options`, backup: "Backups are stored in ~/.config/micro/backups").
exclude = [
  "~/.config/micro/plug/",
  "~/.config/micro/buffers/",
  "~/.config/micro/backups/",
]

# An editor's settings, key bindings and colour schemes. No credentials.
secret = []

# No machine_lines: colorscheme, tab width, key bindings and syntax overrides
# are the preferences a user wants everywhere. `backupdir` is the one path-like
# option, and it is empty by default and relative when set, so it is left to
# the consumer rather than guessed at here.

[commands]
format = 1
label = "Edit a file"
description = "Open a file in micro with a few settings overridden for this session. Plugin management and the remaining settings are left out."
quality = "ai-draft"
base = "fig:micro"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/micro.ts"
license = "MIT"

[[commands.field]]
id = "file"
label = "File"
type = "path"
position = 0
path = { kind = "file", role = "input" }
sources = ["fig"]

[[commands.field]]
id = "readonly"
label = "Read-only (true/false)"
type = "string"
option = ["--readonly"]
suggestions = [{ value = "true", label = "true" }, { value = "false", label = "false" }]
sources = ["fig"]

[[commands.field]]
id = "tabsize"
label = "Tab size"
type = "string"
option = ["--tabsize"]
suggestions = [{ value = "2", label = "2" }, { value = "4", label = "4" }, { value = "8", label = "8" }, { value = "16", label = "16" }]
sources = ["fig"]

[[commands.field]]
id = "tabstospaces"
label = "Tabs to spaces (true/false)"
type = "string"
option = ["--tabstospaces"]
suggestions = [{ value = "true", label = "true" }, { value = "false", label = "false" }]
sources = ["fig"]

[[commands.field]]
id = "softwrap"
label = "Soft wrap (true/false)"
type = "string"
option = ["--softwrap"]
suggestions = [{ value = "true", label = "true" }, { value = "false", label = "false" }]
sources = ["fig"]

[[commands.field]]
id = "colorscheme"
label = "Color scheme"
type = "string"
option = ["--colorscheme"]
suggestions = [{ value = "default", label = "default" }]
sources = ["fig"]

[[commands.field]]
id = "syntax"
label = "Syntax highlighting (true/false)"
type = "string"
option = ["--syntax"]
suggestions = [{ value = "true", label = "true" }, { value = "false", label = "false" }]
sources = ["fig"]

[[commands.field]]
id = "ruler"
label = "Line numbers (true/false)"
type = "string"
option = ["--ruler"]
suggestions = [{ value = "true", label = "true" }, { value = "false", label = "false" }]
sources = ["fig"]

[[commands.field]]
id = "mouse"
label = "Mouse support (true/false)"
type = "string"
option = ["--mouse"]
suggestions = [{ value = "true", label = "true" }, { value = "false", label = "false" }]
sources = ["fig"]

[[commands.field]]
id = "config_dir"
label = "Config directory"
type = "path"
option = ["--config-dir"]
path = { kind = "directory", role = "input" }
sources = ["fig"]

[[commands.field]]
id = "debug"
label = "Debug mode"
type = "boolean"
option = ["--debug"]
sources = ["fig"]

[[commands.task]]
id = "open"
label = "Open a file"
fields = ["file"]
required = ["file"]

[[commands.task]]
id = "readonly"
label = "Open read-only"
fields = ["file", "readonly"]
required = ["file", "readonly"]
set = { readonly = ["true"] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["file", "readonly", "tabsize", "tabstospaces", "softwrap"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["colorscheme", "syntax", "ruler", "mouse", "config_dir", "debug"]