fix: update documentation

Author: 1nVitr0

CHANGELOG.md

@@ -2,6 +2,90 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+# [0.6.0](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.5.1...v0.6.0) (2021-06-14)
+
+
+### Features
+
+* contribute configuration for natural sorting ([0b61216](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/0b6121654e55c25138d7588ea941e7caad5eba7e))
+* natural sorting of lines containing numbers ([d04a963](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/d04a96314914cda5ab2c79b2b4e33517a6be439c))
+* support natural sorting for negative numbers ([a2bf771](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/a2bf7715327948e31e88c03dc96c7e0f81176ad3))
+
+
+## [0.5.1](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.5.0...v0.5.1) (2021-06-08)
+
+
+### Bug Fixes
+
+* fix dist folder ([fb7f44a](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/fb7f44a1615e1552c9207d00bee1c9bba1b96819))
+
+
+# [0.5.0](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.4.0...v0.5.0) (2021-06-08)
+
+
+### Features
+
+* add suport for multilevel sorting ([789405a](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/789405a9385f88a0a5a1fe2a11ee28b4d07a35f2))
+* dialog for setting level for multilevel sort ([aedf3e6](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/aedf3e6d9561533191f9e0a5f5966a69c9ee2597))
+* options for multilevel sort ([b55b7f4](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/b55b7f413ce5595649e243f3fd90548ee7e05c61))
+* provide commands for multilevel sort ([9a856ba](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/9a856ba5045dbf59a77bdf61200095c6ff66449d))
+
+
+# [0.4.0](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.3.0...v0.4.0) (2021-05-06)
+
+
+### Features
+
+* always put else / delete option last ([0a539c5](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/0a539c5210099042c56909c1cc99157035e95ba5))
+* configuration settings for block header sorting ([bf5ef4c](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/bf5ef4c2610570dbef240cfb69fcd8bc726de3d5))
+* sort block headers ([4c3fba5](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/4c3fba5d45dcaff15710ccbba2d1b072c1345ae0))
+* sticky block headers (case expressions) ([0bed7eb](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/0bed7ebe8b287e8704cc4683dcfdeff97ce9ceb0))
+
+
+# [0.3.0](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.2.1...v0.3.0) (2021-04-15)
+
+
+### Bug Fixes
+
+* fix expansion when second line is selected ([69574d8](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/69574d8403771bd622a8ed81054c7b2a5c93cb7c))
+* fix newline issues on toplevel sorting ([f2b8ce1](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/f2b8ce1a52e0127a9df40d0bae7cf1d61bf14110))
+
+
+### Features
+
+* add configuration for block marker regexes ([86d0d77](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/86d0d77a876a70c1672f233b7eaafc1a9bd76bf9))
+* simplify and extend folding detection ([27c4769](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/27c4769bfebf0dec658b05d7cc78ef8de2856438))
+
+
+## [0.2.1](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.2.0...v0.2.1) (2021-04-02)
+
+
+### Bug Fixes
+
+* fix invalid selectionexpansion on first line ([1b60b35](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/1b60b3513199141d60f937e3d673f0f99b4da9de))
+* no sorting over cpp-like visibility modifiers ([e7579a4](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/e7579a4507636ce9b8645352f678639fe7c8759c))
+
+
+# [0.2.0](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.1.2...v0.2.0) (2021-04-02)
+
+
+### Bug Fixes
+
+* fix sigsev issues with vscode and electron ([29cf9cb](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/29cf9cbf55af06fb99491acd961409beeb6b376e))
+* remove build command from test action ([b5176a4](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/b5176a489d8379fc2797ed0ef31348d59c14c1e2))
+
+
+### Features
+
+* add actions for tests ([444c312](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/444c3125d53ec39ce32397f8c8538578b94d7130))
+* add automated tests ([6f33690](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/6f336901ed9445ea73bf99213e8b33d27a13d8fb))
+* add language specific comments ([59722ac](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/59722acbfaf25a6405295e40907cb0a7b845ff01))
+* add language specific strings ([02dd26d](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/02dd26d52ec213f7785ca4bbb73d9d3a9c9cb81b))
+* add semantic release ([c0424fb](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/c0424fb740d99d6d7c1d9d689a1951a554f9859b))
+* stricky comments and newline management ([1d1cebe](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/1d1cebe9f566be9e34c0df84a13a4c861f37cc8f))
+* support for xml and better block recognition ([0cab698](https://github.com/1nVitr0/plugin-vscode-blocksort/commit/0cab6988beecf36880e77b9136818f88130dd642))
+
+
 ### [0.1.2](https://github.com/1nVitr0/plugin-vscode-blocksort/compare/v0.1.1...v0.1.2) (2021-03-21)
 
 

README.md

@@ -15,6 +15,11 @@ The extension offers commands, similar to the default "Sort Lines Ascending / De
 The selection should automatically expand to the surrounding block if nothing is selected.
 If something is already selected, the extension tries it's best to validate and clean up your selection.
 
+Additional features include:
+
+- deep (multilevel) sorting for nested blocks
+- "*natural*" sorting for lines containing numbers
+
 The blocks are sorted purely by their content, so while decorators are supported, classes or functions with different decorators will be sorted by their decorators first.
 
 ## Commands
@@ -25,9 +30,29 @@ This extension contributed the following commands:
 
 `Sort Blocks Descending`: Sorts the selected code blocks in descending order. If no code blocks are selected, a selection for the deepest block the cursor is currently positioned in is generated.
 
+`Sort Blocks Deep Ascending (Multilevel)`: Sorts the selected code blocks in ascending order, including nested blocks up to a specified depth.
+
+`Sort Blocks Deep Descending (Multilevel)`: Sorts the selected code blocks in descending order, including nested blocks up to a specified depth.
+
 ## Extension Settings
 
-This extension currently contributes no settings.
+This extension contributed the following settings:#
+
+`defaultMultilevelDepth`: Default depth used for deep sorting.
+
+`askForMultilevelDepth`: Skip aksing for multilevel depth and always use `defaultMultilevelDepth`.
+
+`indentIgnoreMarkers`: List of regex markers that when matched will result in ignoring the indentation of the current line. This is for example used for c-style `{` in a new line. The markers are always assumed to be at teh start of the line, but can be preceded by spaces and comments.
+
+`completeBlockMarkers`: List of markers that complete a block. They are assumed to be at the end of a line, but can be succeeded by comments or end-of-line markers (`,` or `;`).
+
+`foldingMarkers`: Dictionary of folding markers. They are supplied set a key-value style, the key being a human-readable ultra-short description of the folding markers.
+
+`enableNaturalSorting`: Enables the natural sorting behavior for lines containing numbers.
+
+`naturalSorting`: Options for the natural sorting behavior. Only takes effect if `enableNaturalSorting` is true.
+
+`sortConsecutiveBlockHeaders`: sorts consecutive block headers, such as a list of `case` statements.
 
 ## Known Issues
 
@@ -36,3 +61,4 @@ This extension currently contributes no settings.
 - The extension does NOT check for code erros due to sorting
 - The extension assumes valid code, invalid formatting will probably result in invalid sorting
 - When comments and / or decorators are involved the results may vary (the extension tries it's best, comments will stick to the lines below them)
+- "Natural" sorting may break on UUID strings containing a mix of numbers, letters and/or dashes