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

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