kc/helix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
helix/book/src/generated/typable-cmd.md

84 lines
6.9 KiB
Markdown
Raw Normal View History

docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| Name | Description |
Auto generate docs for language support
2021-11-22 00:25:08 +05:30
| --- | --- |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:quit`, `:q` | Close the current view. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:quit!`, `:q!` | Force close the current view, ignoring unsaved changes. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:open`, `:o` | Open a file from disk into the current view. |
| `:buffer-close`, `:bc`, `:bclose` | Close the current buffer. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:buffer-close!`, `:bc!`, `:bclose!` | Close the current buffer forcefully, ignoring unsaved changes. |
Implement bulk buffer closing commands (#1677) * Implement buffer-close-all * Implement buffer-close-others * Refactor all buffer close variants to use shared logic * Fix clippy lint * Docgen for new commands * Shorten error message for attempting to close buffers that don't exist * Refactor shared buffer methods to pass only editor, not whole compositor * Switch signature of bulk buffer closing to use slice of DocumentIds Addresses feedback that accepting an IntoIterator implementor is too much for an internal. Also possibly saves some moving?
2022-02-28 20:31:24 -05:00
| `:buffer-close-others`, `:bco`, `:bcloseother` | Close all buffers but the currently focused one. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:buffer-close-others!`, `:bco!`, `:bcloseother!` | Force close all buffers but the currently focused one. |
| `:buffer-close-all`, `:bca`, `:bcloseall` | Close all buffers without quitting. |
| `:buffer-close-all!`, `:bca!`, `:bcloseall!` | Force close all buffers ignoring unsaved changes without quitting. |
| `:buffer-next`, `:bn`, `:bnext` | Goto next buffer. |
| `:buffer-previous`, `:bp`, `:bprev` | Goto previous buffer. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:write`, `:w` | Write changes to disk. Accepts an optional path (:write some/path.txt) |
Add wbc and wbc! commands (#6947)
2023-05-09 17:21:29 -03:00
| `:write!`, `:w!` | Force write changes to disk creating necessary subdirectories. Accepts an optional path (:write! some/path.txt) |
| `:write-buffer-close`, `:wbc` | Write changes to disk and closes the buffer. Accepts an optional path (:write-buffer-close some/path.txt) |
| `:write-buffer-close!`, `:wbc!` | Force write changes to disk creating necessary subdirectories and closes the buffer. Accepts an optional path (:write-buffer-close! some/path.txt) |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:new`, `:n` | Create a new scratch buffer. |
| `:format`, `:fmt` | Format the file using the LSP formatter. |
| `:indent-style` | Set the indentation style for editing. ('t' for tabs or 1-8 for number of spaces.) |
Replace line endings using `set_line_ending` command (#1871) * set_line_ending: now replace line endings * use ending.len_chars() directly * account for unicode-lines feaure in line-ending doc
2022-04-23 04:01:08 -04:00
| `:line-ending` | Set the document's default line ending. Options: crlf, lf. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:earlier`, `:ear` | Jump back to an earlier point in edit history. Accepts a number of steps or a time span. |
| `:later`, `:lat` | Jump to a later point in edit history. Accepts a number of steps or a time span. |
| `:write-quit`, `:wq`, `:x` | Write changes to disk and close the current view. Accepts an optional path (:wq some/path.txt) |
| `:write-quit!`, `:wq!`, `:x!` | Write changes to disk and close the current view forcefully. Accepts an optional path (:wq! some/path.txt) |
views -> buffers in write-all (#2788)
2022-06-16 18:09:30 -03:00
| `:write-all`, `:wa` | Write changes from all buffers to disk. |
| `:write-quit-all`, `:wqa`, `:xa` | Write changes from all buffers to disk and close all views. |
| `:write-quit-all!`, `:wqa!`, `:xa!` | Write changes from all buffers to disk and close all views forcefully (ignoring unsaved changes). |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:quit-all`, `:qa` | Close all views. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:quit-all!`, `:qa!` | Force close all views ignoring unsaved changes. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:cquit`, `:cq` | Quit with exit code (default 1). Accepts an optional integer exit code (:cq 2). |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:cquit!`, `:cq!` | Force quit with exit code (default 1) ignoring unsaved changes. Accepts an optional integer exit code (:cq! 2). |
commands: Make no arg ':theme' show name (#3740) Most commands that accept an argument show their current value if no argument is specified. The `:theme` command previously displayed an error message in the status bar if not provided with an argument: ``` Theme name not provided ``` It now shows the current theme name in the status bar if no argument is specified. Signed-off-by: James O. D. Hunt <jamesodhunt@gmail.com> Signed-off-by: James O. D. Hunt <jamesodhunt@gmail.com>
2022-10-26 03:59:50 +01:00
| `:theme` | Change the editor theme (show current theme if no name specified). |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:clipboard-yank` | Yank main selection into system clipboard. |
| `:clipboard-yank-join` | Yank joined selections into system clipboard. A separator can be provided as first argument. Default value is newline. |
| `:primary-clipboard-yank` | Yank main selection into system primary clipboard. |
| `:primary-clipboard-yank-join` | Yank joined selections into system primary clipboard. A separator can be provided as first argument. Default value is newline. |
| `:clipboard-paste-after` | Paste system clipboard after selections. |
| `:clipboard-paste-before` | Paste system clipboard before selections. |
| `:clipboard-paste-replace` | Replace selections with content of system clipboard. |
| `:primary-clipboard-paste-after` | Paste primary clipboard after selections. |
| `:primary-clipboard-paste-before` | Paste primary clipboard before selections. |
| `:primary-clipboard-paste-replace` | Replace selections with content of system primary clipboard. |
| `:show-clipboard-provider` | Show clipboard provider name in status bar. |
| `:change-current-directory`, `:cd` | Change the current working directory. |
| `:show-directory`, `:pwd` | Show the current working directory. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:encoding` | Set encoding. Based on `https://encoding.spec.whatwg.org`. |
Add :character-info command (#4000)
2023-02-03 08:24:46 -06:00
| `:character-info`, `:char` | Get info about the character under the primary cursor. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:reload` | Discard changes and reload from the source file. |
Add `:reload-all` command (#4663)
2022-11-20 18:39:26 +00:00
| `:reload-all` | Discard changes and reload all documents from the source files. |
make `:u` alias `:update` (#6835) * Gave the command update the alias u * Re added trailing newline * generated docs
2023-04-22 21:07:34 -05:00
| `:update`, `:u` | Write changes only if the file has been modified. |
Add LSP workspace command picker (#3140) * Add workspace command picker * Make command typable * Add optional argument to lsp-workspace-command
2022-11-09 10:17:09 +01:00
| `:lsp-workspace-command` | Open workspace command picker |
Adds support for multiple language servers per language. Language Servers are now configured in a separate table in `languages.toml`: ```toml [langauge-server.mylang-lsp] command = "mylang-lsp" args = ["--stdio"] config = { provideFormatter = true } [language-server.efm-lsp-prettier] command = "efm-langserver" [language-server.efm-lsp-prettier.config] documentFormatting = true languages = { typescript = [ { formatCommand ="prettier --stdin-filepath ${INPUT}", formatStdin = true } ] } ``` The language server for a language is configured like this (`typescript-language-server` is configured by default): ```toml [[language]] name = "typescript" language-servers = [ { name = "efm-lsp-prettier", only-features = [ "format" ] }, "typescript-language-server" ] ``` or equivalent: ```toml [[language]] name = "typescript" language-servers = [ { name = "typescript-language-server", except-features = [ "format" ] }, "efm-lsp-prettier" ] ``` Each requested LSP feature is priorized 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`). If no `except-features` or `only-features` is given all features for the language server are enabled, as long as the language server supports these. If it doesn't the next language server which supports the feature is tried. The list of supported features are: - `format` - `goto-definition` - `goto-declaration` - `goto-type-definition` - `goto-reference` - `goto-implementation` - `signature-help` - `hover` - `document-highlight` - `completion` - `code-action` - `workspace-command` - `document-symbols` - `workspace-symbols` - `diagnostics` - `rename-symbol` - `inlay-hints` Another side-effect/difference that comes with this PR, is that only one language server instance is started if different languages use the same language server.
2022-05-23 18:10:48 +02:00
| `:lsp-restart` | Restarts the language servers used by the currently opened file |
Allow LSP server to be stopped (#5964)
2023-03-08 01:34:31 +01:00
| `:lsp-stop` | Stops the Language Server that is in use by the current doc |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:tree-sitter-scopes` | Display tree sitter scopes, primarily for theming and development. |
Add new dap commands to docs (#1660)
2022-02-14 08:02:22 +05:30
| `:debug-start`, `:dbg` | Start a debug session from a given template with given parameters. |
| `:debug-remote`, `:dbg-tcp` | Connect to a debug adapter by TCP address and start a debugging session from a given template with given parameters. |
| `:debug-eval` | Evaluate expression in current debug context. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:vsplit`, `:vs` | Open the file in a vertical split. |
Add horizontal and vertical split scratch buffers (#1763) Make subcommand name more descriptive Fix vsplit completer Run cargo xtask docgen
2022-03-13 22:47:52 -04:00
| `:vsplit-new`, `:vnew` | Open a scratch buffer in a vertical split. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:hsplit`, `:hs`, `:sp` | Open the file in a horizontal split. |
Add horizontal and vertical split scratch buffers (#1763) Make subcommand name more descriptive Fix vsplit completer Run cargo xtask docgen
2022-03-13 22:47:52 -04:00
| `:hsplit-new`, `:hnew` | Open a scratch buffer in a horizontal split. |
docs: Auto generate command list
2021-11-17 19:00:11 +05:30
| `:tutor` | Open the tutorial. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:goto`, `:g` | Goto line number. |
feat: show current language when no argument is provided (#5895)
2023-02-16 15:48:35 +01:00
| `:set-language`, `:lang` | Set the language of current buffer (show current language if no value specified). |
Making the 'set-option' command help more descriptive. (#2365) * Making the 'set-option' command help more descriptive. * Adding the generated docs * Making the message multi-line * Replace newline with break in generated docs
2022-05-03 22:17:08 -04:00
| `:set-option`, `:set` | Set a config option at runtime.<br>For example to disable smart case search, use `:set search.smart-case false`. |
Add :toggle-option command (#4085) This command toggles the value of boolean options
2023-02-13 04:40:31 +02:00
| `:toggle-option`, `:toggle` | Toggle a boolean config option at runtime.<br>For example to toggle smart case search, use `:toggle search.smart-case`. |
Add :get-option command (#2231)
2022-04-24 03:30:18 -07:00
| `:get-option`, `:get` | Get the current value of a config option. |
feat(commands): sort command (#1288) * feat(commands): sort/rsort command Add basic implementation of sort command. * Sort by selections instead, implement reverse sort * Generate docs * Rename sort! to rsort
2021-12-27 05:11:06 +01:00
| `:sort` | Sort ranges in selection. |
| `:rsort` | Sort ranges in selection in reverse order. |
add reflow command (#2128) * add reflow command Users need to be able to hard-wrap text for many applications, including comments in code, git commit messages, plaintext documentation, etc. It often falls to the user to manually insert line breaks where appropriate in order to hard-wrap text. This commit introduces the "reflow" command (both in the TUI and core library) to automatically hard-wrap selected text to a given number of characters (defined by Unicode "extended grapheme clusters"). It handles lines with a repeated prefix, such as comments ("//") and indentation. * reflow: consider newlines to be word separators * replace custom reflow impl with textwrap crate * Sync reflow command docs with book * reflow: add default max_line_len language setting Co-authored-by: Vince Mutolo <vince@mutolo.org>
2022-05-02 10:24:22 -04:00
| `:reflow` | Hard-wrap the current selection of lines to a given width. |
change show_subtree command into ':tree-sitter-subtree' typable command (#1524) * add default keymap for show_subtree command * remove space+t keymap * add a typable command ':show-subtree' * generate documentation for ':show-subtree' * remove non-typable show_subtree command * ':show-subtree'->':tree-sitter-subtree'
2022-01-21 08:15:35 -06:00
| `:tree-sitter-subtree`, `:ts-subtree` | Display tree sitter subtree under cursor, primarily for debugging queries. |
Shorten embedded command descriptions (#3070) * Shorten embedded command descriptions - Compact descriptions in command palette and infobox * Shorten typed command descriptions * Fix typo in decrement command description
2022-07-26 08:34:23 +05:30
| `:config-reload` | Refresh user config. |
| `:config-open` | Open the user config.toml file. |
add workspace config and manual LSP root management fixup documentation Co-authored-by: LeoniePhiline <22329650+LeoniePhiline@users.noreply.github.com> fixup typo Co-authored-by: LeoniePhiline <22329650+LeoniePhiline@users.noreply.github.com>
2023-01-31 00:31:21 +01:00
| `:config-open-workspace` | Open the workspace config.toml file. |
feat(commands): add log-open command (#2422)
2022-05-11 03:18:45 +02:00
| `:log-open` | Open the helix log file. |
fix `:insert-output` doc: inserting output **before** each selection (#4286)
2022-10-16 00:07:42 +08:00
| `:insert-output` | Run shell command, inserting output before each selection. |
Add shell insert commands to typable and config (#2589) * Add shell insert commands to typable and config * generate docs Co-authored-by: Dean Revell <revell@gmail.com>
2022-06-05 11:52:41 +01:00
| `:append-output` | Run shell command, appending output after each selection. |
Pipe typable command (#1972) Co-authored-by: DeviousStoat <devious@stoat.com>
2022-04-17 05:03:47 +02:00
| `:pipe` | Pipe each selection to the shell command. |
Add `:pipe-to` typable command that ignores shell output (#4931)
2022-12-12 03:06:24 +01:00
| `:pipe-to` | Pipe each selection to the shell command, ignoring output. |
Add run-shell-command for Commands (#1682) * add run_shell_command * docgen * fix command name Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> * refactored Info::new * show 'Command failed' if execution fails * TypedCommand takes care of error handling and printing the error to the statusline. * docgen * use Popup instead of autoinfo * remove to_string in format! * Revert chage in info.rs * Show "Command succeed" when success * Fix info.rs Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
2022-05-02 23:15:02 +09:00
| `:run-shell-command`, `:sh` | Run a shell command |
Add command for resetting diff hunks (#5736)
2023-03-08 02:49:14 +01:00
| `:reset-diff-change`, `:diffget`, `:diffg` | Reset the diff change at the cursor position. |
feat(commands): add clear-register typable command (#5695) Co-authored-by: Jorge <chorcheus@tutanota.com>
2023-04-27 21:57:05 +02:00
| `:clear-register` | Clear given register. If no argument is provided, clear all registers. |
Reference in a new issue Copy permalink