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

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