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

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