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

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