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

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