Add option to skip the first line of source code (#3299)

[etc/vim.git] / CHANGES.md

diff --git a/CHANGES.md b/CHANGES.md
index 90c62de6b98a968eea426c14840027e089826803..ffdbd9c7affe23931e6048ca958a781b0c22de3e 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -6,66 +6,144 @@
 
 <!-- Include any especially major or disruptive changes here -->
 
 
 <!-- Include any especially major or disruptive changes here -->
 

-### Style
+- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
+  supported until further notice.
+
+### Stable style

 
 <!-- Changes that affect Black's stable style -->
 
 
 <!-- Changes that affect Black's stable style -->
 

-- Fix incorrect handling of `# fmt: skip` on colon `:` lines. (#3148)
-- Comments are no longer deleted when a line had spaces removed around power operators
-  (#2874)
+- Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
+  (#3281)

 
 ### Preview style
 
 <!-- Changes that affect Black's preview style -->
 
 
 ### Preview style
 
 <!-- Changes that affect Black's preview style -->
 

-- Single-character closing docstring quotes are no longer moved to their own line as
-  this is invalid. This was a bug introduced in version 22.6.0. (#3166)
-- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
-  normalized as expected (#3168)
+- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
+  (#3262)
+
+### Configuration
+
+<!-- Changes to how Black can be configured -->
+
+- `.ipynb_checkpoints` directories are now excluded by default (#3293)
+- Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
+  while formatting (#3299)
+
+### Packaging
+
+<!-- Changes to how Black is packaged, such as dependency requirements -->
+
+- Executables made with PyInstaller will no longer crash when formatting several files
+  at once on macOS. Native x86-64 executables for macOS are available once again.
+  (#3275)
+- Hatchling is now used as the build backend. This will not have any effect for users
+  who install Black with its wheels from PyPI. (#3233)
+- Faster compiled wheels are now available for CPython 3.11 (#3276)
+
+### Parser
+
+<!-- Changes to the parser or to version autodetection -->
+
+### Performance
+
+<!-- Changes that improve Black's performance. -->
+
+### Output
+
+<!-- Changes to Black's terminal output and error messages -->

 
 ### _Blackd_
 
 
 ### _Blackd_
 

-<!-- Changes to blackd -->
+- Windows style (CRLF) newlines will be preserved (#3257).

 
 

-### Configuration
+### Integrations

 
 

-<!-- Changes to how Black can be configured -->
+<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
+
+- Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
+  option (#3282)
+- Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
+  version (#3265)

 
 ### Documentation
 
 <!-- Major changes to documentation and policies. Small docs changes
      don't need a changelog entry. -->
 
 
 ### Documentation
 
 <!-- Major changes to documentation and policies. Small docs changes
      don't need a changelog entry. -->
 

+## 22.8.0
+
+### Highlights
+
+- Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as
+  of publishing (#3234)
+- This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6
+  code will continue to be supported until further notice)

 - Reword the stability policy to say that we may, in rare cases, make changes that
   affect code that was not previously formatted by _Black_ (#3155)
 - Reword the stability policy to say that we may, in rare cases, make changes that
   affect code that was not previously formatted by _Black_ (#3155)

+
+### Stable style
+
+- Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code
+  block (#3158)
+- Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148)
+- Comments are no longer deleted when a line had spaces removed around power operators
+  (#2874)
+
+### Preview style
+
+- Single-character closing docstring quotes are no longer moved to their own line as
+  this is invalid. This was a bug introduced in version 22.6.0. (#3166)
+- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
+  normalized as expected (#3168)
+- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
+  subscript expressions with more than 1 element (#3209)
+- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
+  parentheses (#3162)
+- Fix a string merging/split issue when a comment is present in the middle of implicitly
+  concatenated strings on its own line (#3227)
+
+### _Blackd_
+
+- `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
+
+### Configuration
+
+- Black now uses the presence of debug f-strings to detect target version (#3215)
+- Fix misdetection of project root and verbose logging of sources in cases involving
+  `--stdin-filename` (#3216)
+- Immediate `.gitignore` files in source directories given on the command line are now
+  also respected, previously only `.gitignore` files in the project root and
+  automatically discovered directories were respected (#3237)
+
+### Documentation
+

 - Recommend using BlackConnect in IntelliJ IDEs (#3150)
 
 ### Integrations
 
 - Recommend using BlackConnect in IntelliJ IDEs (#3150)
 
 ### Integrations
 

-<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
+- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
+- Docker: changed to a /opt/venv installation + added to PATH to be available to
+  non-root users (#3202)
+- Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)

 
 ### Output
 
 
 ### Output
 

-<!-- Changes to Black's terminal output and error messages -->
-

 - Change from deprecated `asyncio.get_event_loop()` to create our event loop which
   removes DeprecationWarning (#3164)
 - Change from deprecated `asyncio.get_event_loop()` to create our event loop which
   removes DeprecationWarning (#3164)

-
-### Packaging
-
-<!-- Changes to how Black is packaged, such as dependency requirements -->
+- Remove logging from internal `blib2to3` library since it regularly emits error logs
+  about failed caching that can and should be ignored (#3193)

 
 ### Parser
 
 
 ### Parser
 

-<!-- Changes to the parser or to version autodetection -->
-

 - Type comments are now included in the AST equivalence check consistently so accidental
   deletion raises an error. Though type comments can't be tracked when running on PyPy
   3.7 due to standard library limitations. (#2874)
 
 ### Performance
 
 - Type comments are now included in the AST equivalence check consistently so accidental
   deletion raises an error. Though type comments can't be tracked when running on PyPy
   3.7 due to standard library limitations. (#2874)
 
 ### Performance
 

-<!-- Changes that improve Black's performance. -->
+- Reduce Black's startup time when formatting a single file by 15-30% (#3211)

 
 ## 22.6.0
 
 
 ## 22.6.0