Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
@cwebster-99
cwebster-99 authored Nov 13, 2023
1 parent 346f00a commit 966e4e5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Import sorting extension for Visual Studio Code using isort

A Visual Studio Code extension that provides import sorting for Python projects using isort. It uses the Language Server Protocol ([LSP](https://microsoft.github.io/language-server-protocol/)) to run `isort` in a server like mode.
A Visual Studio Code extension that provides import sorting for Python projects using isort. The extension uses the Language Server Protocol ([LSP](https://microsoft.github.io/language-server-protocol/)) to run `isort` in a server-like mode.

This extension ships with `isort=5.12.0`.

Expand Down Expand Up @@ -50,7 +50,7 @@ If you want to disable isort for your entire workspace or globally, you can [dis
| isort.severity | `{ "W": "Warning", "E": "Hint" }` | Mapping of isort's message types to VS Code's diagnostic severity levels as displayed in the Problems window. |
| isort.path | `[]` | Path of the isort binary to be used by this extension. Note: This may slow down formatting.<br> Examples: <br>- `isort.path : ["~/global_env/isort"]` <br> - `isort.path : ["conda", "run", "-n", "lint_env", "python", "-m", "isort"]` |
| isort.interpreter | `[]` | Path to a Python executable or a command that will be used to launch the isort server and any subprocess. Accepts an array of a single or multiple strings. When set to `[]`, the extension will use the path to the selected Python interpreter. |
| isort.importStrategy | `useBundled` | Defines which isort binary to be used to lint Python files. When set to `useBundled`, the extension will use the isort binary that is shipped with the extension. When set to `fromEnvironment`, the extension will attempt to use the isort binary and all dependencies that are available in the currently selected environment. Note: If the extension can't find a valid isort binary in the selected environment, it will fallback to using the isort binary that is shipped with the extension The `pylint.path` setting may also be ignored when this setting is set to `fromEnvironment`. |
| isort.importStrategy | `useBundled` | Defines which isort binary to be used to lint Python files. When set to `useBundled`, the extension will use the isort binary that is shipped with the extension. When set to `fromEnvironment`, the extension will attempt to use the isort binary and all dependencies that are available in the currently selected environment. Note: If the extension can't find a valid isort binary in the selected environment, it will fallback to using the isort binary that is shipped with the extension. The `isort.path` setting may also be ignored when this setting is set to `fromEnvironment`. |
| isort.showNotification | `off` | Controls when notifications are shown by this extension. Accepted values are `onError`, `onWarning`, `always` and `off`. |
| isort.serverEnabled | `true` | **Experimental** setting to control whether to run isort in a server-like mode. By default `isort` is run behind LSP server, but you can disable this setting to run isort directly. Disabling this setting will also disable import sorting via Code Actions or Organize Imports, but you can still sort imports through the **isort: Sort Imports** command. |

Expand Down
2 changes: 1 addition & 1 deletion package.nls.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"settings.severity.description": "Mapping of isort's message types to VS Code's diagnostic severity levels as displayed in the Problems window.",
"settings.serverEnabled.description" : "**Experimental** setting to control whether to run isort in a server-like mode. By default `isort` is run behind LSP server, but you can disable this setting to run isort directly. Disabling this setting will also disable import sorting via Code Actions or Organize Imports, but you can still sort imports through the **isort: Sort Imports** command.",
"settings.path.description": "Path of the isort binary to be used by this extension. Note: This may slow down formatting. <br> Examples: <br>- `isort.path : [\"~/global_env/isort\"]` <br> - `isort.path : [\"conda\", \"run\", \"-n\", \"lint_env\", \"python\", \"-m\", \"isort\"]`. ",
"settings.importStrategy.description": "Defines which isort binary to be used to lint Python files. When set to `useBundled`, the extension will use the isort binary that is shipped with the extension. When set to `fromEnvironment`, the extension will attempt to use the isort binary and all dependencies that are available in the currently selected environment. Note: If the extension can't find a valid isort binary in the selected environment, it will fallback to using the isort binary that is shipped with the extension The `pylint.path` setting may also be ignored when this setting is set to `fromEnvironment`. ",
"settings.importStrategy.description": "Defines which isort binary to be used to lint Python files. When set to `useBundled`, the extension will use the isort binary that is shipped with the extension. When set to `fromEnvironment`, the extension will attempt to use the isort binary and all dependencies that are available in the currently selected environment. Note: If the extension can't find a valid isort binary in the selected environment, it will fallback to using the isort binary that is shipped with the extension The `isort.path` setting may also be ignored when this setting is set to `fromEnvironment`. ",
"settings.importStrategy.useBundled.description": "Always use the bundled version of isort shipped with the extension.",
"settings.importStrategy.fromEnvironment.description": "Use isort from the selected environment. If the extension fails to find a valid isort binary, it will fallback to using the bundled version of isort.",
"settings.interpreter.description": "Path to a Python executable or a command that will be used to launch the isort server and any subprocess. Accepts an array of a single or multiple strings. When set to `[]`, the extension will use the path to the selected Python interpreter.",
Expand Down

0 comments on commit 966e4e5

Please sign in to comment.