]> 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:

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