Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update VSCode example #444

Merged
merged 2 commits into from
Jul 3, 2024
Merged

docs: update VSCode example #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c822b0a
docs: update VSCode example
llllvvuu Apr 21, 2024
0d348cd
docs: add back glspc
llllvvuu Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guide/commands.rst
View file
Open in desktop
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
View file
Open in desktop
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
Loading