Always show summary of reformatting

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 7038d9656cbc64e8239c9c73e77f513c47b1a6e6..beba56cc2ebff85a2ac7268e1aee841981ef7129 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ possible.
 
 ---
 
 
 ---
 

-*Contents:* **[Installation and Usage](#installation-and-usage)** |
+*Contents:* **[Installation and usage](#installation-and-usage)** |

 **[The *Black* code style](#the-black-code-style)** |
 **[Editor integration](#editor-integration)** |
 **[Version control integration](#version-control-integration)** |
 **[The *Black* code style](#the-black-code-style)** |
 **[Editor integration](#editor-integration)** |
 **[Version control integration](#version-control-integration)** |


@@ -68,6 +68,15 @@ black [OPTIONS] [SRC]...
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]

+  --py36                      Allow using Python 3.6-only syntax on all input
+                              files.  This will put trailing commas in function
+                              signatures and calls also after *args and
+                              **kwargs.  [default: per-file auto-detection]
+  --pyi                       Format all input files like typing stubs
+                              regardless of file extension (useful when piping
+                              source on standard input).
+  -S, --skip-string-normalization
+                              Don't normalize string quotes or prefixes.

   --check                     Don't write the files back, just return the
                               status.  Return code 0 means nothing would
                               change.  Return code 1 means some files would be
   --check                     Don't write the files back, just return the
                               status.  Return code 0 means nothing would
                               change.  Return code 1 means some files would be


@@ -77,9 +86,22 @@ Options:
                               for each file on stdout.
   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]
                               for each file on stdout.
   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]

+  --include TEXT              A regular expression that matches files and
+                              directories that should be included on
+                              recursive searches. On Windows, use forward
+                              slashes for directories.  [default: \.pyi?$]
+  --exclude TEXT              A regular expression that matches files and
+                              directories that should be excluded on
+                              recursive searches. On Windows, use forward
+                              slashes for directories.  [default:
+                              build/|buck-out/|dist/|_build/|\.git/|\.hg/|
+                              \.mypy_cache/|\.tox/|\.venv/]

   -q, --quiet                 Don't emit non-error messages to stderr. Errors
                               are still emitted, silence those with
                               2>/dev/null.
   -q, --quiet                 Don't emit non-error messages to stderr. Errors
                               are still emitted, silence those with
                               2>/dev/null.

+  -v, --verbose               Also emit messages to stderr about files
+                              that were not changed or were ignored due to
+                              --exclude=.

   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```
   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```


@@ -197,10 +219,26 @@ If a data structure literal (tuple, list, set, dict) or a line of "from"
 imports cannot fit in the allotted length, it's always split into one
 element per line.  This minimizes diffs as well as enables readers of
 code to find which commit introduced a particular entry.  This also
 imports cannot fit in the allotted length, it's always split into one
 element per line.  This minimizes diffs as well as enables readers of
 code to find which commit introduced a particular entry.  This also

-makes *Black* compatible with [isort](https://pypi.org/p/isort/).  Use
-`multi_line_output=3`, `include_trailing_comma=True`,
-`force_grid_wrap=0`, and `line_length=88` in your isort config.
+makes *Black* compatible with [isort](https://pypi.org/p/isort/) with
+the following configuration.

 
 

+<details>
+<summary>A compatible `.isort.cfg`</summary>
+
+```
+[settings]
+multi_line_output=3
+include_trailing_comma=True
+force_grid_wrap=0
+combine_as_imports=True
+line_length=88
+```
+
+The equivalent command line is:
+```
+$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width=88 [ file.py ]
+```
+</details>

 
 ### Line length
 
 
 ### Line length
 


@@ -252,9 +290,17 @@ are always reformatted to fit minimal space, this whitespace is lost.
 
 It will also insert proper spacing before and after function definitions.
 It's one line before and after inner functions and two lines before and
 
 It will also insert proper spacing before and after function definitions.
 It's one line before and after inner functions and two lines before and

-after module-level functions.  *Black* will not put empty lines between
-function/class definitions and standalone comments that immediately precede
-the given function/class.
+after module-level functions and classes.  *Black* will not put empty
+lines between function/class definitions and standalone comments that
+immediately precede the given function/class.
+
+*Black* will enforce single empty lines between a class-level docstring
+and the first following field or method.  This conforms to
+[PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
+
+*Black* won't insert empty lines after function docstrings unless that
+empty line is required due to an inner function starting immediately
+after.

 
 
 ### Trailing commas
 
 
 ### Trailing commas


@@ -315,6 +361,12 @@ a bit easier than double quotes.  The latter requires use of the Shift
 key.  My recommendation here is to keep using whatever is faster to type
 and let *Black* handle the transformation.
 
 key.  My recommendation here is to keep using whatever is faster to type
 and let *Black* handle the transformation.
 

+If you are adopting *Black* in a large project with pre-existing string
+conventions (like the popular ["single quotes for data, double quotes for
+human-readable strings"](https://stackoverflow.com/a/56190)), you can
+pass `--skip-string-normalization` on the command line.  This is meant as
+an adoption helper, avoid using this for new projects.
+

 
 ### Line breaks & binary operators
 
 
 ### Line breaks & binary operators
 


@@ -380,7 +432,7 @@ decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
 
 Some popular APIs, like ORMs, use call chaining.  This API style is known
 as a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface).
 
 Some popular APIs, like ORMs, use call chaining.  This API style is known
 as a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface).

-*Black* formats those treating dots that follow a call or an indexing
+*Black* formats those by treating dots that follow a call or an indexing

 operation like a very low priority delimiter.  It's easier to show the
 behavior than to explain it.  Look at the example:
 ```py3
 operation like a very low priority delimiter.  It's easier to show the
 behavior than to explain it.  Look at the example:
 ```py3


@@ -475,7 +527,7 @@ $ where black
     - Arguments: $FilePath$
 
 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
     - Arguments: $FilePath$
 
 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.

-    - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap`.
+    - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`.

 
 
 ### Vim
 
 
 ### Vim


@@ -521,6 +573,12 @@ install *Black* (for example you want to run a version from master),
 create a virtualenv manually and point `g:black_virtualenv` to it.
 The plugin will use it.
 
 create a virtualenv manually and point `g:black_virtualenv` to it.
 The plugin will use it.
 

+To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
+
+```
+autocmd BufWritePost *.py execute ':Black'
+```
+

 **How to get Vim with Python 3.6?**
 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
 On macOS with Homebrew run: `brew install vim --with-python3`.
 **How to get Vim with Python 3.6?**
 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
 On macOS with Homebrew run: `brew install vim --with-python3`.


@@ -572,13 +630,13 @@ repos:
     hooks:
     - id: black
       args: [--line-length=88, --safe]
     hooks:
     - id: black
       args: [--line-length=88, --safe]

-      python_version: python3.6
+      language_version: python3.6

 ```
 Then run `pre-commit install` and you're ready to go.
 
 `args` in the above config is optional but shows you how you can change
 the line length if you really need to.  If you're already using Python
 ```
 Then run `pre-commit install` and you're ready to go.
 
 `args` in the above config is optional but shows you how you can change
 the line length if you really need to.  If you're already using Python

-3.7, switch the `python_version` accordingly. Finally, `stable` is a tag
+3.7, switch the `language_version` accordingly. Finally, `stable` is a tag

 that is pinned to the latest release on PyPI.  If you'd rather run on
 master, this is also an option.
 
 that is pinned to the latest release on PyPI.  If you'd rather run on
 master, this is also an option.
 


@@ -651,14 +709,50 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
 
 ## Change Log
 

-### 18.5b1 (unreleased)
+### 18.6b0
+
+* added `--include` and `--exclude` (#270)
+
+* added `--skip-string-normalization` (#118)
+
+* added `--verbose` (#283)
+
+* fixed stdin handling not working correctly if an old version of Click was
+  used (#276)
+
+* *Black* now preserves line endings when formatting a file in place (#258)
+
+
+### 18.5b1
+
+* added `--pyi` (#249)
+
+* added `--py36` (#249)

 
 * Python grammar pickle caches are stored with the formatting caches, making
   *Black* work in environments where site-packages is not user-writable (#192)
 
 
 * Python grammar pickle caches are stored with the formatting caches, making
   *Black* work in environments where site-packages is not user-writable (#192)
 

+* *Black* now enforces a PEP 257 empty line after a class-level docstring
+  (and/or fields) and the first method
+

 * fixed invalid code produced when standalone comments were present in a trailer
   that was omitted from line splitting on a large expression (#237)
 
 * fixed invalid code produced when standalone comments were present in a trailer
   that was omitted from line splitting on a large expression (#237)
 

+* fixed optional parentheses being removed within `# fmt: off` sections (#224)
+
+* fixed invalid code produced when stars in very long imports were incorrectly
+  wrapped in optional parentheses (#234)
+
+* fixed unstable formatting when inline comments were moved around in
+  a trailer that was omitted from line splitting on a large expression
+  (#238)
+
+* fixed extra empty line between a class declaration and the first
+  method if no class docstring or fields are present (#219)
+
+* fixed extra empty line between a function signature and an inner
+  function or inner class (#196)
+

 
 ### 18.5b0
 
 
 ### 18.5b0
 


@@ -917,8 +1011,10 @@ Multiple contributions by:
 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 * [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com)
 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 * [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com)
 * [Jonas Obrist](mailto:ojiidotch@gmail.com)

+* [Luka Sterbic](mailto:luka.sterbic@gmail.com)

 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)

+* [Stavros Korokithakis](mailto:hi@stavros.io)

 * [Sunil Kapil](mailto:snlkapil@gmail.com)
 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
 
 * [Sunil Kapil](mailto:snlkapil@gmail.com)
 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)