From 2244a5d40c83d477839f91cb6d6a4aeb02446a97 Mon Sep 17 00:00:00 2001 From: omentic Date: Wed, 1 May 2024 23:29:52 +0000 Subject: deploy: 12eec890240a05d1e090114f7f4fdd7c1ee8ff88 --- languages.html | 92 +++++++++++++++++++++++++++++++--------------------------- 1 file changed, 49 insertions(+), 43 deletions(-) (limited to 'languages.html') diff --git a/languages.html b/languages.html index 2748ab32..15f89f67 100644 --- a/languages.html +++ b/languages.html @@ -197,10 +197,10 @@ auto-LSP-formatting in Rust:

# in <config_dir>/helix/languages.toml
 
 [language-server.mylang-lsp]
-command = "mylang-lsp"
+command = "mylang-lsp"
 
 [[language]]
-name = "rust"
+name = "rust"
 auto-format = false
@@ -215,14 +215,14 @@ in the configuration directory and the built-in configuration.

Each language is configured by adding a [[language]] section to a languages.toml file. For example:

[[language]]
-name = "mylang"
-scope = "source.mylang"
-injection-regex = "mylang"
-file-types = ["mylang", "myl"]
-comment-token = "#"
-indent = { tab-width = 2, unit = "  " }
-formatter = { command = "mylang-formatter" , args = ["--stdin"] }
-language-servers = [ "mylang-lsp" ]
+name = "mylang"
+scope = "source.mylang"
+injection-regex = "mylang"
+file-types = ["mylang", "myl"]
+comment-tokens = "#"
+indent = { tab-width = 2, unit = "  " }
+formatter = { command = "mylang-formatter" , args = ["--stdin"] }
+language-servers = [ "mylang-lsp" ]

These configuration keys are available:

@@ -230,18 +230,21 @@ language-servers = [ "mylang-lsp" ] - - + + - - + + + + +
KeyDescription
language-idThe language-id for language servers, checkout the table at TextDocumentItem for the right id
scopeA string like source.js that identifies the language. Currently, we strive to match the scope names used by popular TextMate grammars and by the Linguist library. Usually source.<name> or text.<name> in case of markup languages
injection-regexregex pattern that will be tested against a language name in order to determine whether this language should be used for a potential language injection site.
file-typesThe filetypes of the language, for example ["yml", "yaml"]. See the file-type detection section below.
shebangsThe interpreters from the shebang line, for example ["sh", "bash"]
file-typesThe filetypes of the language, for example ["yml", "yaml"]. See the file-type detection section below.
shebangsThe interpreters from the shebang line, for example ["sh", "bash"]
rootsA set of marker files to look for when trying to find the workspace root. For example Cargo.lock, yarn.lock
auto-formatWhether to autoformat this language when saving
diagnostic-severityMinimal severity of diagnostic for it to be displayed. (Allowed values: Error, Warning, Info, Hint)
comment-tokenThe token to use as a comment-token
indentThe indent to use. Has sub keys unit (the text inserted into the document when indenting; usually set to N spaces or "\t" for tabs) and tab-width (the number of spaces rendered for a tab)
comment-tokensThe tokens to use as a comment token, either a single token "//" or an array ["//", "///", "//!"] (the first token will be used for commenting). Also configurable as comment-token for backwards compatibility
block-comment-tokensThe start and end tokens for a multiline comment either an array or single table of { start = "/*", end = "*/"}. The first set of tokens will be used for commenting, any pairs in the array can be uncommented
indentThe indent to use. Has sub keys unit (the text inserted into the document when indenting; usually set to N spaces or "\t" for tabs) and tab-width (the number of spaces rendered for a tab)
language-serversThe Language Servers used for this language. See below for more information in the section Configuring Language Servers for a language
grammarThe tree-sitter grammar to use (defaults to the value of name)
formatterThe formatter for the language, it will take precedence over the lsp when defined. The formatter must be able to take the original file as input from stdin and write the formatted file to stdout
soft-wrapeditor.softwrap
text-widthMaximum line length. Used for the :reflow command and soft-wrapping if soft-wrap.wrap-at-text-width is set, defaults to editor.text-width
workspace-lsp-rootsDirectories relative to the workspace root that are treated as LSP roots. Should only be set in .helix/config.toml. Overwrites the setting of the same name in config.toml if set.
persistent-diagnostic-sourcesAn array of LSP diagnostic sources assumed unchanged when the language server resends the same set of diagnostics. Helix can track the position for these diagnostics internally instead. Useful for diagnostics that are recomputed on save.
rulersOverrides the editor.rulers config key for the language.
rainbow-bracketsOverrides the editor.rainbow-brackets config key for the language.
@@ -250,39 +253,41 @@ language-servers = [ "mylang-lsp" ]

Helix determines which language configuration to use based on the file-types key from the above section. file-types is a list of strings or tables, for example:

-
file-types = ["Makefile", "toml", { suffix = ".git/config" }]
+
file-types = ["toml", { glob = "Makefile" }, { glob = ".git/config" }, { glob = ".github/workflows/*.yaml" } ]
 

 
When determining a language configuration to use, Helix searches the file-types
 with the following priorities:

 
    
-
  1. Exact match: if the filename of a file is an exact match of a string in a
-file-types list, that language wins. In the example above, "Makefile"
-will match against Makefile files.
    2. 
-
  2. Extension: if there are no exact matches, any file-types string that
-matches the file extension of a given file wins. In the example above, the
-"toml" matches files like Cargo.toml or languages.toml.
    3. 
-
  3. Suffix: if there are still no matches, any values in suffix tables
