Skip to content

Commit

Permalink
docs: Eliminate improper use of "LSP" term
Browse files Browse the repository at this point in the history
Sometimes we used "LSP" to mean "language server". This change
eliminates the improper "LSP" usage.

Ref helix-editor#12183 (comment)
  • Loading branch information
the-mikedavis committed Dec 3, 2024
1 parent fa68bac commit 085c4fe
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion book/src/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The following statusline elements can be configured:

[^1]: By default, a progress spinner is shown in the statusline beside the file path.

[^2]: You may also have to activate them in the LSP config for them to appear, not just in Helix. Inlay hints in Helix are still being improved on and may be a little bit laggy/janky under some circumstances. Please report any bugs you see so we can fix them!
[^2]: You may also have to activate them in the language server config for them to appear, not just in Helix. Inlay hints in Helix are still being improved on and may be a little bit laggy/janky under some circumstances. Please report any bugs you see so we can fix them!

### `[editor.cursor-shape]` Section

Expand Down
2 changes: 1 addition & 1 deletion book/src/generated/lang-support.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Default LSP |
| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Default language servers |
| --- | --- | --- | --- | --- |
| ada ||| | `ada_language_server` |
| adl |||| |
Expand Down
2 changes: 1 addition & 1 deletion book/src/generated/typable-cmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| `: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) |
| `:new`, `:n` | Create a new scratch buffer. |
| `:format`, `:fmt` | Format the file using the LSP formatter. |
| `:format`, `:fmt` | Format the file using an external formatter or language server. |
| `:indent-style` | Set the indentation style for editing. ('t' for tabs or 1-16 for number of spaces.) |
| `:line-ending` | Set the document's default line ending. Options: crlf, lf. |
| `:earlier`, `:ear` | Jump back to an earlier point in edit history. Accepts a number of steps or a time span. |
Expand Down
4 changes: 2 additions & 2 deletions book/src/languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are three possible locations for a `languages.toml` file:

2. In your [configuration directory](./configuration.md). This overrides values
from the built-in language configuration. For example, to disable
auto-LSP-formatting in Rust:
auto-formatting for Rust:

```toml
# in <config_dir>/helix/languages.toml
Expand Down Expand Up @@ -128,7 +128,7 @@ These are the available options for a language server.
| ---- | ----------- |
| `command` | The name or path of the language server binary to execute. Binaries must be in `$PATH` |
| `args` | A list of arguments to pass to the language server binary |
| `config` | LSP initialization options |
| `config` | Language server initialization options |
| `timeout` | The maximum time a request to the language server may take, in seconds. Defaults to `20` |
| `environment` | Any environment variables that will be used when starting the language server `{ "KEY1" = "Value1", "KEY2" = "Value2" }` |
| `required-root-patterns` | A list of `glob` patterns to look for in the working directory. The language server is started if at least one of them is found. |
Expand Down
2 changes: 1 addition & 1 deletion book/src/pickers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Helix has a variety of pickers, which are interactive windows used to select var

### Filtering Picker Results

Most pickers perform fuzzy matching using [fzf syntax](https://github.com/junegunn/fzf?tab=readme-ov-file#search-syntax). Two exceptions are the global search picker, which uses regex, and the workspace symbol picker, which passes search terms to the LSP. Note that OR operations (`|`) are not currently supported.
Most pickers perform fuzzy matching using [fzf syntax](https://github.com/junegunn/fzf?tab=readme-ov-file#search-syntax). Two exceptions are the global search picker, which uses regex, and the workspace symbol picker, which passes search terms to the language server. Note that OR operations (`|`) are not currently supported.

If a picker shows multiple columns, you may apply the filter to a specific column by prefixing the column name with `%`. Column names can be shortened to any prefix, so `%p`, `%pa` or `%pat` all mean the same as `%path`. For example, a query of `helix %p .toml !lang` in the global search picker searches for the term "helix" within files with paths ending in ".toml" but not including "lang".

Expand Down
4 changes: 2 additions & 2 deletions book/src/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,8 +309,8 @@ These scopes are used for theming the editor interface:
| `ui.virtual.whitespace` | Visible whitespace characters |
| `ui.virtual.indent-guide` | Vertical indent width guides |
| `ui.virtual.inlay-hint` | Default style for inlay hints of all kinds |
| `ui.virtual.inlay-hint.parameter` | Style for inlay hints of kind `parameter` (LSPs are not required to set a kind) |
| `ui.virtual.inlay-hint.type` | Style for inlay hints of kind `type` (LSPs are not required to set a kind) |
| `ui.virtual.inlay-hint.parameter` | Style for inlay hints of kind `parameter` (language servers are not required to set a kind) |
| `ui.virtual.inlay-hint.type` | Style for inlay hints of kind `type` (language servers are not required to set a kind) |
| `ui.virtual.wrap` | Soft-wrap indicator (see the [`editor.soft-wrap` config][editor-section]) |
| `ui.virtual.jump-label` | Style for virtual jump labels |
| `ui.menu` | Code and command completion menus |
Expand Down
2 changes: 1 addition & 1 deletion helix-term/src/commands/typed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2636,7 +2636,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
TypableCommand {
name: "format",
aliases: &["fmt"],
doc: "Format the file using the LSP formatter.",
doc: "Format the file using an external formatter or language server.",
fun: format,
signature: CommandSignature::none(),
},
Expand Down
2 changes: 1 addition & 1 deletion helix-term/src/health.rs
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ pub fn languages_all() -> std::io::Result<()> {
}
};

let mut headings = vec!["Language", "LSP", "DAP", "Formatter"];
let mut headings = vec!["Language", "Language servers", "Debug adapter", "Formatter"];

for feat in TsFeature::all() {
headings.push(feat.short_title())
Expand Down
2 changes: 1 addition & 1 deletion xtask/src/docgen.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ pub fn lang_features() -> Result<String, DynError> {
.map(|t| t.long_title().to_string())
.collect::<Vec<_>>(),
);
cols.push("Default LSP".to_owned());
cols.push("Default language servers".to_owned());

md.push_str(&md_table_heading(&cols));
let config = helpers::lang_config();
Expand Down

0 comments on commit 085c4fe

Please sign in to comment.