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

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