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

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