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

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