]> git.madduck.net Git - etc/vim.git/blobdiff - docs/editor_integration.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Clarity: special case: avoid using variables that have the same names as methods
[etc/vim.git] / docs / editor_integration.md
index 00241f233351d3275c9e06391c297b7836a31a3b..aa3a1eeedec32d2dcce31bbcf89313834e78c048 100644 (file)
@@ -72,7 +72,9 @@ On Windows / Linux / BSD:
       - 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
 
@@ -121,6 +123,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_quiet` (defaults to `0`)
 
 To install with [vim-plug](https://github.com/junegunn/vim-plug):
 
@@ -146,7 +149,7 @@ or you can copy the plugin from
 
 ```
 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
@@ -230,6 +233,36 @@ If you later want to update _Black_, you should do it like this:
 $ pip install -U black --no-binary regex,typed-ast
 ```
 
+## 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
@@ -255,6 +288,10 @@ Sublime Text, Visual Studio Code and many more), you can use the
 
 Use [python-black](https://atom.io/packages/python-black).
 
+## Gradle (the build tool)
+
+Use the [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) plugin.
+
 ## Kakoune
 
 Add the following hook to your kakrc, then run _Black_ with `:format`.
@@ -269,9 +306,9 @@ hook global WinSetOption filetype=python %{
 
 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! ✨ 🍰 ✨