diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml index e47ffda..4e20557 100644 --- a/.github/workflows/markdownlint.yml +++ b/.github/workflows/markdownlint.yml @@ -11,9 +11,7 @@ jobs: with: config: '.markdownlint.yaml' globs: | - README.md - CHANGELOG.md - docs/*.md + **/*.md !docs/changelog.md !docs/index.md !docs/license.md \ No newline at end of file diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 0000000..4a1510f --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1,3 @@ +docs/changelog.md +docs/index.md +docs/license.md \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4498795..fd8d4f5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -21,3 +21,10 @@ repos: types: [python] require_serial: true files: ^(docker2mqtt)/.+\.py$ + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.41.0 + hooks: + - id: markdownlint + args: ["--disable=MD013"] + - id: markdownlint-fix + args: ["--disable=MD013", "--fix"] diff --git a/.vscode/settings.json b/.vscode/settings.json index 246faae..834ea3f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -8,6 +8,7 @@ "gethostname", "HOMEASSISTANT", "levelname", + "markdownlint", "memorylimit", "memoryused", "miaucl", diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 14543b3..06db384 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -4,7 +4,7 @@ "version": "2.0.0", "tasks": [ { - "label": "Python: Build docker2mqtt docker image", + "label": "Docker: Build docker2mqtt image", "type": "shell", "command": "docker build --tag docker2mqtt:latest .", "problemMatcher": [], @@ -49,7 +49,7 @@ } }, { - "label": "Python: Run docker2mqtt commit hooks", + "label": "pre-commit: run all files", "type": "shell", "command": "pre-commit run --all-files", "problemMatcher": [], diff --git a/README.md b/README.md index 2911dbb..57094ef 100755 --- a/README.md +++ b/README.md @@ -82,8 +82,8 @@ You can use environment variables to control the behavior. | `mqtt_client_id`| `MQTT_CLIENT_ID` | `mqtt2discord` | The client id to send to the MQTT broker. | | `mqtt_host`| `MQTT_HOST` | `localhost` | The MQTT broker to connect to. | | `mqtt_port`| `MQTT_PORT` | `1883` | The port on the broker to connect to. | -| `mqtt_user`| `MQTT_USER` | `` | The user to send to the MQTT broker. Leave unset to disable authentication. | -| `mqtt_password`| `MQTT_PASSWD` | `` | The password to send to the MQTT broker. Leave unset to disable authentication. | +| `mqtt_user`| `MQTT_USER` | | The user to send to the MQTT broker. Leave unset to disable authentication. | +| `mqtt_password`| `MQTT_PASSWD` | | The password to send to the MQTT broker. Leave unset to disable authentication. | | `mqtt_timeout`| `MQTT_TIMEOUT` | `30` | The timeout for the MQTT connection. | | `mqtt_topic_prefix`| `MQTT_TOPIC_PREFIX` | `ping` | The MQTT topic prefix. With the default data will be published to `ping/`. | | `mqtt_qos`| `MQTT_QOS` | `1` | The MQTT QOS level | @@ -144,7 +144,3 @@ Following VSCode integrations may be helpful: ## Credits This is a detached fork from the repo , which does not seem to get evolved anymore. - - -TODO: -- cli interface \ No newline at end of file