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

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