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

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