Skip to content

thijsputman/home-assistant-config

Repository files navigation

Home Assistant Configuration

Lint codebase Docker — sysmon-mqtt

The live configuration of my personal Home Assistant instance.

Development

Linter / pre-commit

A combination of Prettier, markdownlint, yamllint, ShellCheck, shfmt, and hadolint is used via pre-commit to ensure consistent formatting and – where possible – more elaborate sanity-checking.

Pre-commit is used as a convenient way of generalising linter execution; its package management features are barely used – most of the linters in-use need to be installed locally anyway for their respective VS Code extensions...

To set up pre-commit, follow the below instructions. This assumes a system running Debian/Ubuntu with Node/npm, and Python3/pip already installed.

sudo apt install jq
./.github/scripts/setup-pre-commit.sh
pre-commit install

Extras

Apart from the Home Assistant configuration, this repository contains several "extras" that form a part of my Home Assistant setup too.

Thee most relevant ones are:

For a complete overview see the 📁 extras/ folder.

Further Reading

License

This repository is licensed under a Creative Commons Zero v1.0 Universal license, except for the contents of the 📁 docs/ and the 📁 extras/ folders which are licensed under a Creative Commons Attribution Share Alike 4.0 International license and a BSD-3-Clause license respectively.