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

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