actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md - Pycharm instructions not working for files path containing white spaces (#659)

Browse Source
This commit is contained in:
Heaford 2019-03-14 16:10:49 +00:00 committed by Łukasz Langa
parent 6b381c784b
commit cfa2557df0
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -638,21 +638,29 @@ $ where black
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location
``` ```
3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`. 3. Open External tools in PyCharm
On macOS:
```PyCharm -> Preferences -> Tools -> External Tools```
On Windows / Linux / BSD:
```File -> Settings -> Tools -> External Tools```
4. Click the + icon to add a new external tool with the following values: 4. Click the + icon to add a new external tool with the following values:
- Name: Black - Name: Black
- Description: Black is the uncompromising Python code formatter. - Description: Black is the uncompromising Python code formatter.
- Program: <install_location_from_step_2> - Program: <install_location_from_step_2>
- Arguments: `$FilePath$` - Arguments: `"$FilePath$"`
5. Format the currently opened file by selecting `Tools -> External Tools -> black`. 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
- Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`. - Alternatively, you can set a keyboard shortcut by navigating to `Preferences or Settings -> Keymap -> External Tools -> External Tools - Black`.
6. Optionally, run Black on every file save: 6. Optionally, run Black on every file save:
1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed. 1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed.
2. Go to `Preferences -> Tools -> File Watchers` and click `+` to add a new watcher: 2. Go to `Preferences or Settings -> Tools -> File Watchers` and click `+` to add a new watcher:
- Name: Black - Name: Black
- File type: Python - File type: Python
- Scope: Project Files - Scope: Project Files