-are checked against the full path of the given file. In the example above,
-the { suffix = ".git/config" } would match against any config files
-in .git directories. Note: / is used as the directory separator but is
-replaced at runtime with the appropriate path separator for the operating
-system, so this rule would match against .git\config files on Windows.
    4. 
+
  4. Glob: values in glob tables are checked against the full path of the given
+file. Globs are standard Unix-style path globs (e.g. the kind you use in Shell)
+and can be used to match paths for a specific prefix, suffix, directory, etc.
+In the above example, the { glob = "Makefile" } config would match files
+with the name Makefile, the { glob = ".git/config" } config would match
+config files in .git directories, and the { glob = ".github/workflows/*.yaml" }
+config would match any yaml files in .github/workflow directories. Note
+that globs should always use the Unix path separator / even on Windows systems;
+the matcher will automatically take the machine-specific separators into account.
+If the glob isn't an absolute path or doesn't already start with a glob prefix,
+*/ will automatically be added to ensure it matches for any subdirectory.
    5. 
+
  5. Extension: if there are no glob matches, any file-types string that matches
+the file extension of a given file wins. In the example above, the "toml"
+config matches files like Cargo.toml or languages.toml.
    6. 
 

 
Language Server configuration

 
Language servers are configured separately in the table language-server in the same file as the languages languages.toml

 
For example:

 
[language-server.mylang-lsp]
-command = "mylang-lsp"
-args = ["--stdio"]
+command = "mylang-lsp"
+args = ["--stdio"]
 config = { provideFormatter = true }
-environment = { "ENV1" = "value1", "ENV2" = "value2" }
+environment = { "ENV1" = "value1", "ENV2" = "value2" }
 
 [language-server.efm-lsp-prettier]
-command = "efm-langserver"
+command = "efm-langserver"
 
 [language-server.efm-lsp-prettier.config]
 documentFormatting = true
-languages = { typescript = [ { formatCommand ="prettier --stdin-filepath ${INPUT}", formatStdin = true } ] }
+languages = { typescript = [ { formatCommand ="prettier --stdin-filepath ${INPUT}", formatStdin = true } ] }
 

 
These are the available options for a language server.

 

@@ -290,15 +295,16 @@ languages = { typescript = [ { formatCommand ="prettier --stdin-filepath ${
 
-
+
+
KeyDescription
argsA list of arguments to pass to the language server binary

 
configLSP initialization options

 
timeoutThe maximum time a request to the language server may take, in seconds. Defaults to 20
environmentAny environment variables that will be used when starting the language server { "KEY1" = "Value1", "KEY2" = "Value2" }
environmentAny environment variables that will be used when starting the language server { "KEY1" = "Value1", "KEY2" = "Value2" }
required-root-patternsA list of glob patterns to look for in the working directory. The language server is started if at least one of them is found.

 

 

 
A format sub-table within config can be used to pass extra formatting options to
 Document Formatting Requests.
 For example, with typescript:

 
[language-server.typescript-language-server]
-# pass format options according to https://github.com/typescript-language-server/typescript-language-server#workspacedidchangeconfiguration omitting the "[language].format." prefix.
-config = { format = { "semicolons" = "insert", "insertSpaceBeforeFunctionParenthesis" = true } }
+# pass format options according to https://github.com/typescript-language-server/typescript-language-server#workspacedidchangeconfiguration omitting the "[language].format." prefix.
+config = { format = { "semicolons" = "insert", "insertSpaceBeforeFunctionParenthesis" = true } }
 

 
Configuring Language Servers for a language

 
The language-servers attribute in a language tells helix which language servers are used for this language.

@@ -310,13 +316,13 @@ it's often useful to only enable/disable certain language-server features for th
 so everything else should be handled by the typescript-language-server (which is configured by default).
 The language configuration for typescript could look like this:

 
[[language]]
-name = "typescript"
-language-servers = [ { name = "efm-lsp-prettier", only-features = [ "format" ] }, "typescript-language-server" ]
+name = "typescript"
+language-servers = [ { name = "efm-lsp-prettier", only-features = [ "format" ] }, "typescript-language-server" ]
 

 
or equivalent:

 
[[language]]
-name = "typescript"
-language-servers = [ { name = "typescript-language-server", except-features = [ "format" ] }, "efm-lsp-prettier" ]
+name = "typescript"
+language-servers = [ { name = "typescript-language-server", except-features = [ "format" ] }, "efm-lsp-prettier" ]
 

 
Each requested LSP feature is prioritized in the order of the language-servers array.
 For example, the first goto-definition supported language server (in this case typescript-language-server) will be taken for the relevant LSP request (command goto_definition).
@@ -347,8 +353,8 @@ If a language server itself doesn't support a feature, the next language server
 
The source for a language's tree-sitter grammar is specified in a [[grammar]]
 section in languages.toml. For example:

 
[[grammar]]
-name = "mylang"
-source = { git = "https://github.com/example/mylang", rev = "a250c4582510ff34767ec3b7dcdd3c24e8c8aa68" }
+name = "mylang"
+source = { git = "https://github.com/example/mylang", rev = "a250c4582510ff34767ec3b7dcdd3c24e8c8aa68" }
 

 
Grammar configuration takes these keys:

 

@@ -368,9 +374,9 @@ git repository:
You may use a top-level use-grammars key to control which grammars are
 fetched and built when using hx --grammar fetch and hx --grammar build.
# Note: this key must come **before** the [[language]] and [[grammar]] sections
-use-grammars = { only = [ "rust", "c", "cpp" ] }
+use-grammars = { only = [ "rust", "c", "cpp" ] }
 # or
-use-grammars = { except = [ "yaml", "json" ] }
+use-grammars = { except = [ "yaml", "json" ] }
 
When omitted, all grammars are fetched and built.

 
-- 
cgit v1.2.3-70-g09d2


KeyDescription