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

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