Lint

spuder · Nov 21, 2024 · fce3f1b · fce3f1b
1 parent 35f63eb
commit fce3f1b
Show file tree

Hide file tree

Showing 26 changed files with 98 additions and 113 deletions.
diff --git a/.github/workflows/contributors.yaml b/.github/workflows/contributors.yaml
@@ -1,17 +1,17 @@
+---
 on:
-    push:
-        branches:
-            - main
-
+  push:
+    branches:
+      - main
 jobs:
-    contrib-readme-job:
-        runs-on: ubuntu-latest
-        name: A job to automate contrib in readme
-        permissions:
-          contents: write
-          pull-requests: write
-        steps:
-            - name: Contribute List
-              uses: akhilmhdh/[email protected]
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  contrib-readme-job:
+    runs-on: ubuntu-latest
+    name: A job to automate contrib in readme
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Contribute List
+        uses: akhilmhdh/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/pages-version.yaml b/.github/workflows/pages-version.yaml
@@ -1,39 +1,37 @@
+---
 name: Update Documentation Version
 on:
   push:
     branches: ["main"]
     paths:
       - 'artifacts/manifest.json'
-
 jobs:
   update-docs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-            token: ${{ secrets.PAT }}
-
+          token: ${{ secrets.PAT }}
       # Replace the badge with the latest version
       # https://img.shields.io/badge/esp32s2-0.1.0-magenta
       - name: Read manifest and update docs
         run: |
-            # Read version from manifest.json
-            VERSION=$(jq -r .version artifacts/manifest.json)
-
-            echo "VERSION=$VERSION"
-            sed -i 's/badge\/openspool-[^-]*-magenta/badge\/openspool-'"$VERSION"'-magenta/' docs/index.md
-            sed -i 's/badge\/openspool-[^-]*-magenta/badge\/openspool-'"$VERSION"'-magenta/' README.md
-            echo "docs/index.md"
-            cat docs/index.md | grep shields.io
-            echo "README.md"
-            cat README.md | grep shields.io
+          # Read version from manifest.json
+          VERSION=$(jq -r .version artifacts/manifest.json)
 
+          echo "VERSION=$VERSION"
+          sed -i 's/badge\/openspool-[^-]*-magenta/badge\/openspool-'"$VERSION"'-magenta/' docs/index.md
+          sed -i 's/badge\/openspool-[^-]*-magenta/badge\/openspool-'"$VERSION"'-magenta/' README.md
+          echo "docs/index.md"
+          cat docs/index.md | grep shields.io
+          echo "README.md"
+          cat README.md | grep shields.io
       - name: Commit manifest file
         uses: EndBug/add-and-commit@v9
         with:
           committer_name: GitHub Actions
-          committer_email: [email protected]      
+          committer_email: [email protected]
           message: Update manifest.json
           add: "docs/*.md README.md"
-          push: true
+          push: true
diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml
@@ -1,38 +1,34 @@
+---
 # This workflow uses actions that are not certified by GitHub.
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
 # documentation.
 
 # Sample workflow for building and deploying a Jekyll site to GitHub Pages
 name: OpenSpool.io Docs
-
 on:
   push:
     branches: ["main"]
     paths:
       - "docs/**"
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
-
 # Allow one concurrent deployment
 concurrency:
   group: "pages"
   cancel-in-progress: true
-
 jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
     defaults:
-        run:
-          working-directory: docs
+      run:
+        working-directory: docs
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -43,7 +39,6 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
           cache-version: 0 # Increment this number if you need to re-download cached gems
           working-directory: '${{ github.workspace }}/docs'
-
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
@@ -56,9 +51,7 @@ jobs:
         # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v3
         with:
-            path: "docs/_site/"
-
-
+          path: "docs/_site/"
   # Deployment job
   deploy:
     environment:
@@ -69,4 +62,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,17 +1,21 @@
+---
 repos:
