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

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