OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Describe XSD schema requirement and IDE validation tools (#2629) 

Also-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
pull/2634/head
Andrew Fiddian-Green 2026-01-04 16:16:16 +00:00 committed by GitHub
parent 2c62fcc38e
commit 3cb58eca89
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
developers/guidelines.md
View File

@ -93,6 +93,16 @@ The rules are defined using the Eclipse Java Formatter definitions. There are pl
The rules are defined at <https://github.com/openhab/static-code-analysis/tree/main/codestyle/src/main/resources> for the Eclipse WTP formatter, but will have to be manually entered into your IDE.
#### XML files for Thing-Type Definitions
Thing-Type definitions must comply with the [thing-description-1.0.0.xsd schema](https://www.openhab.org/schemas/thing-description-1.0.0.xsd).
To enable automatic schema validation in your IDE you many need to do the following:
- Eclipse: Download the latest copy of `thing-description-1.0.0.xsd` to your `.lemminx\cache\https\openhab.org\schemas` cache folder.
- IntelliJ: Put the cursor into the `xsi:schemeLocation` field of the XML, trigger the <kbd>Alt</kbd><kbd>Enter</kbd> shortcut and select _Fetch external resource_.
- Visual Studio Code: Install the XML extension from Red Hat.
### Java Coding Style
- The [Java naming conventions](https://java.about.com/od/javasyntax/a/nameconventions.htm) should always be used and are described in detail at the link, a quick summary is: