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

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