Skip to content

Commit

Permalink
docs: update VSCode example (#444)
Browse files Browse the repository at this point in the history
* docs: update VSCode example

* docs: add back glspc
  • Loading branch information
llllvvuu authored Jul 3, 2024
1 parent a132bbb commit 5b55419
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/guide/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ the input read from STDIN, and the fixed output printed to STDOUT (ignoring
Start the language server providing IDE features over
`LSP <https://microsoft.github.io/language-server-protocol/>`__.
This command is only available if installed with the ``lsp`` extras (e.g.
``pip install fixit[lsp]``). See :ref:`IDE Integrations <ide_integrations>`
``pip install "fixit[lsp]"``). See :ref:`IDE Integrations <ide_integrations>`
for more details.

.. code:: console
Expand Down
17 changes: 7 additions & 10 deletions docs/guide/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,19 @@ IDE
Fixit can be used to lint as you type as well as to format files.

To get this functionality, install the ``lsp`` extras (e.g.
``pip install fixit[lsp]``) then set up an LSP client to launch and connect to
``pip install "fixit[lsp]"``) then set up an LSP client to launch and connect to
the Fixit LSP server. See the :ref:`lsp command <lsp_command>` for command
usage details.

Examples of client setup:

- VSCode: `Generic LSP Client <https://github.com/llllvvuu/vscode-glspc>`_:
- VSCode:

.. code:: json
{
"glspc.languageId": "python",
"glspc.serverCommand": "fixit",
"glspc.serverCommandArguments": ["lsp"],
"glspc.pathPrepend": "/path/to/python/3.11.4/bin/",
}
- `Generic LSP Client <https://github.com/llllvvuu/vscode-glspc>`_
(via GitHub; requires configuration)
- `Fixit (Unofficial) <https://marketplace.visualstudio.com/items?itemName=llllvvuu.fixit-unofficial>`_
(via VSCode Marketplace; compiled from Generic LSP Client with preset
configuration for Fixit)

- Neovim: `nvim-lspconfig <https://github.com/neovim/nvim-lspconfig>`_:

Expand Down

0 comments on commit 5b55419

Please sign in to comment.