Merge pull request #38 from MaxBec/beta

v2.0.0 Release

Author: maxbec

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to the openHAB Alignment Tool extension will be documented in this file.
 
+## [2.0.0] - 21.07.2020
+
+## Changed
+
+-    Implemented the Visual-Studio-Code formatter API. The extension is now a proper formatting tool and can use all the formatting functions integrated in the standard vsc installation (Like format-on-save, etc.).
+
+## Fixed
+
+-    Fixed a lot of bugs regarding special formatting features for the \*.items files.
+
 ## [1.3.11] - 01.03.2020
 
 ## Added

README.md

@@ -5,18 +5,31 @@
 [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/max-beckenbauer.oh-alignment-tool?color=orange&label=Version)](https://img.shields.io/visual-studio-marketplace/v/max-beckenbauer.oh-alignment-tool?color=orange)
 [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/stars/max-beckenbauer.oh-alignment-tool?label=Rating&logo=visual-studio-code)](https://img.shields.io/visual-studio-marketplace/stars/max-beckenbauer.oh-alignment-tool?label=Rating&logo=visual-studio-code)
 
-This extension adds support for formatting and indenting [openHAB](http://www.openhab.org) files like `*.items`, `*.things`, etc. At the moment only `*.items` and `*.sitemap` files are supported. They can be formatted in a column or multiline style. In the future the other file types and other
-format-types will be added. Feel free to enter feature-requests.
+This extension adds support for formatting and indenting [openHAB](http://www.openhab.org) files like `*.items`, `*.sitemap`, etc. At the moment only `*.items` and `*.sitemap` files are supported. They can be formatted in a column channel-column or multiline style. In the future the other file types
+and other format-types will be added. Feel free to add feature-requests on the github repository.
 
-[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C01XTXB)
+If you've found the extension helpful or useful, then please consider throwing a coffee my way to help support my work. As i am a student and would like to invest more time and effort in this project this would really help me.
+
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.png)](https://ko-fi.com/C0C01XTXB)
 
 ## Features
 
-The tool is available via the Command-Palette. Just type `cmnd+shift+p` and enter `openHAB Alignment`. Then you get the option to format the whole file.
+The tool is available as a standard Visual-Studio-Code formatter as it uses the original vsc formatter API. You can force to formatting with right-clicking the document and clicking `Format Document...` or `Format Selection...`. If you have enabled the function in the vsc settings it even can
+`Format-On-Save`.
 
 ### Item-Formatting:
 
-![formatting item gif](images/item-formatting.gif)
+**Column-Style:**
+
+![formatting item gif](images/item-formatting-column.gif)
+
+**Column-Channel-Style:**
+
+![formatting item gif](images/item-formatting-column-channel.gif)
+
+**Multiline-Style:**
+
+![formatting item gif](images/item-formatting-multiline.gif)
 
 ### Sitemap-Formatting:
 
@@ -26,20 +39,21 @@ The tool is available via the Command-Palette. Just type `cmnd+shift+p` and ente
 
 The formatting is available for the following openhab file types:
 
--    `.items`
--    `.sitemap`
+-    `.items` (Fully functional)
+-    `.sitemap` (Under development)
+-    `.things` (Under development)
 
 ## Extension Settings
 
 ### New Line After Item
 
-With this option you can choose if you want to have a new line after each item.
+With this option you can choose if you want to have a new line inserted after each item. If there is already a single empty line after an item this settings is ignored.
 
 `"oh-alignment-tool.newLineAfterItem": true`
 
 ### Preserve Whitespace
 
-Whitespaces in front of items get preserved and won't be deleted.
+Whitespaces (tabs or spaces) in front of items get preserved and won't be deleted.
 
 `"oh-alignment-tool.preserveWhitespace": true`
 
@@ -57,7 +71,8 @@ The format style option gives you two styles between you can choose.
 -    ChannelColumn
 -    Multiline
 
-The Column style formats the files in a column-way. Each item will be on one line and the item parts are separated in columns. The Multiline format prints every part of an item in a new line and indents the different parts.
+The Column style formats the files in a column-way. Each item will be on one line and the item parts are separated in columns. With the ChannelColumn style only the channel part of an item gets formatted into multiple lines. The Multiline format prints every part of an item in a new line and indents
+the different parts.
 
 ## Known Issues