Rework lint (esphome#1924)

BoukeHaarsma23 · Feb 20, 2022 · 4ee8df7 · 4ee8df7
1 parent 1a1baf9
commit 4ee8df7
Show file tree

Hide file tree

Showing 44 changed files with 507 additions and 313 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,27 +1,27 @@
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.183.0/containers/python-3
 {
-	"name": "ESPHome - docs",
-	"image": "mcr.microsoft.com/vscode/devcontainers/python:0-3.6",
-	"postCreateCommand": "pip3 install -r requirements.txt",
-	"forwardPorts": [8000],
-	"settings": { 
-		"python.pythonPath": "/usr/local/bin/python",
-		"python.languageServer": "Pylance",
-		"python.linting.enabled": true,
-		"python.linting.pylintEnabled": true,
-		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
-		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
-		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
-		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
-		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
-		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
-		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
-	},
+    "name": "ESPHome - docs",
+    "image": "mcr.microsoft.com/vscode/devcontainers/python:0-3.6",
+    "postCreateCommand": "pip3 install -r requirements.txt -r requirements_test.txt",
+    "forwardPorts": [8000],
+    "settings": { 
+        "python.pythonPath": "/usr/local/bin/python",
+        "python.languageServer": "Pylance",
+        "python.linting.enabled": true,
+        "python.linting.pylintEnabled": true,
+        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+    },
 
-	"extensions": [
-		"ms-python.python",
-		"ms-python.vscode-pylance"
-	]
+    "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+    ]
 }
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -25,8 +25,12 @@ jobs:
       with:
         python-version: 3.8
     - name: Install dependencies
-      run: pip install -r requirements.txt
-    - name: Lint
+      run: pip install -r requirements.txt -r requirements_test.txt
+    - name: Register problem matchers
       run: |
-        python travis.py
-        make html-strict
+        echo "::add-matcher::.github/workflows/matchers/ci-custom.json"
+
+    - name: Lint
+      run: python lint.py
+    - name: html-strict
+      run: make html-strict
diff --git a/.github/workflows/matchers/ci-custom.json b/.github/workflows/matchers/ci-custom.json
@@ -0,0 +1,16 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "ci-custom",
+            "pattern": [
+                {
+                    "regexp": "^(.*):(\\d+):(\\d+):\\s+lint:\\s+(.*)$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3,
+                    "message": 4
+                }
+            ]
+        }
+    ]
+}
diff --git a/.travis.yml b/.travis.yml
diff --git a/Makefile b/Makefile
@@ -51,7 +51,7 @@ copy-svg2png:
 netlify: netlify-dependencies netlify-api html copy-svg2png
 
 lint: html-strict
-	python3 travis.py
+	python3 lint.py
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/changelog/2022.2.0.rst b/changelog/2022.2.0.rst
@@ -17,7 +17,7 @@ ESPHome 2022.2.0 - 16th February 2022
 
     Touchscreen Core, components/touchscreen/index, folder-open.svg
     EKTF2232, components/touchscreen/ektf2232, ektf2232.svg
-    Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.png
+    Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg
     MLX90393, components/sensor/mlx90393, mlx90393.jpg
 
     Wake-on-LAN Button, components/button/wake_on_lan, power_settings.svg

diff --git a/components/climate/ir_climate.rst b/components/climate/ir_climate.rst
diff --git a/components/sensor/images/dsmr-request-pin-circuit-example.png b/components/sensor/images/dsmr-request-pin-circuit-example.png
diff --git a/components/sensor/pmsa003i.rst b/components/sensor/pmsa003i.rst
@@ -3,7 +3,7 @@ PMSA003I Particulate Matter Sensor
 
 .. seo::
     :description: Instructions for setting up PMSX003 Particulate matter sensors
-    :image: pmsa003i-full.jpg
+    :image: pmsa003i.jpg
 
 The ``pmsa003i`` sensor platform  allows you to use your Plantower PMSA003I
 particulate matter sensor

