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

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