maxbec / openhab-alignment-tool Goto Github PK

Just a reminder to update the README.md to let new users know there are new features implemented (#OHNG#, #OHFS#) in v2. 😉
But maybe you want to wait untill they are tested properly.

I would also suggest small screenshots to show what the different format styles mean.

Example code:

Switch	A	"B"	<c>	(D)	{channel="e", alexa="Speaker.muted"}
Switch	A	"B"	<c>	(D)	{channel="e" ,alexa="Speaker.muted"}
Switch	A	"B"	<c>	(D)	{channel="e" , alexa="Speaker.muted"}

Result:

Only the first combination ,_ produces the expected result.
The other two _, and _,_ do not produce a new line.

Version: 2.0.7

I started to use the alexa skill recently and just noticed an odd thing while configuring a light:
When adding the alexa channels to the item there are no spaces allowed between the channels themselves. Let me show you:

This works:

Color Sprachassistent_Licht_Bett "Bett" {alexa="PowerController.powerState,BrightnessController.brightness,ColorController.color" [category="LIGHT"]}

This doesn't:

Color Sprachassistent_Licht_Bett "Bett" {alexa="PowerController.powerState, BrightnessController.brightness,ColorController.color" [category="LIGHT"]}

When using the second configuration alexa can't control the brightness of the item.

The problem appears when using the vscode extension and letting it format the items since the extension adds the one little space before BrightnessController. The extension always adds a space in the alexa="" string after the first channel no matter the order of the channels.

Expected Behavior

The extension should not correct any alexa="" string

Steps to Reproduce (for Bugs)

1. My settings:
   
2. Try the item definitions as shown above

Context

Currently I can't save my items file with vscode since vscode auto formats the file before saving and adding the problematic space. So I have to save the file in vscode and edit it afterwards in another editor to remove the space

Your Environment

• Extension Version: v2.1.4
• VSCode Version: 1.55.1 (system setup)
• Electron: 11.3.0
• Chrome: 87.0.4280.141
• Node.js: 12.18.3
• V8: 8.7.220.31-electron.0
• OS: Windows_NT x64 10.0.19042

Is your feature request related to a problem? Please describe.
The indentation column alignment is done by inserting tabs.
For document portability across different editors, I prefer spaces instead.

Describe the solution you'd like
A settings option for choosing space or tabs.

I think the new feature reformat at save is not usable when you want to reformat parts of your file different that the rest. (like #7)

So I propose a feature where you can define "formatting groups" inside your files.

This is some example code:

Switch	Awtrix01AppstateTime	"Time"	<switch>			{mqtt=">[mosquitto:awtrix/basics:command:ON:{\"enable\"\\: \"Time\"}],
															       >[mosquitto:awtrix/basics:command:OFF:{\"disable\"\\: \"Time\"}]"}

Switch	HTPC_Online											{channel="network:pingdevice:htpc:online"}
Switch	PC_Online											{channel="network:pingdevice:pc:online"}
Switch	AVR_Online											{channel="network:pingdevice:avr:online"}
Switch	Beamer_Online										{channel="network:pingdevice:epson:online"}

Reformatting the whole document results in this:

It would look better if the lower group of items would be reformated seperately from the first line/group.
Maybe this could be implemented with some kind of special comment that gets recognized by the plugin and treats all following lines as a new group until the next special group-comment is detected.

I just found another special case where the reformatting dod not work correctly.

Example code:

String	Awtrix01timer		"Timer"			<clock>	{mqtt=">[mosquitto:awtrix/basics:command:*:{\"timer\"\\:\"${command}\",\"soundfile\"\\:1,\"count\"\\:10,\"text\"\\:\"Test123\"}]", autoupdate="false"}

Ouput when reformatting the document:

Expected:
The mqtt-bindingconfig hould be only one line.

I understand this is a very special use case and I wish I dod not have to excape all those characters. 😄

So I respect if this will not get fixed.

Another workaournd could be to implement a special comment like:

// ##openHAB-Alignment-Tool_skipNextLines: 2##

The What's New page is shown on every startup of the extension.

Items without bindingconfig get tabs added at the end of the line.

I think these should be stripped at the end of the reformation process.

Version: 2.0.0-beta.2

I am not sure if I should report an issue with the current beta2.

I suspect this worked in the stable version. But I never tried it.

When I try to format my sitemaps, the only thing that happens is that lines with Color or Switch are moved all the way to the left with no ident.
The rest of the document stays the same.

I guess the beta is still a work in progress and @maxbec focused on the items files for now. 😅

Example code:

Number:Temperature	Temp_Bad_Temp	"Bad [%.2f %unit%]"	<temperature>	{mqtt="<[mosquitto:misensor/Bad:state:JSONPATH($.temperature)]", alexa="TemperatureSensor.temperature" [scale="Celsius"], expire="2h,state=UNDEF"}
Number:Temperature	Temp_Bad_Temp	"Bad [%.2f %unit%]"	<temperature>	{mqtt="<[mosquitto:misensor/Bad:state:JSONPATH($.temperature)]", alexa="TemperatureSensor.temperature", expire="2h,state=UNDEF"}

Result:

The expire bindingconfig should be in a new line in bith cases.
It seems the plugin gets confused by the [scale="Celsius"] part.

Format Style: ChannelColumn
Version: 2.0.7

Expected Behavior

This line should be aligned inaccordance to the other lines:

Switch Abus_Mode "Alarmanlage [%s]" <siren> (G_jdbc,Group_HabPanel_Dashboard) {http=">[ON:GET:http://192.168.68.36:8060/setMode.cgi?Mode=Set{Authorization=Basic xxx}] >[OFF:GET:http://192.168.68.36:8060/setMode.cgi?Mode=Unset{Authorization=Basic xxx}]"}

Current Behavior

This is the result where parts of the code is duplicated starting with //192 ...

Switch Abus_Mode "Alarmanlage [%s]" <siren> (G_jdbc,Group_HabPanel_Dashboard) {http=">[ON:GET:http://192.168.68.36:8060/setMode.cgi?Mode=Set{Authorization=Basic xxx} //192.168.68.36:8060/setMode.cgi?Mode=Set{Authorization=Basic xxx}] >[OFF:GET:http://192.168.68.36:8060/setMode.cgi?Mode=Unset{Authorization=Basic xxx}]"}

Possible Solution

Is there an issue interpreting this part?

] >[OFF:GET:http:

Steps to Reproduce (for Bugs)

Context

Your Environment

openhabian v1.5
openhab 2.5.3-1 stable
Raspberry Pi 3B+

I think the comments for the different format styles are wrong.

The comment for Column seems to be assigned to ChannelColumn whereas the commant for the later is missing at all.

No effect of // #OHNG# on the formatting of .items files.

I am not sure if the sitemap feature is even usable at the moment.

But as long as it is in development I would recommend sitemap files should not formatOnSave.
Even If the user has set this option (to use for items files)

Maybe even deactivate the sitemap feature and let it be enabled via a setting.

How about something like:

 "oh-alignment-tool.enableForFiletype": "items,"
 "oh-alignment-tool.enableForFiletype": "items,sitemap"
 "oh-alignment-tool.enableForFiletype": "items,sitemap, rules"

But I do not know if there are any consequences with a feature like this if you want to enable a new file type by default, but the users might already have an old setting set to items only.

There are problems with comments at the end of a line.
Lines that contain: MAX are formatted incorrectly or parts are deleted.

https://community.openhab.org/t/visual-studio-code-openhab-formatting-tool/83406/14?u=miwok

I think Groups are not handled correctly.

Example:

Group gTest

Result:

Group  gTest  {}

The brackets are inserted by the addon and I guess they will produce an error in openHAB. (did not test this)

v2.1.4

openHAB-Alignment-Tool 2.0.6

After the #OHNG# issue having been fixed so quickly I was going to clean up more of my long .items files and came accross this strange formatting bug for some lines where I have comments at the end of the lines of the itme definitions.

These comments are ancient, still from the OH1 MiLight binding and not really applicable and required any longer and I will remove them now in my clean up effort, but still wanted to report them as similar issues might affect others.

Format these lines with a Column format

Switch	Milight_Bedroom_Globe_1_Switch				"Bedroom Globe"			<bulb>			(G_Bedroom_Lights)              {channel="milight:rgbLed:XXXXXXXXXXXX:1:ledcolor"}					//Switch for all white bulbs on bridge2
Dimmer	Milight_Bedroom_Globe_1_Dimmer				"Dimmer [%d]"			<bulb_dimmer>                                    {channel="milight:rgbLed:XXXXXXXXXXXX:1:ledbrightness"}    			//Dimmer changing brightness for RGBW bulb1 on bridge2 with 27 dimming steps
Color	Milight_Bedroom_Globe_1_Colour_Bright       "Colour"									
Switch	Milight_Bedroom_Globe_1_WhiteMode			"White Mode"			<bulb>											{channel="milight:rgbLed:XXXXXXXXXXXX:1:ledwhitemode"}        		//Activate the WhiteMode
Switch	Milight_Bedroom_Globe_1_NightMode			"Night Mode"			<bulb>											{channel="milight:rgbLed:XXXXXXXXXXXX:1:lednightmode"}	       		//Activate the NightMode

The result I get is

Switch	Milight_Bedroom_Globe_1_Switch			"Bedroom Globe"	<bulb>				(G_Bedroom_Lights)			{channel="milight:rgbLed:XXXXXXXXXXXX:1:ledcolor"}					//Switch for all white bulbs on bridge2
Dimmer	Milight_Bedroom_Globe_1_Dimmer			"Dimmer [%d]"	<bulb_dimmer>									Dimmer	Milight_Bedroom_Globe_1_Dimmer				"Dimmer [%d]"			<bulb_dimmer>                                    {channel="milight:rgbLed:XXXXXXXXXXXX:1:ledbrightness"}
Color	Milight_Bedroom_Globe_1_Colour_Bright	"Colour"
Switch	Milight_Bedroom_Globe_1_WhiteMode		"White Mode"	<bulb>											{channel="milight:rgbLed:XXXXXXXXXXXX:1:ledwhitemode"}        		//Activate the WhiteMode
Switch	Milight_Bedroom_Globe_1_NightMode		"Night Mode"	<bulb>											Switch	Milight_Bedroom_Globe_1_NightMode			"Night Mode"			<bulb>											{channel="milight:rgbLed:XXXXXXXXXXXX:1:lednightmode"}

With the Dimmer and NightMode Switch items being strangely duplicated within the line itself and some comments being deleted, others not.

Once the comments at the end of the lines are removed everything works fine.

Just discovered this nice extension.

But I am missing one feature.

Format item configurations like this:

Basically everything is in one line.
But the bindingconfig (in {}) should be broken into multiple lines to not exceed the screen.

There seems to be a regression with ChannelColumn in v2.1.6.

In v2.0.0 each Binding parameter (like mqtt's < and >) where moved to new lines.
See #31.

But it does not anymore for this simple example:

Number  aaa  "bbb"  {mqtt=">[mosquitto:ddd:command:*:default],<[mosquitto:ddd:state:default]"}

I created a test-items with the following content. (Examples from above)

Number:Temperature Temp_Bad_Temp "Bad [%.2f %unit%]" {mqtt="<[mosquitto:misensor/Bad:state:JSONPATH($.temperature)]", alexa="TemperatureSensor.temperature" [scale="Celsius"], expire="2h,state=UNDEF"}
Number:Temperature Temp_Bad_Temp "Bad [%.2f %unit%]" {mqtt="<[mosquitto:misensor/Bad:state:JSONPATH($.temperature)]", alexa="TemperatureSensor.temperature", expire="2h,state=UNDEF"}

String A "B" (D) {autoupdate="false", alexa="ThermostatController.thermostatMode" [OFF="OFF", HEAT="ON", AUTO="AUTO"]}
After formatting it looks like this:

image

When I delete :Temperature it looks like nothing is destroyed. But the channels are not listed in new columns either.

image

I think it looks worse than before. 😢
Tested with oh-alignment-tool-2.0.9-beta.1.vsix.

I finally found the time to test the new ChannelColumn feature I requested (#12 ).

I know my example screeshot did not show this in my previous request, but I think it would be better if the Channel commands would be lined relative to each other instead of to the Channel name.

Current behavior:

This would look nicer and be better to read:

I tested on this *.items file. Also my last item got duplicated.

I did some manual formatting to look like this:

// Preset button
String	wifiled_presets					"LED Presets"							<light>				(gWifiledPresets)																												

String	wifiled_presets_livingroom		"LED Presets"							<light>				(gWifiledPresets)																												

// Kitchen LED Top
Switch	wifiled1_power					"Kitchen LED Top"						<light>				(gKitchen, gKitchenLights, gAllLightAutoTurnOff, gAllLight, gKitchenLedLight, gKitchenLedControl)								{channel="mqtt:topic:25e0dc66:1"}

Color	wifiled1_color					"LED Top Color"												(gKitchenLedControl, gKitchenLedColor)																							{channel="mqtt:topic:25e0dc66:3"}

Dimmer	wifiled1_white					"Kitchen Top LED"											(gKitchenLedControl, gKitchenLedWhite)																			[ "Lighting" ]	{channel="mqtt:topic:25e0dc66:4"}

Number	wifiled1_rssi					"Kitchen LED Top RSSI: [%d%%]"			<controls_round>	(gKitchenLedControl)																											{channel="mqtt:topic:25e0dc66:2"}

Dimmer	wifiled1_dimmer					"Kitchen LED Top Dimmer"																																									{channel="mqtt:topic:25e0dc66:5"}

// Kitchen LED Bottom
Switch	wifiled2_power					"Kitchen LED Bottom"					<light>				(gKitchen, gKitchenLights, gAllLightAutoTurnOff, gAllLight, gKitchenLedLight, gKitchenLedControl)								{channel="mqtt:topic:a0809db4:1"}

Color	wifiled2_color					"LED Bottom Color"											(gKitchenLedControl, gKitchenLedColor)																							{channel="mqtt:topic:a0809db4:3"}

Dimmer	wifiled2_white					"Kitchen Bottom LED"										(gKitchenLedControl, gKitchenLedWhite)																			[ "Lighting" ]	{channel="mqtt:topic:a0809db4:4"}

Dimmer	wifiled2_dimmer					"Kitchen Bottom LED Dimmer"																																									{channel="mqtt:topic:a0809db4:5"}

Number	wifiled2_rssi					"Kitchen LED Bottom RSSI: [%d%%]"		<controls_round>	(gKitchenLedControl)																											{channel="mqtt:topic:a0809db4:2"}

// Living Room Shelf LED
Switch	wifiled_livingroom				"Living Room Shelf LED"					<light>				(gLivingRoom, gLivingRoomLights, gAllLightAutoTurnOff, gAllLight, gLivingRoomLedLight, gLivingRoomLedControl)					{channel="mqtt:topic:livingroomShelfLed:1"}

Dimmer	wifiled_livingroom_white		"Living Room Shelf LED"					<light>				(gLivingRoomLedControl, gLivingRoomLedWhite)																	[ "Lighting" ]	{channel="mqtt:topic:livingroomShelfLed:3"}

Number	wifiled_livingroom_rssi			"Living Room Shelf LED RSSI: [%d%%]"	<controls_round>	(gLivingRoomLedControl)																											{channel="mqtt:topic:livingroomShelfLed:2"}

// Living Room Bottom LED
Switch	wifiled_livingroom_strip_power	"Living Room Bottom Strip LED"			<light>				(gLivingRoom, gLivingRoomLights, gAllLightAutoTurnOff, gAllLight, gLivingRoomLedLight, gLivingRoomLedControl)					{channel="mqtt:topic:a9b1ff48:1"}

Color	wifiled_livingroom_strip_color	"LED Bottom Color"											(gLivingRoomLedControl, gLivingRoomLedColor)																					{channel="mqtt:topic:a9b1ff48:3"}

Dimmer	wifiled_livingroom_strip_white	"Living Room Bottom LED"									(gLivingRoomLedControl, gLivingRoomLedWhite)																	[ "Lighting" ]	{channel="mqtt:topic:a9b1ff48:4"}

Dimmer	wifiled_livingroom_strip_dimmer	"Living Room Strip LED Dimmer"																																								{channel="mqtt:topic:a9b1ff48:5"}

Number	wifiled_livingroom_strip_rssi	"Living Room Strip RSSI: [%d%%]"		<controls_round>	(gLivingRoomLedControl)																											{channel="mqtt:topic:a9b1ff48:2"}

Switch	Morning_Led_Switch																																																			

If I rerun the formatting after changing some indentation, I get this. Look how every empty line became 2 empty line and the last item also got duplicated:

// Preset button
String	wifiled_presets					"LED Presets"							<light>				(gWifiledPresets)																												


String	wifiled_presets_livingroom		"LED Presets"							<light>				(gWifiledPresets)																												


// Kitchen LED Top
Switch	wifiled1_power					"Kitchen LED Top"						<light>				(gKitchen, gKitchenLights, gAllLightAutoTurnOff, gAllLight, gKitchenLedLight, gKitchenLedControl)								{channel="mqtt:topic:25e0dc66:1"}


Color	wifiled1_color					"LED Top Color"												(gKitchenLedControl, gKitchenLedColor)																							{channel="mqtt:topic:25e0dc66:3"}


Dimmer	wifiled1_white					"Kitchen Top LED"											(gKitchenLedControl, gKitchenLedWhite)																			[ "Lighting" ]	{channel="mqtt:topic:25e0dc66:4"}


Number	wifiled1_rssi					"Kitchen LED Top RSSI: [%d%%]"			<controls_round>	(gKitchenLedControl)																											{channel="mqtt:topic:25e0dc66:2"}


Dimmer	wifiled1_dimmer					"Kitchen LED Top Dimmer"																																									{channel="mqtt:topic:25e0dc66:5"}


// Kitchen LED Bottom
Switch	wifiled2_power					"Kitchen LED Bottom"					<light>				(gKitchen, gKitchenLights, gAllLightAutoTurnOff, gAllLight, gKitchenLedLight, gKitchenLedControl)								{channel="mqtt:topic:a0809db4:1"}


Color	wifiled2_color					"LED Bottom Color"											(gKitchenLedControl, gKitchenLedColor)																							{channel="mqtt:topic:a0809db4:3"}


Dimmer	wifiled2_white					"Kitchen Bottom LED"										(gKitchenLedControl, gKitchenLedWhite)																			[ "Lighting" ]	{channel="mqtt:topic:a0809db4:4"}


Dimmer	wifiled2_dimmer					"Kitchen Bottom LED Dimmer"																																									{channel="mqtt:topic:a0809db4:5"}


Number	wifiled2_rssi					"Kitchen LED Bottom RSSI: [%d%%]"		<controls_round>	(gKitchenLedControl)																											{channel="mqtt:topic:a0809db4:2"}


// Living Room Shelf LED
Switch	wifiled_livingroom				"Living Room Shelf LED"					<light>				(gLivingRoom, gLivingRoomLights, gAllLightAutoTurnOff, gAllLight, gLivingRoomLedLight, gLivingRoomLedControl)					{channel="mqtt:topic:livingroomShelfLed:1"}


Dimmer	wifiled_livingroom_white		"Living Room Shelf LED"					<light>				(gLivingRoomLedControl, gLivingRoomLedWhite)																	[ "Lighting" ]	{channel="mqtt:topic:livingroomShelfLed:3"}


Number	wifiled_livingroom_rssi			"Living Room Shelf LED RSSI: [%d%%]"	<controls_round>	(gLivingRoomLedControl)																											{channel="mqtt:topic:livingroomShelfLed:2"}


// Living Room Bottom LED
Switch	wifiled_livingroom_strip_power	"Living Room Bottom Strip LED"			<light>				(gLivingRoom, gLivingRoomLights, gAllLightAutoTurnOff, gAllLight, gLivingRoomLedLight, gLivingRoomLedControl)					{channel="mqtt:topic:a9b1ff48:1"}


Color	wifiled_livingroom_strip_color	"LED Bottom Color"											(gLivingRoomLedControl, gLivingRoomLedColor)																					{channel="mqtt:topic:a9b1ff48:3"}


Dimmer	wifiled_livingroom_strip_white	"Living Room Bottom LED"									(gLivingRoomLedControl, gLivingRoomLedWhite)																	[ "Lighting" ]	{channel="mqtt:topic:a9b1ff48:4"}


Dimmer	wifiled_livingroom_strip_dimmer	"Living Room Strip LED Dimmer"																																								{channel="mqtt:topic:a9b1ff48:5"}


Number	wifiled_livingroom_strip_rssi	"Living Room Strip RSSI: [%d%%]"		<controls_round>	(gLivingRoomLedControl)																											{channel="mqtt:topic:a9b1ff48:2"}
Switch	Morning_Led_Switch																																																			
Switch	Morning_Led_Switch

Just gave it a test. I actually was looking for a tool last night and came across the other one that formats as multi-line. So quite happy there is this column based one.

Unfortunately, I did run into some issues with your tool.

Firstly, it’s named exactly the same as the one from MarkHilbush. This caused the Command-Palette to not offer your one up for use. After disabling Mark’s one, it appeared in the Command-Palette, but the results weren’t what was expected.

Here is one of my item files before:

String                      JiPhone_BatteryStatus
                            "Battery Status [%s]"
                            <battery>
                            (iCloud_GroupJ)
                            {channel="icloud:device:myaccount:JiPhone7:batteryStatus"}

And here is what it looks like after using your tool:

StringJiPhone_BatteryStatus
                            "Battery Status [%s]"
                            <battery>
                            (iCloud_GroupJ)
                            {channel="icloud:device:myaccount:JiPhone7:batteryStatus"}

I understand this plugin places at least one tab between each part of the item definition.

itemtype itemname "labeltext [stateformat]" <iconname> (group1, group2, ...) ["tag1", "tag2", ...] {bindingconfig}

But when you do not use some parts like (group) and [tag] you still get the extra tabs.

I think there should always be as few tabs as possible between the definition parts.

Here is the code to reproduce the behavior:

Switch	sLED_light		"LED 1"			<light>				{mqtt="<[mosquitto:homie/superledstrip/light/on:state:ON:true],
															       <[mosquitto:homie/superledstrip/light/on:state:OFF:false],
															       >[mosquitto:homie/superledstrip/light/on/set:command:ON:true],
															       >[mosquitto:homie/superledstrip/light/on/set:command:OFF:false]"}
Dimmer	sLED_brightness	"LED 1 [%d]"	<slider>			{mqtt="<[mosquitto:homie/superledstrip/light/brightness:state:default],
															       >[mosquitto:homie/superledstrip/light/brightness/set:command:*:default]"}

Version: 2.0.0-beta.2

Dear developpers,
I experienced a somewhat severe bug as the use of group aggregation functions is a good practive within openhab.

Expected Behavior

The following group definition should be well aligned with others:
Group:Number:Temperature:AVG g_test_temp_tr "test label [%.1f °C]" <temperature> (testroom)

Current Behavior

However, the result is as follows:
Group:Number:Temperature Temperature
The aggregation main type "Number", the function name "AVG" and all following elements (group name, label, class, group association) are removed. Strangely, the sub type "Temperature" is duplicated and falsely used as group name.

Steps to Reproduce (for Bugs)

The provided example is enough to reproduce the bug (as only row in an .items file). If a group aggregation is used within a file with other item and group definitions, the same result can be observed. Other items' or groups' definitions in the same file are preserved and formatted correctly.

Context

General openHAB practice.

Your Environment

• Version used:
  • vscode: V 1.52
  • openHAB (vscode extension) V 0.7.0
  • openHAB Alignment Tool V 2.0.8 (installed via vscode extension management)
• No environment activated
• Operating System and version: Windows 10 Pro V 2004

The following items:

Switch test1               "test 1"                                     (All)
Switch _test2              "_test 2"                                     (All)

align to:

Switch    test1    "test 1"    (All)SwitchSwitch _test2              "_test 2"                                     (All)

which is obviously wrong.

If the original formatting is done through spaces instead of tabs the re-formatting does not work.

https://community.openhab.org/t/visual-studio-code-openhab-formatting-tool/83406/9?u=sihui

Example code:

Number A "B" <c> (G) { channel = "x" }
Number A "B" <c> (G) { channel="x" }

Result:

Version 2.0.7

There seems to be an issue when I add an extra bindingconfig like autoupdate.

Example code

Switch	Awtrix01stopwatch	"Stopwatch"	<clock>			{mqtt=">[mosquitto:awtrix/basics:command:ON:{test123}], >[mosquitto:awtrix/basics:command:OFF:{test456}]", autoupdate="false"}
Switch	Awtrix01stopwatch	"Stopwatch"	<clock>			{mqtt=">[mosquitto:awtrix/basics:command:ON:{test123}], >[mosquitto:awtrix/basics:command:OFF:{test456}]"}

When reformatting the document I get this:

What I expect:

Version: 2.0.0-beta2

Expected Behavior

Clicking the right click menu item "Format Document" or alternatively pressing Shift+Alt+F should format the document.

Instead there is an additional Context menu entry "Reformat File" which seems redundant, because its functionality could be transferred to "Format Document", to enable other extensions to perform additional actions (e.g. on each save, my code is automatically formatted by executing "Format Document", which in this case does not work).

Current Behavior

Clicking the "Format Document" context menu entry does nothing.

Steps to Reproduce (for Bugs)

1. Create a valid .stiemap file with working content
2. Right-click -> Format Document or Format document with... openHAB

Your Environment

• Version used: 1.3.12
• Operating System: Windows 10

In addition to #29 it would be nice if you could overwrite the plugin settings for specific files.

Like:

The best solution would be if this feature could be used multiple times in a document.

Example code:

String OctoprintConnected "Connected [%s]" <network> (gOctoprint) { mqtt="<[mosquitto:octoPrint/mqtt:state:default]" } 
String OctoprintState	  "State [%s]"	   <office>  (gOctoprint) { mqtt="<[mosquitto:octoPrint/event/PrinterStateChanged:state:JSONPATH($.state_string)]" }

After reformatting document:

Version: 2.0.0-beta2

The extension seems to not do well when there are escaped characters.

Input:

Switch	Awtrix01AppstateTime            "Time"              <switch>	{ mqtt=">[mosquitto:awtrix/basics:command:ON:{\"enable\"\\: \"Time\"}],>[mosquitto:awtrix/basics:command:OFF:{\"disable\"\\: \"Time\"}], <[mosquitto:awtrix/appEnabled:state:ON:Time], <[mosquitto:awtrix/appDisabled:state:OFF:Time]"}

Output:

Switch	Awtrix01AppstateTime	"Time"	<switch>			{mqtt=">[mosquitto:awtrix/basics:command:ON:{\"enable\"\\: \"Time\"}

I just found a bug where this plugin adds a space in a URL.

original line:

Number  A  "B [%d]"  {http="<[https://example.com/foobar/query?test,bla:600000:JSONPATH($.field)]"}

After formating there is a space before bla.

Number  A  "B [%d]"  {http="<[https://example.com/foobar/query?test, bla:600000:JSONPATH($.field)]"}

This breaks the URL of cause and results in errors.

Expected Behavior

When I use the new feature to reformat a sitemap, items that I have commented out should be formatted to match the indenting of the items adjacent to them.

Current Behavior

In 1.3.12, items that are commented out are split onto separate lines, leaving an empty comment and reactivating the items. It seems that the formatter is keying on the device type (e.g. "Switch") to determine when to create a new line.

Possible Solution

Perhaps it would be possible to have the reformatting completely ignore comments?

Steps to Reproduce (for Bugs)

This code:

// Switch item=Flag_Test label="Test Switch" icon="door"

Becomes this:

//
Switch item=Flag_Test label="Test
Switch" icon="door"

Context

I'm just testing this out of interest more than need.

Your Environment

I'm using the 1.3.12 version of the alignment tool. VSCode is up to date in Windows 10.

When I select a fe lines in my .items and execute Reformat Selection the whole file is reformated.

Expected Behavior

I expect the command to only reformat the selected lines.

Current Behavior

All lines are refomated

Steps to Reproduce (for Bugs)

1. open .items file
2. select a few lines
3. execute Reformat Selection
4. see how all lines are reformated

Context

Eventually I will refomat the whole file, but the command should still do what it is named for. ;)

Your Environment

• openhab 2.4.x
• VScode 1.44.2
• openHAB-Alignment-Tool 1.3.12
• Windows 10

I try to format my item file with the semantic model "extentions" coming with openhab .
It looks like they are currently not supported an will be filtered:

e.g.
before:

Group     lInnen             "01 Innenbereich"                   <ikInnen>                [Location]
Group     lKeller            "00 Keller"                        <ikKeller>         (lInnen)             [Location]
Group     lErdgeschoss       "01 Erdgeschoss"                        <ikErdgeschoss>         (lInnen)             [Location]
Group     lDachgeschoss      "02 Dachgeschoss"                        <iDachgeschoss>         (lInnen)             [Location]

after:

Group    lInnen           "01 Innenbereich"    <ikInnen>
Group    lKeller          "00 Keller"          <ikKeller>         (lInnen)
Group    lErdgeschoss     "01 Erdgeschoss"     <ikErdgeschoss>    (lInnen)
Group    lDachgeschoss    "02 Dachgeschoss"    <iDachgeschoss>    (lInnen)

Found another bug.

This might be a tricky one, because it includes escaped characters.

Example:

String  AAA  "BBB"    {mqtt=">[mosquitto:ccc:command:open:{\"x\"\\: \"y\"}]"}

Result:

String  AAA  "BBB"  {mqtt=">[mosquitto:ccc:command:open:{\"}

And here is my real life example:

String  Therm_AZ_Preset  "AZ Preset"                 <thermostat>  (Thermostat)  {mqtt=">[mosquitto:zigbee2mqtt/Therm_AZ/set:command:schedule:{\"preset\"\\: \"schedule\"}],
                                                                                        >[mosquitto:zigbee2mqtt/Therm_AZ/set:command:manual:{\"preset\"\\: \"manual\"}],
                                                                                        >[mosquitto:zigbee2mqtt/Therm_AZ/set:command:boost:{\"preset\"\\: \"boost\"}],
                                                                                        >[mosquitto:zigbee2mqtt/Therm_AZ/set:command:complex:{\"preset\"\\: \"complex\"}],
                                                                                        >[mosquitto:zigbee2mqtt/Therm_AZ/set:command:comfort:{\"preset\"\\: \"comfort\"}],
                                                                                        >[mosquitto:zigbee2mqtt/Therm_AZ/set:command:eco:{\"preset\"\\: \"eco\"}],
                                                                                        <[mosquitto:zigbee2mqtt/Therm_AZ:state:JSONPATH($.preset)]"}

Addon version: 2.1.5

Expected Behavior

Any additional click on "Reformat File" should produce the same result as the first click on it.

Current Behavior

Each click on context menu entry "Reformat File" inserts new empty lines between each existing line, stretching the whole code with empty lines.

Eyample: Starting point is the following code (.sitemap)

sitemap default label="My first sitemap"
 {
	// Syntax:
	// ElementType item=ItemName label="Description of the item shown on the webpage"
	Frame label="Testing"{
		Switch item=Presence_Brother_PT_P750W label="Description of the item shown on the webpage, here P750W"
		Default item=Chromecast_XE8005_Control icon=screen label="XE8005 Control"
	}
	Frame label="Working" {
		Slider item=Chromecast_XE8005_Volume icon=soundvolume label="XE8005 Volume"
	}
}

Second click on "Reformat File" produces the following output:

sitemap default label="My first sitemap"
 {

	// Syntax:

	// ElementType item=ItemName label="Description of the item shown on the webpage"

	Frame label="Testing"{

		Switch item=Presence_Brother_PT_P750W label="Description of the item shown on the webpage, here P750W"

		Default item=Chromecast_XE8005_Control icon=screen label="XE8005 Control"

	}

	Frame label="Working" {

		Slider item=Chromecast_XE8005_Volume icon=soundvolume label="XE8005 Volume"

	}

}

Third run produces:

sitemap default label="My first sitemap"
 {


	// Syntax:


	// ElementType item=ItemName label="Description of the item shown on the webpage"


	Frame label="Testing"{


		Switch item=Presence_Brother_PT_P750W label="Description of the item shown on the webpage, here P750W"


		Default item=Chromecast_XE8005_Control icon=screen label="XE8005 Control"


	}


	Frame label="Working" {


		Slider item=Chromecast_XE8005_Volume icon=soundvolume label="XE8005 Volume"


	}


}

And so on...

Possible Solution

Steps to Reproduce (for Bugs)

1. Right Click -> Reformat File
2. Right Click -> Reformat File (again)
   ...
   N. Right Click -> Reformat File (again)

Context

Your Environment

• Version used: 1.3.12
• Operating System: WIndows 10

Hi, it would be nice to be able to indent just the selection.

I have a bunch of groups with subgroups at the top of my items file and they don't indent nicely with the rest of the items.

I also don't like how it removes my line spacings between groupings of items. Lastly some item names are too long so I don't want the rest to be indented to accommodate the odd long ones.

In short, indenting just the selection will solve this.

Problem

The extension doesn't show the option for formatting a sitemap

I enabled the beta features in the settings and restarted vs code. However this didn't help. Furthermore I tried reinstalling the extension, but no luck there either.

The tag for enabling the beta features is visible in the vscode settings file:

    "oh-alignment-tool.enableBetaFeatures": true,
    "[openhab]": {
        "editor.defaultFormatter": "max-beckenbauer.oh-alignment-tool"
    },

Am I missing something here?

Your Environment

• Version used: OpenHAB v2.5-10, Extension v2.0.8, VSCode v152.1
• Operating System: Win10

Example code:

String A {e="f"}
String Z {u="t"}

"Format document" does nothing.
But selecting all and execute "Format selection" works.

I think "format document" is broken in beta.3.

Maybe this is already possible.

But I think I would like to have the option to use spaces between the items parts instead of tabs.

This is how it looks at the moment.

Right now there is at least one tab after each part wich can be as big as 1 (between "B" and <cc> ) or up to 4 spaces (between <cc> and (D)).

I think it would look better and more organized if the minimum distance between two parts could be defined by the user, if he wants to use spaces instead of tabs.

Like "minimum 2 spaces":

Or "minimum 1 space):

"minimum 3 spaces:

My vscod settings are set to use spaces.

But I understand if this would be difficult to implement.
And I do not NEED this.
It would be nice to have, though. 😉

btw: The openHAB documentation uses a single space between the elements in the examples.
But I would prefer two spaces.

Is your feature request related to a problem? Please describe.
Can't auto format or with default shortcut

Describe the solution you'd like
I'ld like my files to be formatted on save just like js, java, md...

Describe alternatives you've considered
If the extension action "extension.reformat-file" was declared as formatter, we won't need to call the action with Ctrl + Shift + P

Additional context
https://code.visualstudio.com/blogs/2016/11/15/formatters-best-practices

I would like to see that the channel part of an item ( the part between the {} at the end of the line) uses a standard formatting.

Currently I have item files that have some different formatting. Making this uniform by the allignment tool would be great!

Example:

String Item1 "Item 1" (group) { channel="channel1" }
String Item2 "Item 2" (group) {channel="channel2" }

Hope you see the difference: at Item2 the is a space missing after the bracket ({)
I would like that the formatting can fix that too so every line will be the same.

Certain characters enclosed in "..." lead to misformatting and syntactical incorrect item-files.

Expected Behavior

The formatting should yield a working and syntactical correct item-file.

Current Behavior

On some "special characers" inside strings, the formatting fails to produce the correct syntax of an item file.

----before formatting-----
Contact Wetter_Aussentemperatur_Grenze2 "AT2 <20° [MAP(de.map):%s]" (Wetter) {knx="<3/1/15"}
----after formatting-----
Contact Wetter_Aussentemperatur_Grenze2 "AT2 <20° [MAP(de.map):%s]" <20° [MAP(de.map):%s]" <20° [MAP(de.map):%s]" {knx="<3/1/15"}

I suspect the less-than character "<" inside a string to fail the formatting.

Possible Solution

Improve special character handling.

Steps to Reproduce (for Bugs)

Format-Style "Column"

Hi,

i like to ask if *.stiemap would be supported.
i need it more for sitemap
Is there anything planned?

Example code:

Switch	A	"B"	{channel="e"}
// #OHNG#
Switch	A	"B"	<c>	{channel="e"}

Result:

When I add a new line in front of the tag it works:

Version: 2.0.7

The line

Group EG_Küche "Küche" <kitchen> (Home, Erdgeschoss) ["Kitchen"]

becomes

Group EG_K

after aligmnment.

The extension removes comments at the end of a line of code. The comment should be preserved.

https://community.openhab.org/t/vsc-openhab-alignment-tool/83406/37?u=miwok