You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ Install into the same virtualenv as python-lsp-server itself.
23
23
24
24
Configuration
25
25
-------------
26
+
``pylsp-mypy`` supports the use of ``pyproject.toml`` for configuration. It can also be configuered using configs provided to the LSP server. The configuration keys are listed in the following.
26
27
27
28
.. list-table:: Configuration
28
29
:header-rows: 1
@@ -40,12 +41,12 @@ Configuration
40
41
* - ``dmypy``
41
42
- ``pylsp.plugins.pylsp_mypy.dmypy``
42
43
- ``boolean``
43
-
- **Executes via ``dmypy run`` rather than ``mypy``**. This uses the ``dmypy`` daemon and may dramatically improve the responsiveness of the ``pylsp`` server, however this currently does not work in ``live_mode``. Enabling this disables ``live_mode``, even for conflicting configs.
44
+
- **Executes via** ``dmypy run`` **rather than** ``mypy``. This uses the ``dmypy`` daemon and may dramatically improve the responsiveness of the ``pylsp`` server, however this currently does not work in ``live_mode``. Enabling this disables ``live_mode``, even for conflicting configs.
44
45
- false
45
46
* - ``strict``
46
47
- ``pylsp.plugins.pylsp_mypy.strict``
47
48
- ``boolean``
48
-
- **Refers to the ``strict`` option of ``mypy``**. This option often is too strict to be useful.
49
+
- **Refers to the** ``strict`` **option of** ``mypy``. This option often is too strict to be useful.
49
50
- false
50
51
* - ``overrides``
51
52
- ``pylsp.plugins.pylsp_mypy.overrides``
@@ -73,7 +74,7 @@ Configuration
73
74
- **A list of regular expressions which should be ignored**. The ``mypy`` runner wil not be invoked when a document path is matched by one of the expressions. Note that this differs from the ``exclude`` directive of a ``mypy`` config which is only used for recursively discovering files when mypy is invoked on a whole directory. For both windows or unix platforms you should use forward slashes (``/``) to indicate paths.
74
75
- ``[]``
75
76
76
-
This project supports the use of ``pyproject.toml`` for configuration. It is in fact the preferred way. Using that your configuration could look like this:
77
+
Using a ``pyproject.toml`` for configuration, which is in fact the preferred way, your configuration could look like this:
77
78
78
79
::
79
80
@@ -83,7 +84,7 @@ This project supports the use of ``pyproject.toml`` for configuration. It is in
83
84
strict = true
84
85
exclude = ["tests/*"]
85
86
86
-
A ``pyproject.toml`` does not conflict with the legacy config file given that it does not contain a ``pylsp-mypy`` section. The following explanation uses the syntax of the legacy config file. However, all these options also apply to the ``pyproject.toml`` configuration (note the lowercase bools).
87
+
A ``pyproject.toml`` does not conflict with the legacy config file (deprecated) given that it does not contain a ``pylsp-mypy`` section. The following explanation uses the syntax of the legacy config file (deprecated). However, all these options also apply to the ``pyproject.toml`` configuration (note the lowercase bools).
87
88
Depending on your editor, the configuration (found in a file called pylsp-mypy.cfg in your workspace or a parent directory) should be roughly like this for a standard configuration:
0 commit comments