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

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