Add missing changelog entry for fmt: skip (#2025)

[etc/vim.git] / docs / editor_integration.md

diff --git a/docs/editor_integration.md b/docs/editor_integration.md
index 00241f233351d3275c9e06391c297b7836a31a3b..ae24c7688826cac549beee4549e7e7125a8b0b10 100644 (file)
--- a/docs/editor_integration.md
+++ b/docs/editor_integration.md
@@ -72,7 +72,9 @@ On Windows / Linux / BSD:
       - Output paths to refresh: `$FilePath$`
       - Working directory: `$ProjectFileDir$`
 
       - Output paths to refresh: `$FilePath$`
       - Working directory: `$ProjectFileDir$`
 

-   - Uncheck "Auto-save edited files to trigger the watcher" in Advanced Options
+   - In Advanced Options
+     - Uncheck "Auto-save edited files to trigger the watcher"
+     - Uncheck "Trigger the watcher on external changes"

 
 ## Wing IDE
 
 
 ## Wing IDE
 


@@ -109,6 +111,8 @@ $ black --help
 
 ## Vim
 
 
 ## Vim
 

+### Official plugin
+

 Commands and shortcuts:
 
 - `:Black` to format the entire file (ranges not supported);
 Commands and shortcuts:
 
 - `:Black` to format the entire file (ranges not supported);


@@ -121,6 +125,7 @@ Configuration:
 - `g:black_linelength` (defaults to `88`)
 - `g:black_skip_string_normalization` (defaults to `0`)
 - `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
 - `g:black_linelength` (defaults to `88`)
 - `g:black_skip_string_normalization` (defaults to `0`)
 - `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)

+- `g:black_quiet` (defaults to `0`)

 
 To install with [vim-plug](https://github.com/junegunn/vim-plug):
 
 
 To install with [vim-plug](https://github.com/junegunn/vim-plug):
 


@@ -146,7 +151,7 @@ or you can copy the plugin from
 
 ```
 mkdir -p ~/.vim/pack/python/start/black/plugin
 
 ```
 mkdir -p ~/.vim/pack/python/start/black/plugin

-curl https://raw.githubusercontent.com/psf/black/master/plugin/black.vim -o ~/.vim/pack/python/start/black/plugin/black.vim
+curl https://raw.githubusercontent.com/psf/black/stable/plugin/black.vim -o ~/.vim/pack/python/start/black/plugin/black.vim

 ```
 
 Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
 ```
 
 Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or


@@ -230,6 +235,47 @@ If you later want to update _Black_, you should do it like this:
 $ pip install -U black --no-binary regex,typed-ast
 ```
 
 $ pip install -U black --no-binary regex,typed-ast
 ```
 

+### With ALE
+
+1. Install [`ale`](https://github.com/dense-analysis/ale)
+2. Install `black`
+3. Add this to your vimrc:
+
+   ```vim
+   let g:ale_fixers = {}
+   let g:ale_fixers.python = ['black']
+   ```
+
+## Gedit
+
+gedit is the default text editor of the GNOME, Unix like Operating Systems. Open gedit
+as
+
+```console
+$ gedit <file_name>
+```
+
+1. `Go to edit > preferences > plugins`
+2. Search for `external tools` and activate it.
+3. In `Tools menu -> Manage external tools`
+4. Add a new tool using `+` button.
+5. Copy the below content to the code window.
+
+```console
+#!/bin/bash
+Name=$GEDIT_CURRENT_DOCUMENT_NAME
+black $Name
+```
+
+- Set a keyboard shortcut if you like, Ex. `ctrl-B`
+- Save: `Nothing`
+- Input: `Nothing`
+- Output: `Display in bottom pane` if you like.
+- Change the name of the tool if you like.
+
+Use your keyboard shortcut or `Tools -> External Tools` to use your new tool. When you
+close and reopen your File, _Black_ will be done with its job.
+

 ## Visual Studio Code
 
 Use the
 ## Visual Studio Code
 
 Use the


@@ -253,7 +299,12 @@ Sublime Text, Visual Studio Code and many more), you can use the
 
 ## Atom/Nuclide
 
 
 ## Atom/Nuclide
 

-Use [python-black](https://atom.io/packages/python-black).
+Use [python-black](https://atom.io/packages/python-black) or
+[formatters-python](https://atom.io/packages/formatters-python).
+
+## Gradle (the build tool)
+
+Use the [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) plugin.

 
 ## Kakoune
 
 
 ## Kakoune
 


@@ -269,9 +320,9 @@ hook global WinSetOption filetype=python %{
 
 Use [Thonny-black-code-format](https://github.com/Franccisco/thonny-black-code-format).
 
 
 Use [Thonny-black-code-format](https://github.com/Franccisco/thonny-black-code-format).
 

-## Other editors
+## Other integrations

 
 

-Other editors will require external contributions.
+Other editors and tools will require external contributions.

 
 Patches welcome! ✨ 🍰 ✨
 
 
 Patches welcome! ✨ 🍰 ✨