-  - repo: https://github.com/google/yamlfmt
-    rev: v0.10.0
-    hooks:
-      - id: yamlfmt
+  # yamllint has trouble with scalars like '- lambda: |- '
+  # - repo: https://github.com/google/yamlfmt
+  #   rev: v0.10.0
+  #   hooks:
+  #     - id: yamlfmt
   - repo: local
     hooks:
       - id: esphome-config-solo
         name: ESPHome Compile Solo
         entry: bash -c 'podman run -v "$(pwd)/firmware:/data" --rm ghcr.io/esphome/esphome:2024.11.0 config /data/config-solo.yaml'
         language: system
         pass_filenames: false
+        files: ^firmware/
       - id: esphome-config-ams
         name: ESPHome Compile AMS
         entry: bash -c 'podman run -v "$(pwd)/firmware:/data" --rm ghcr.io/esphome/esphome:2024.11.0 config /data/config-ams.yaml'
         language: system
         pass_filenames: false
+        files: ^firmware/
diff --git a/.yamlfmt b/.yamlfmt
@@ -0,0 +1,8 @@
+formatter:
+  indent: 2
+  line_ending: lf
+  include_document_start: true
+  colons: align
+  scan_folded_as_literal: true
+  disallow_anchors: false
+  retain_line_breaks: true
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,22 +1,16 @@
+---
 title: OpenSpool
 description: Your filament wants to be free
 theme: just-the-docs
-
 url: https://openspool.io
-
 aux_links:
-  "Edit this page on Github": 
+  "Edit this page on Github":
     - https://github.com/spuder/openspool
-
 logo: "images/OpenSpoolLogoMedium1.png"
-
 favicon: "images/favicon.ico"
-
 color_scheme: dark
-
 plugins:
   - jekyll-default-layout
-
 head_scripts:
   # https://github.com/esphome/esp-web-tools/issues/515#issuecomment-2387664391
   # - https://unpkg.com/@improv-wifi/[email protected]/dist/serial.min.js?module
@@ -27,12 +21,11 @@ defaults:
       path: "assets/js"
     values:
       js: true
-
 callouts:
   warning:
     title: Warning
     color: red
-  note: 
+  note:
     title: Note
     color: blue
   important:
@@ -42,7 +35,6 @@ callouts:
     title: Caution
     color: yellow
 
-
 # footer_content: "Copyright &copy; 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
 
 # # Footer "Edit this page on GitHub" link text
@@ -51,4 +43,4 @@ callouts:
 # gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
 # gh_edit_branch: "main" # the branch that your docs is served from
 # # gh_edit_source: docs # the source that your files originate from
-# gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+# gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
diff --git a/firmware/common.yaml b/firmware/common.yaml
@@ -1,3 +1,4 @@
+---
 substitutions:
   name: openspool
   version: "0.0.0" # Keep this at 0.0.0 as github-actions will modify this file at build time

diff --git a/firmware/conf.d/automation.yaml b/firmware/conf.d/automation.yaml
@@ -1,3 +1,4 @@
+---
 script:
   - id: preview_rfid_data
     then:
@@ -7,7 +8,7 @@ script:
             auto pretty_json = [=]() -> std::string {
               StaticJsonDocument<256> doc;
               JsonObject root = doc.to<JsonObject>();
-              
+
               root["protocol"] = "openspool";
               root["version"] = "1.0";
               root["brand"] = id(filament_brand).state.c_str();
@@ -82,7 +83,7 @@ script:
                   } else {
                     return true;
                   }
-              # TODO: Check if mqtt is enabled once this is merged: https://github.com/esphome/esphome/pull/7716
+                # TODO: Check if mqtt is enabled once this is merged: https://github.com/esphome/esphome/pull/7716
           then:
             - mqtt.publish:
                 # topic: device/${bambu_serial_number}/request

