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

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