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

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