id       = "helix"
name     = "Helix"
homepage = "https://helix-editor.com"
description = "A post-modern modal text editor."
icon     = "SimpleIcons:helix"
executables   = ["hx"]

[dotfiles]

# https://docs.helix-editor.com/configuration.html — "create a config.toml file
# located in your config directory": ~/.config/helix on Linux and macOS,
# %AppData%\helix on Windows — the XDG location on macOS too, which is
# [configHome]. languages.toml sits in the same directory
# (https://docs.helix-editor.com/languages.html) and user themes in themes/
# (https://docs.helix-editor.com/themes.html), so the directory is listed once.
paths = ["[configHome]/helix/"]

# The runtime directory holds fetched and compiled tree-sitter grammars and the
# queries shipped with them — build output, re-fetchable with `hx --grammar
# fetch`, and platform-specific shared objects at that.
exclude = [
  "[configHome]/helix/runtime/",
]

secret = []

# No machine_lines: config.toml, languages.toml and themes/ are editor
# preferences — theme, keymap, LSP settings — which is exactly what a user
# wants to follow them. A language server named there is resolved from PATH,
# not by absolute path.

[commands]
format = 1
label = "Edit with Helix"
description = "Open files in Helix or run its setup checks. Fetching or building grammars is covered; the api, bug and completion helpers are not."
quality = "ai-draft"
base = "fig:hx"
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/hx.ts"
license = "MIT"

[[commands.field]]
id = "files"
label = "Files"
description = "Files to open; file:line:col is not covered here."
type = "path"
position = 0
path = { kind = "file", role = "input" }
multiple = true
sources = ["fig"]

[[commands.field]]
id = "health"
label = "Health check"
description = "Check setup for one language (for example rust)."
type = "string"
option = ["--health"]
sources = ["fig"]

[[commands.field]]
id = "tutor"
label = "Open tutorial"
type = "boolean"
option = ["--tutor"]
sources = ["fig"]

[[commands.field]]
id = "grammar"
label = "Grammars"
type = "string"
option = ["--grammar", "-g"]
description = "Fetch or build tree-sitter grammars."
suggestions = [{ value = "fetch", label = "Fetch" }, { value = "build", label = "Build" }]
sources = ["fig"]

[[commands.field]]
id = "verbose"
label = "Verbosity"
type = "count"
option = ["-v"]
description = "Increase logging verbosity."
sources = ["fig"]

[[commands.task]]
id = "edit"
label = "Edit files"
fields = ["files"]
required = []

[[commands.task]]
id = "health"
label = "Check a language"
fields = ["health"]
required = ["health"]

[[commands.task]]
id = "tutor"
label = "Tutorial"
fields = ["tutor"]
required = []
set = { tutor = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["files", "health", "tutor"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["grammar", "verbose"]