diff --git a/firmware/conf.d/bambu_printer.yaml b/firmware/conf.d/bambu_printer.yaml
@@ -1,3 +1,4 @@
+---
 select:
   #TODO: printer model is currently unused, but will be needed for setting AMS type
   - platform: template

diff --git a/firmware/conf.d/button.yaml b/firmware/conf.d/button.yaml
@@ -1,3 +1,4 @@
+---
 binary_sensor:
   - platform: gpio
     id: physical_button

diff --git a/firmware/conf.d/debug.yaml b/firmware/conf.d/debug.yaml
@@ -1,9 +1,8 @@
+---
 # NOTE None of these metrics are available until device is connected to MQTT
 # This feels like a bug, but not sure why
-
 debug:
   update_interval: 5s
-
 logger:
   level: debug
   logs:
@@ -17,7 +16,6 @@ text_sensor:
   #   state_topic:
   #   # web_server:
   #   #   sorting_group_id: sorting_group_info
-
   - platform: template
     name: "OpenSpool Version"
     lambda: |-
@@ -26,15 +24,13 @@ text_sensor:
     icon: mdi:new-box
     web_server:
       sorting_group_id: sorting_group_info
-
   - platform: debug
     # device:
     #   name: "Device Info"
     #   state_topic:
     reset_reason:
       name: "Reset Reason"
       state_topic:
-
 sensor:
   - platform: debug
     free:

diff --git a/firmware/conf.d/filament.yaml b/firmware/conf.d/filament.yaml
@@ -1,3 +1,4 @@
+---
 # Bambu Filament mappings
 # Credit to WolfWithSword for figuring all these out
 # https://gist.github.com/WolfwithSword/e3e4dc4f00629cc047b7cefd70d7b350#file-bambu_mqtt-json-L314
@@ -24,7 +25,6 @@ select:
         - script.execute: generate_filament_brand_code
         - script.execute: generate_filament_temperatures
         - script.execute: preview_rfid_data
-
   - platform: template
     name: "Filament Variant"
     id: filament_variant
@@ -45,7 +45,6 @@ select:
         - script.execute: generate_filament_brand_code
         - script.execute: preview_rfid_data
         - script.execute: generate_filament_temperatures #TODO: not fully implemented for variants yet
-
   - platform: template
     name: "Filament Brand"
     id: filament_brand
@@ -162,7 +161,6 @@ select:
                 return "";
               }
         - script.execute: preview_rfid_data
-
 number:
   - platform: template
     name: "Filament Min Temp"
@@ -186,7 +184,6 @@ number:
     on_value:
       then:
         - script.execute: preview_rfid_data
-
   - platform: template
     name: "Filament Max Temp"
     id: filament_max_temp
@@ -210,7 +207,6 @@ number:
     on_value:
       then:
         - script.execute: preview_rfid_data
-
 text_sensor:
   - platform: template
     name: "Filament Brand Code"
@@ -222,7 +218,6 @@ text_sensor:
     on_value:
       then:
         - script.execute: preview_rfid_data
-
   - platform: template
     name: "Filament Color Hex"
     id: filament_color_hex
@@ -239,7 +234,6 @@ text_sensor:
               id(filament_color_hex_bambu).publish_state("");
             }
         - script.execute: preview_rfid_data
-
   - platform: template
     name: "Filament Color Hex Bambu"
     id: filament_color_hex_bambu
@@ -250,7 +244,6 @@ text_sensor:
     on_value:
       then:
         - script.execute: preview_rfid_data
-
   - platform: template
     name: Filament Sub Brand
     id: filament_sub_brand
@@ -261,7 +254,6 @@ text_sensor:
     on_value:
       then:
         - script.execute: preview_rfid_data
-
 button:
   - platform: template
     id: upload_filament_settings

diff --git a/firmware/conf.d/improv.yaml b/firmware/conf.d/improv.yaml
@@ -1,2 +1,3 @@
+---
 improv_serial:
-  # next_url: "http://{{ip_address}}"
+# next_url: "http://{{ip_address}}"