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

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