Merge pull request emsesp#2238 from proddy/dev

comment cleanup
MichaelDvP · Nov 22, 2024 · 3680fad · 3680fad
2 parents 3752247 + c80ec36
commit 3680fad
Show file tree

Hide file tree

Showing 13 changed files with 607 additions and 610 deletions.
diff --git a/interface/.yarn/releases/yarn-4.5.1.cjs → interface/.yarn/releases/yarn-4.5.2.cjs b/interface/.yarn/releases/yarn-4.5.1.cjs → interface/.yarn/releases/yarn-4.5.2.cjs
diff --git a/interface/.yarnrc.yml b/interface/.yarnrc.yml
@@ -1,3 +1,3 @@
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.5.1.cjs
+yarnPath: .yarn/releases/yarn-4.5.2.cjs
diff --git a/interface/package.json b/interface/package.json
@@ -31,7 +31,7 @@
     "async-validator": "^4.2.5",
     "jwt-decode": "^4.0.0",
     "mime-types": "^2.1.35",
-    "preact": "^10.24.3",
+    "preact": "^10.25.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-icons": "^5.3.0",
@@ -63,5 +63,5 @@
     "vite-plugin-imagemin": "^0.6.1",
     "vite-tsconfig-paths": "^5.1.3"
   },
-  "packageManager": "[email protected].1"
+  "packageManager": "[email protected].2"
 }
diff --git a/interface/src/app/settings/Version.tsx b/interface/src/app/settings/Version.tsx
@@ -153,7 +153,12 @@ const Version = () => {
             onClick={() => setOpenDialog(false)}
             color="primary"
           >
-            <Link underline="none" target="_blank" href={getBinURL(useDev)} color="primary">
+            <Link
+              underline="none"
+              target="_blank"
+              href={getBinURL(useDev)}
+              color="primary"
+            >
               {LL.DOWNLOAD(1)}
             </Link>
           </Button>

diff --git a/interface/src/components/routing/RouterTabs.tsx b/interface/src/components/routing/RouterTabs.tsx
@@ -16,7 +16,7 @@ const RouterTabs: FC<RouterTabsProps> = ({ value, children }) => {
   const smallDown = useMediaQuery(theme.breakpoints.down('sm'));
 
   const handleTabChange = (_event: unknown, path: string) => {
-    navigate(path);
+    void navigate(path);
   };
 
   return (

diff --git a/interface/yarn.lock b/interface/yarn.lock
@@ -1721,7 +1721,7 @@ __metadata:
     formidable: "npm:^3.5.2"
     jwt-decode: "npm:^4.0.0"
     mime-types: "npm:^2.1.35"
-    preact: "npm:^10.24.3"
+    preact: "npm:^10.25.0"
     prettier: "npm:^3.3.3"
     react: "npm:^18.3.1"
     react-dom: "npm:^18.3.1"
@@ -5635,10 +5635,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"preact@npm:^10.24.3":
-  version: 10.24.3
-  resolution: "preact@npm:10.24.3"
-  checksum: 10c0/c863df6d7be6a660480189762d8a8f2d4148733fc2bb9efbd9d2fd27315d2c7ede850a16077d716c91666c915c0349bd3c9699733e4f08457226a0519f408761
+"preact@npm:^10.25.0":
+  version: 10.25.0
+  resolution: "preact@npm:10.25.0"
+  checksum: 10c0/703e021e7a268aea929e9c896484608e18dd9f5aa62c71d3205fedf69269d9592e4cfe17adda78ca4cec1f5f0057a062300daeeb477333ba2005a4d9e3fbc970
   languageName: node
   linkType: hard
 

diff --git a/mock-api/.yarn/releases/yarn-4.5.1.cjs → mock-api/.yarn/releases/yarn-4.5.2.cjs b/mock-api/.yarn/releases/yarn-4.5.1.cjs → mock-api/.yarn/releases/yarn-4.5.2.cjs
diff --git a/mock-api/.yarnrc.yml b/mock-api/.yarnrc.yml
@@ -1,3 +1,3 @@
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.5.1.cjs
+yarnPath: .yarn/releases/yarn-4.5.2.cjs
diff --git a/mock-api/package.json b/mock-api/package.json
@@ -15,5 +15,5 @@
     "itty-router": "^5.0.18",
     "prettier": "^3.3.3"
   },
-  "packageManager": "[email protected].1"
+  "packageManager": "[email protected].2"
 }
diff --git a/scripts/generate-modbus-register-doc.py b/scripts/generate-modbus-register-doc.py
@@ -104,7 +104,7 @@ def printDeviceTypeDevices(device_type, devices):
 print()
 print("!!! note")
 print()
-print("    This file has been auto-generated. Do not edit.")
+print("    This file has been auto-generated. Do not modify.")
 print()
 
 for device_type, devices in grouped_by(entities, device_type_key):

diff --git a/scripts/generate_csv_and_headers.sh b/scripts/generate_csv_and_headers.sh
@@ -2,17 +2,15 @@
 
 #
 # Builds the dump CSV files, modbus headers and documentation.
-# To be run before a release with
-#   sh ./scripts/generate_csv_and_headers.sh
-#
+# Called by /scripts/generate_csv_and_headers.sh
 
 # build dummy modbus_entity_parameters.hpp  so it compiles
 cat >./src/modbus_entity_parameters.hpp <<EOL
 #include "modbus.h"
 #include "emsdevice.h"
 
 /*
- * This file is auto-generated by the update_modbus_registers.sh script. Do not modify.
+ * This file is auto-generated. Do not modify.
 */
 
 // clang-format off

diff --git a/scripts/update_modbus_registers.py b/scripts/update_modbus_registers.py
@@ -1,13 +1,7 @@
 #
 # Update modbus parameters from entity definitions.
 # This script generates c++ code for the modbus parameter definitions.
-#
-# Usage:
-# - first, dump all entities to csv by running 'sh ./scripts/dump_entities.sh'
-# - then run 'cat ../dump_entities.csv | python3 update_modbus_registers.py > ../src/modbus_entity_parameters.hpp'
-#   from the "scripts" folder
-# OR
-#  run `sh ./scripts/update_modbus_registers.sh` from the root folder
+# Called by /scripts/generate_csv_and_headers.sh
 
 import fileinput
 import csv
@@ -118,7 +112,7 @@
 #include "emsdevice.h"
 
 /*
- * This file is auto-generated by the update_modbus_registers.sh script. Do not modify.
+ * This file is auto-generated. Do not modify.
  */
 
 // clang-format off

diff --git a/src/modbus_entity_parameters.hpp b/src/modbus_entity_parameters.hpp
@@ -2,7 +2,7 @@
 #include "emsdevice.h"
 
 /*
- * This file is auto-generated by the update_modbus_registers.sh script. Do not modify.
+ * This file is auto-generated. Do not modify.
  */
 
 // clang-format off