Skip to content

Commit b75ebcf

Browse files
committed
Remove reference to pyls-flake8 in README
Internal plugin is preferred. Also expand configuration instructions for flake8 in README.
1 parent 9df6a9f commit b75ebcf

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Diff for: README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ pip install -U setuptools
4848

4949
Installing these plugins will add extra functionality to the language server:
5050

51-
- [pyls-flake8](https://github.com/emanspeaks/pyls-flake8/): Error checking using [flake8](https://flake8.pycqa.org/en/latest/).
5251
- [pylsp-mypy](https://github.com/Richardk2n/pylsp-mypy): [MyPy](http://mypy-lang.org/) type checking for Python >=3.7.
5352
- [pyls-isort](https://github.com/paradoxxxzero/pyls-isort): code formatting using [isort](https://github.com/PyCQA/isort) (automatic import sorting).
5453
- [python-lsp-black](https://github.com/python-lsp/python-lsp-black): code formatting using [Black](https://github.com/psf/black).
@@ -70,7 +69,11 @@ Like all language servers, configuration can be passed from the client that talk
7069
- `pycodestyle`: discovered in `~/.config/pycodestyle`, `setup.cfg`, `tox.ini` and `pycodestyle.cfg`.
7170
- `flake8`: discovered in `~/.config/flake8`, `setup.cfg`, `tox.ini` and `flake8.cfg`
7271

73-
The default configuration source is `pycodestyle`. Change the `pylsp.configurationSources` setting (in the value passed in from your client) to `['flake8']` in order to use the flake8 configuration instead.
72+
The default configuration source is `pycodestyle`. If you would like to use flake8, you will need to:
73+
74+
1. Disable `pycodestyle`, `mccabe`, and `pyflakes`, by setting their corresponding `enabled` configurations, e.g. `pylsp.plugins.pycodestyle.enabled`, to `false`. This will prevent duplicate linting messages as flake8 includes these tools.
75+
1. Set `pylsp.plugins.flake8.enabled` to `true`.
76+
1. Change the `pylsp.configurationSources` setting (in the value passed in from your client) to `['flake8']` in order to use the flake8 configuration instead.
7477

7578
The configuration options available in these config files (`setup.cfg` etc) are documented in the relevant tools:
7679

0 commit comments

Comments
 (0)