diff --git a/components/switch/images/safemode-ui.png b/components/switch/images/safemode-ui.png
diff --git a/components/touchscreen/lilygo_t5_47.rst b/components/touchscreen/lilygo_t5_47.rst
@@ -3,7 +3,7 @@ Lilygo T5 4.7" Touchscreen
 
 .. seo::
     :description: Instructions for setting up the Lilygo T5 4.7" Touchscreen with ESPHome
-    :image: lilygo_t5_47_touch.png
+    :image: lilygo_t5_47_touch.jpg
     :keywords: Lilygo T5 4.7" Touchscreen
 
 The ``liygo_t5_47`` touchscreen platform allows using the touchscreen controller

diff --git a/cookbook/images/leak-detector-m5stickC_LeakDetected.gif b/cookbook/images/leak-detector-m5stickC_LeakDetected.gif
diff --git a/devices/images/sonoff_t1_uk_3g_backplate_v1.1.jpg b/devices/images/sonoff_t1_uk_3g_backplate_v1.1.jpg
diff --git a/devices/images/sonoff_t1_uk_3g_touchpads_v1.1.jpg b/devices/images/sonoff_t1_uk_3g_touchpads_v1.1.jpg
diff --git a/images/donate-patreon.png b/images/donate-patreon.png
diff --git a/images/donate-paypal.png b/images/donate-paypal.png
diff --git a/images/esp32-modbus.jpg b/images/esp32-modbus.jpg
diff --git a/images/improv-social.png b/images/improv-social.png
diff --git a/images/index.rst b/images/index.rst
@@ -4,22 +4,10 @@ Images
 This is a dummy file to include images in the sphinx output
 that will only be used in raw HTML and thus not auto-included.
 
-.. image:: shield-donate.svg
-
 .. image:: hero.png
 
 .. image:: logo.svg
 
-.. image:: logo-core.svg
-
 .. image:: logo-docs.svg
 
-.. image:: logo-flasher.svg
-
-.. image:: logo-release.svg
-
 .. image:: logo-text.svg
-
-.. image:: donate-patreon.png
-
-.. image:: donate-paypal.png
diff --git a/images/lilygo_t5_47_touch.jpg b/images/lilygo_t5_47_touch.jpg
diff --git a/images/lilygo_t5_47_touch.png b/images/lilygo_t5_47_touch.png
diff --git a/images/mcp3008.jpg b/images/mcp3008.jpg
diff --git a/images/mcp3204.jpg b/images/mcp3204.jpg
diff --git a/images/pipsolar.jpg b/images/pipsolar.jpg
diff --git a/images/pmsa003i-full.jpg b/images/pmsa003i-full.jpg
diff --git a/images/pwm.png b/images/pwm.png
diff --git a/images/rf_bridge.jpg b/images/rf_bridge.jpg
diff --git a/images/rs485.jpg b/images/rs485.jpg
diff --git a/images/scd30.jpg b/images/scd30.jpg
diff --git a/images/sgp40.jpg b/images/sgp40.jpg
diff --git a/images/shield-donate.svg b/images/shield-donate.svg
diff --git a/images/sht4x.jpg b/images/sht4x.jpg
diff --git a/images/sps30.jpg b/images/sps30.jpg
diff --git a/images/teleinfo-full.jpg b/images/teleinfo-full.jpg
diff --git a/images/tuya.png b/images/tuya.png
diff --git a/images/vl53l0x.jpg b/images/vl53l0x.jpg
diff --git a/images/xiaomi_miscale1&2.jpg b/images/xiaomi_miscale1&2.jpg
diff --git a/images/xiaomi_miscale2.jpg b/images/xiaomi_miscale2.jpg
diff --git a/index.rst b/index.rst
@@ -539,7 +539,7 @@ Touchscreen Components
 
     Touchscreen Core, components/touchscreen/index, folder-open.svg
     EKTF2232, components/touchscreen/ektf2232, ektf2232.svg, Inkplate 6 Plus
-    Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.png
+    Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg
 
 Cover Components
 ----------------
@@ -720,7 +720,6 @@ documentation for others to copy. See :doc:`Contributing </guides/contributing>`
     :hidden:
 
     web-api/index
-    misc/index
     components/index
     cookbook/index
     devices/index