]> git.madduck.net Git - etc/vim.git/blob - CHANGES.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:

9c2939e1b1bd6e3aaa5edbaa86726aa44a71c605
[etc/vim.git] / CHANGES.md
1 # Change Log
2
3 ## Unreleased
4
5 ### _Black_
6
7 - Fix failure caused by `fmt: skip` and indentation (#2281)
8 - Account for += assignment when deciding whether to split string (#2312)
9 - Correct max string length calculation when there are string operators (#2292)
10 - Fixed option usage when using the `--code` flag (#2259)
11 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
12 - Added `--required-version` option to require a specific version to be running (#2300)
13 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
14   (#2311)
15 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
16
17 ## 21.5b2
18
19 ### _Black_
20
21 - A space is no longer inserted into empty docstrings (#2249)
22 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
23 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
24   `.gitignore` rules like `git` does) (#2225)
25 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
26 - Add extra uvloop install + import support if in python env (#2258)
27 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
28 - Make sure to split lines that start with a string operator (#2286)
29 - Fix regular expression that black uses to identify f-expressions (#2287)
30
31 ### _Blackd_
32
33 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
34   supported. (#2231)
35
36 ### Integrations
37
38 - The official Black action now supports choosing what version to use, and supports the
39   major 3 OSes. (#1940)
40
41 ### Packaging
42
43 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
44   (#2198)
45 - Always build binaries with the latest available Python (#2260)
46
47 ### Documentation
48
49 - Add discussion of magic comments to FAQ page (#2272)
50 - `--experimental-string-processing` will be enabled by default in the future (#2273)
51 - Fix typos discovered by codespell (#2228)
52 - Fix Vim plugin installation instructions. (#2235)
53 - Add new Frequently Asked Questions page (#2247)
54 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
55
56 ## 21.5b1
57
58 ### _Black_
59
60 - Refactor `src/black/__init__.py` into many files (#2206)
61
62 ### Documentation
63
64 - Replaced all remaining references to the
65   [`master`](https://github.com/psf/black/tree/main) branch with the
66   [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
67   the source code were also made. (#2210)
68 - Sigificantly reorganized the documentation to make much more sense. Check them out by
69   heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
70   (#2174)
71
72 ## 21.5b0
73
74 ### _Black_
75
76 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
77 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
78   being called but with no arguments (#2182)
79
80 ### _Black-Primer_
81
82 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
83
84 ## 21.4b2
85
86 ### _Black_
87
88 - Fix crash if the user configuration directory is inaccessible. (#2158)
89
90 - Clarify
91   [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
92   in which _Black_ may change the AST (#2159)
93
94 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
95   or on the command line. (#2170)
96
97 ### _Packaging_
98
99 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
100
101 ## 21.4b1
102
103 ### _Black_
104
105 - Fix crash on docstrings ending with "\\ ". (#2142)
106
107 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
108
109 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
110   in the name of the cache file. Without this fix, changes in these flags would not take
111   effect if the cache had already been populated. (#2131)
112
113 - Don't remove necessary parentheses from assignment expression containing assert /
114   return statements. (#2143)
115
116 ### _Packaging_
117
118 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
119
120 ## 21.4b0
121
122 ### _Black_
123
124 - Fixed a rare but annoying formatting instability created by the combination of
125   optional trailing commas inserted by `Black` and optional parentheses looking at
126   pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
127   duplicates. (#2126)
128
129 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
130   and adding a padding space when needed to break up """". (#1740)
131
132 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
133
134 - `Black` now respects `--skip-string-normalization` when normalizing multiline
135   docstring quotes (#1637)
136
137 - `Black` no longer removes all empty lines between non-function code and decorators
138   when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
139
140 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
141   in if/while statements (#1655)
142
143 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
144   to split lines (#1824)
145
146 - fixed a crash when PWD=/ on POSIX (#1631)
147
148 - fixed "I/O operation on closed file" when using --diff (#1664)
149
150 - Prevent coloured diff output being interleaved with multiple files (#1673)
151
152 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
153
154 - Added parsing support for unparenthesized tuples and yield expressions in annotated
155   assignments (#1835)
156
157 - added `--extend-exclude` argument (PR #2005)
158
159 - speed up caching by avoiding pathlib (#1950)
160
161 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
162
163 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
164   (#1780)
165
166 - Lines ending with `fmt: skip` will now be not formatted (#1800)
167
168 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
169
170 - PR #2053: Python 2 support is now optional, install with
171   `python3 -m pip install black[python2]` to maintain support.
172
173 - Exclude `venv` directory by default (#1683)
174
175 - Fixed "Black produced code that is not equivalent to the source" when formatting
176   Python 2 docstrings (#2037)
177
178 ### _Packaging_
179
180 - Self-contained native _Black_ binaries are now provided for releases via GitHub
181   Releases (#1743)
182
183 ## 20.8b1
184
185 ### _Packaging_
186
187 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
188   older than 7.0
189
190 ## 20.8b0
191
192 ### _Black_
193
194 - re-implemented support for explicit trailing commas: now it works consistently within
195   any bracket pair, including nested structures (#1288 and duplicates)
196
197 - `Black` now reindents docstrings when reindenting code around it (#1053)
198
199 - `Black` now shows colored diffs (#1266)
200
201 - `Black` is now packaged using 'py3' tagged wheels (#1388)
202
203 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
204   (#1121)
205
206 - `Black` no longer normalizes capital R-string prefixes as those have a
207   community-accepted meaning (#1244)
208
209 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
210
211 - `Black` now works on AWS Lambda (#1141)
212
213 - added `--force-exclude` argument (#1032)
214
215 - removed deprecated `--py36` option (#1236)
216
217 - fixed `--diff` output when EOF is encountered (#526)
218
219 - fixed `# fmt: off` handling around decorators (#560)
220
221 - fixed unstable formatting with some `# type: ignore` comments (#1113)
222
223 - fixed invalid removal on organizing brackets followed by indexing (#1575)
224
225 - introduced `black-primer`, a CI tool that allows us to run regression tests against
226   existing open source users of Black (#1402)
227
228 - introduced property-based fuzzing to our test suite based on Hypothesis and
229   Hypothersmith (#1566)
230
231 - implemented experimental and disabled by default long string rewrapping (#1132),
232   hidden under a `--experimental-string-processing` flag while it's being worked on;
233   this is an undocumented and unsupported feature, you lose Internet points for
234   depending on it (#1609)
235
236 ### Vim plugin
237
238 - prefer virtualenv packages over global packages (#1383)
239
240 ## 19.10b0
241
242 - added support for PEP 572 assignment expressions (#711)
243
244 - added support for PEP 570 positional-only arguments (#943)
245
246 - added support for async generators (#593)
247
248 - added support for pre-splitting collections by putting an explicit trailing comma
249   inside (#826)
250
251 - added `black -c` as a way to format code passed from the command line (#761)
252
253 - --safe now works with Python 2 code (#840)
254
255 - fixed grammar selection for Python 2-specific code (#765)
256
257 - fixed feature detection for trailing commas in function definitions and call sites
258   (#763)
259
260 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
261   code now behave correctly (#1005)
262
263 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
264
265 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
266
267 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
268
269 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
270
271 - _Black_ no longer fails on comments in from-imports (#671)
272
273 - _Black_ no longer fails when the file starts with a backslash (#922)
274
275 - _Black_ no longer merges regular comments with type comments (#1027)
276
277 - _Black_ no longer splits long lines that contain type comments (#997)
278
279 - removed unnecessary parentheses around `yield` expressions (#834)
280
281 - added parentheses around long tuples in unpacking assignments (#832)
282
283 - added parentheses around complex powers when they are prefixed by a unary operator
284   (#646)
285
286 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
287
288 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
289   (#863)
290
291 - if _Black_ puts parenthesis around a single expression, it moves comments to the
292   wrapped expression instead of after the brackets (#872)
293
294 - `blackd` now returns the version of _Black_ in the response headers (#1013)
295
296 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
297   provided (#969)
298
299 ## 19.3b0
300
301 - new option `--target-version` to control which Python versions _Black_-formatted code
302   should target (#618)
303
304 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
305
306 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
307
308 - long `del` statements are now split into multiple lines (#698)
309
310 - type comments are no longer mangled in function signatures
311
312 - improved performance of formatting deeply nested data structures (#509)
313
314 - _Black_ now properly formats multiple files in parallel on Windows (#632)
315
316 - _Black_ now creates cache files atomically which allows it to be used in parallel
317   pipelines (like `xargs -P8`) (#673)
318
319 - _Black_ now correctly indents comments in files that were previously formatted with
320   tabs (#262)
321
322 - `blackd` now supports CORS (#622)
323
324 ## 18.9b0
325
326 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
327
328   - numeric literals are normalized to include `_` separators on Python 3.6+ code
329
330   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
331     leave numeric underscores as they were in the input
332
333   - code with `_` in numeric literals is recognized as Python 3.6+
334
335   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
336
337   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
338
339 - added `blackd`, see
340   [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
341   more info (#349)
342
343 - adjacent string literals are now correctly split into multiple lines (#463)
344
345 - trailing comma is now added to single imports that don't fit on a line (#250)
346
347 - cache is now populated when `--check` is successful for a file which speeds up
348   consecutive checks of properly formatted unmodified files (#448)
349
350 - whitespace at the beginning of the file is now removed (#399)
351
352 - fixed mangling [pweave](http://mpastell.com/pweave/) and
353   [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
354
355 - fixed unstable formatting when unpacking big tuples (#267)
356
357 - fixed parsing of `__future__` imports with renames (#389)
358
359 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
360
361 - fixed formatting of lambda expressions with default arguments (#468)
362
363 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
364
365 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
366   be a bad idea (#415)
367
368 ## 18.6b4
369
370 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
371
372 ## 18.6b3
373
374 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
375
376 - `# fmt: off` and `# fmt: on` are now much more dependable:
377
378   - they now work also within bracket pairs (#329)
379
380   - they now correctly work across function/class boundaries (#335)
381
382   - they now work when an indentation block starts with empty lines or misaligned
383     comments (#334)
384
385 - made Click not fail on invalid environments; note that Click is right but the
386   likelihood we'll need to access non-ASCII file paths when dealing with Python source
387   code is low (#277)
388
389 - fixed improper formatting of f-strings with quotes inside interpolated expressions
390   (#322)
391
392 - fixed unnecessary slowdown when long list literals where found in a file
393
394 - fixed unnecessary slowdown on AST nodes with very many siblings
395
396 - fixed cannibalizing backslashes during string normalization
397
398 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
399
400 ## 18.6b2
401
402 - added `--config` (#65)
403
404 - added `-h` equivalent to `--help` (#316)
405
406 - fixed improper unmodified file caching when `-S` was used
407
408 - fixed extra space in string unpacking (#305)
409
410 - fixed formatting of empty triple quoted strings (#313)
411
412 - fixed unnecessary slowdown in comment placement calculation on lines without comments
413
414 ## 18.6b1
415
416 - hotfix: don't output human-facing information on stdout (#299)
417
418 - hotfix: don't output cake emoji on non-zero return code (#300)
419
420 ## 18.6b0
421
422 - added `--include` and `--exclude` (#270)
423
424 - added `--skip-string-normalization` (#118)
425
426 - added `--verbose` (#283)
427
428 - the header output in `--diff` now actually conforms to the unified diff spec
429
430 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
431
432 - fixed unnecessary parentheses when a line contained multiline strings (#232)
433
434 - fixed stdin handling not working correctly if an old version of Click was used (#276)
435
436 - _Black_ now preserves line endings when formatting a file in place (#258)
437
438 ## 18.5b1
439
440 - added `--pyi` (#249)
441
442 - added `--py36` (#249)
443
444 - Python grammar pickle caches are stored with the formatting caches, making _Black_
445   work in environments where site-packages is not user-writable (#192)
446
447 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
448   fields) and the first method
449
450 - fixed invalid code produced when standalone comments were present in a trailer that
451   was omitted from line splitting on a large expression (#237)
452
453 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
454
455 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
456   in optional parentheses (#234)
457
458 - fixed unstable formatting when inline comments were moved around in a trailer that was
459   omitted from line splitting on a large expression (#238)
460
461 - fixed extra empty line between a class declaration and the first method if no class
462   docstring or fields are present (#219)
463
464 - fixed extra empty line between a function signature and an inner function or inner
465   class (#196)
466
467 ## 18.5b0
468
469 - call chains are now formatted according to the
470   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
471
472 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
473   exploded like imports when they don't fit in a single line (#152)
474
475 - slices are now formatted according to PEP 8 (#178)
476
477 - parentheses are now also managed automatically on the right-hand side of assignments
478   and return statements (#140)
479
480 - math operators now use their respective priorities for delimiting multiline
481   expressions (#148)
482
483 - optional parentheses are now omitted on expressions that start or end with a bracket
484   and only contain a single operator (#177)
485
486 - empty parentheses in a class definition are now removed (#145, #180)
487
488 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
489   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
490   #199)
491
492 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
493   484 (#207, #210)
494
495 - progress when reformatting many files is now reported incrementally
496
497 - fixed trailers (content with brackets) being unnecessarily exploded into their own
498   lines after a dedented closing bracket (#119)
499
500 - fixed an invalid trailing comma sometimes left in imports (#185)
501
502 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
503   used (#183)
504
505 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
506   assignments (#215)
507
508 - fixed not splitting long from-imports with only a single name
509
510 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
511   This fixed non-deterministic formatting if trailing commas where used both in function
512   signatures with stars and function calls with stars but the former would be
513   reformatted to a single line.
514
515 - fixed crash on dealing with optional parentheses (#193)
516
517 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
518   purposes
519
520 - fixed crash when dead symlinks where encountered
521
522 ## 18.4a4
523
524 - don't populate the cache on `--check` (#175)
525
526 ## 18.4a3
527
528 - added a "cache"; files already reformatted that haven't changed on disk won't be
529   reformatted again (#109)
530
531 - `--check` and `--diff` are no longer mutually exclusive (#149)
532
533 - generalized star expression handling, including double stars; this fixes
534   multiplication making expressions "unsafe" for trailing commas (#132)
535
536 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
537
538 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
539
540 - fixed comment indentation when a standalone comment closes a block (#16, #32)
541
542 - fixed standalone comments receiving extra empty lines if immediately preceding a
543   class, def, or decorator (#56, #154)
544
545 - fixed `--diff` not showing entire path (#130)
546
547 - fixed parsing of complex expressions after star and double stars in function calls
548   (#2)
549
550 - fixed invalid splitting on comma in lambda arguments (#133)
551
552 - fixed missing splits of ternary expressions (#141)
553
554 ## 18.4a2
555
556 - fixed parsing of unaligned standalone comments (#99, #112)
557
558 - fixed placement of dictionary unpacking inside dictionary literals (#111)
559
560 - Vim plugin now works on Windows, too
561
562 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
563   (#120)
564
565 ## 18.4a1
566
567 - added `--quiet` (#78)
568
569 - added automatic parentheses management (#4)
570
571 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
572
573 - fixed reporting on `--check` with multiple files (#101, #102)
574
575 - fixed removing backslash escapes from raw strings (#100, #105)
576
577 ## 18.4a0
578
579 - added `--diff` (#87)
580
581 - add line breaks before all delimiters, except in cases like commas, to better comply
582   with PEP 8 (#73)
583
584 - standardize string literals to use double quotes (almost) everywhere (#75)
585
586 - fixed handling of standalone comments within nested bracketed expressions; _Black_
587   will no longer produce super long lines or put all standalone comments at the end of
588   the expression (#22)
589
590 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
591   (#80)
592
593 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
594   _Black_ to not emit the rest of the file (#95)
595
596 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
597   a flurry of asyncio-related exceptions
598
599 - only allow up to two empty lines on module level and only single empty lines within
600   functions (#74)
601
602 ## 18.3a4
603
604 - `# fmt: off` and `# fmt: on` are implemented (#5)
605
606 - automatic detection of deprecated Python 2 forms of print statements and exec
607   statements in the formatted file (#49)
608
609 - use proper spaces for complex expressions in default values of typed function
610   arguments (#60)
611
612 - only return exit code 1 when --check is used (#50)
613
614 - don't remove single trailing commas from square bracket indexing (#59)
615
616 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
617
618 - omit extra space in kwarg unpacking if it's the first argument (#46)
619
620 - omit extra space in
621   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
622   (#68)
623
624 ## 18.3a3
625
626 - don't remove single empty lines outside of bracketed expressions (#19)
627
628 - added ability to pipe formatting from stdin to stdin (#25)
629
630 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
631
632 - even better handling of numpy-style array indexing (#33, again)
633
634 ## 18.3a2
635
636 - changed positioning of binary operators to occur at beginning of lines instead of at
637   the end, following
638   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
639   (#21)
640
641 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
642   formattings (#34, #35)
643
644 - remove a trailing comma if there is a single argument to a call
645
646 - if top level functions were separated by a comment, don't put four empty lines after
647   the upper function
648
649 - fixed unstable formatting of newlines with imports
650
651 - fixed unintentional folding of post scriptum standalone comments into last statement
652   if it was a simple statement (#18, #28)
653
654 - fixed missing space in numpy-style array indexing (#33)
655
656 - fixed spurious space after star-based unary expressions (#31)
657
658 ## 18.3a1
659
660 - added `--check`
661
662 - only put trailing commas in function signatures and calls if it's safe to do so. If
663   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
664   or `**kwargs` used in the signature or call. (#8)
665
666 - fixed invalid spacing of dots in relative imports (#6, #13)
667
668 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
669
670 - fixed spurious space in parenthesized set expressions (#7)
671
672 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
673
674 - fixed spurious space after unary operators when the operand was a complex expression
675   (#15)
676
677 ## 18.3a0
678
679 - first published version, Happy 🍰 Day 2018!
680
681 - alpha quality
682
683 - date-versioned (see: <https://calver.org/>)