Merge remote-tracking branch 'origin/main' into main-tokazio

# Conflicts:
#	app/src/keymap.c

Author: romain-petit-whoz

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/zmkfirmware/zmk-dev-arm:3.0
+FROM docker.io/zmkfirmware/zmk-dev-arm:3.2
 
 COPY .bashrc tmp
 RUN mv /tmp/.bashrc ~/.bashrc

.github/pull_request_template.md

@@ -1,13 +1,15 @@
 <!-- If you're adding a board/shield please fill out this check-list, otherwise you can delete it -->
+
 ## Board/Shield Check-list
- - [ ] This board/shield is tested working on real hardware
- - [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield))
- - [ ] `.zmk.yml` metadata file added
- - [ ] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
- - [ ] General consistent formatting of DeviceTree files
- - [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader))
- - [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable
- - [ ] If split, no name added for the right/peripheral half
- - [ ] Kconfig.defconfig file correctly wraps *all* configuration in conditional on the shield symbol
- - [ ] `.conf` file has optional extra features commented out
- - [ ] Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)
+
+- [ ] This board/shield is tested working on real hardware
+- [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield))
+- [ ] `.zmk.yml` metadata file added
+- [ ] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
+- [ ] General consistent formatting of DeviceTree files
+- [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader))
+- [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable
+- [ ] If split, no name added for the right/peripheral half
+- [ ] Kconfig.defconfig file correctly wraps _all_ configuration in conditional on the shield symbol
+- [ ] `.conf` file has optional extra features commented out
+- [ ] Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)

.github/workflows/build-user-config.yml

@@ -19,8 +19,8 @@ on:
         required: false
         type: string
       archive_name:
-        description: 'Archive output file name'
-        default: 'firmware'
+        description: "Archive output file name"
+        default: "firmware"
         required: false
         type: string
 
@@ -39,8 +39,8 @@ jobs:
 
       - name: Fetch Build Matrix
         run: |
-          echo "build_matrix=$(yaml2json ${{ inputs.build_matrix_path }} | jq -c .)" >> $GITHUB_ENV
-          yaml2json ${{ inputs.build_matrix_path }} | jq
+          echo "build_matrix=$(yaml2json '${{ inputs.build_matrix_path }}' | jq -c .)" >> $GITHUB_ENV
+          yaml2json "${{ inputs.build_matrix_path }}" | jq
 
   build:
     runs-on: ubuntu-latest
@@ -54,18 +54,13 @@ jobs:
     steps:
       - name: Prepare variables
         shell: sh -x {0}
+        env:
+          shield: ${{ matrix.shield }}
         run: |
-          if [ -n "${{ matrix.shield }}" ]
-          then
-            echo "extra_cmake_args=-DSHIELD=\"${{ matrix.shield }}\"" >> $GITHUB_ENV
-            echo "artifact_name=${{ matrix.shield }}-${{ matrix.board }}-zmk" >> $GITHUB_ENV
-            echo "display_name=${{ matrix.shield }} - ${{ matrix.board }}" >> $GITHUB_ENV
-          else
-            echo "extra_cmake_args=" >> $GITHUB_ENV
-            echo "artifact_name=${{ matrix.board }}-zmk" >> $GITHUB_ENV
-            echo "display_name=${{ matrix.board }}" >> $GITHUB_ENV
-          fi
           echo "zephyr_version=${ZEPHYR_VERSION}" >> $GITHUB_ENV
+          echo "extra_cmake_args=${shield:+-DSHIELD=\"$shield\"}" >> $GITHUB_ENV
+          echo "display_name=${shield:+$shield - }${{ matrix.board }}" >> $GITHUB_ENV
+          echo "artifact_name=${shield:+$shield-}${{ matrix.board }}-zmk" >> $GITHUB_ENV
 
       - name: Checkout
         uses: actions/checkout@v3
@@ -89,7 +84,7 @@ jobs:
             ${{ runner.os }}-
 
       - name: West Init
-        run: west init -l ${{ inputs.config_path }}
+        run: west init -l "${{ inputs.config_path }}"
 
       - name: West Update
         run: west update
@@ -99,7 +94,7 @@ jobs:
 
       - name: West Build (${{ env.display_name }})
         shell: sh -x {0}
-        run: west build -s zmk/app -b ${{ matrix.board }} -- -DZMK_CONFIG=${GITHUB_WORKSPACE}/${{ inputs.config_path }} ${{ env.extra_cmake_args }} ${{ matrix.cmake-args }}
+        run: west build -s zmk/app -b "${{ matrix.board }}" -- -DZMK_CONFIG="${GITHUB_WORKSPACE}/${{ inputs.config_path }}" ${{ env.extra_cmake_args }} ${{ matrix.cmake-args }}
 
       - name: ${{ env.display_name }} Kconfig file
         run: grep -v -e "^#" -e "^$" build/zephyr/.config | sort
@@ -113,7 +108,7 @@ jobs:
             cp build/zephyr/zmk.uf2 "build/artifacts/${{ env.artifact_name }}.uf2"
           elif [ -f build/zephyr/zmk.${{ inputs.fallback_binary }} ]
           then
-            cp build/zephyr/zmk.${{ inputs.fallback_binary }} "build/artifacts/${{ env.artifact_name }}.${{ inputs.fallback_binary }}"
+            cp "build/zephyr/zmk.${{ inputs.fallback_binary }}" "build/artifacts/${{ env.artifact_name }}.${{ inputs.fallback_binary }}"
           fi
 
       - name: Archive (${{ env.display_name }})

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
     if: ${{ always() }}
     runs-on: ubuntu-latest
     container:
-      image: docker.io/zmkfirmware/zmk-build-arm:3.0
+      image: docker.io/zmkfirmware/zmk-build-arm:3.2
     needs: compile-matrix
     strategy:
       matrix:
@@ -131,7 +131,7 @@ jobs:
             for (const configuration of combinedUnique) {
               if (!perBoard[configuration.board])
                 perBoard[configuration.board] = [];
-              
+
               perBoard[configuration.board].push({
                 shield: configuration.shield,
                 'cmake-args': configuration['cmake-args'],
@@ -234,7 +234,7 @@ jobs:
                         };
                       }
                     } else if (hm.exposes) {
-                      return hm.exposes.flatMap(i => 
+                      return hm.exposes.flatMap(i =>
                         metadata.interconnects[i].shields.flatMap(s => boardAndShield(hm, s))
                       );
                     } else {
@@ -243,7 +243,7 @@ jobs:
                     break;
                   case "shield":
                     if (hm.features && hm.features.includes("keys")) {
-                      return hm.requires.flatMap(i => 
+                      return hm.requires.flatMap(i =>
                         metadata.interconnects[i].boards.flatMap(b => boardAndShield(b, hm))
                       );
                     } else {

.github/workflows/clang-format-lint.yml

@@ -21,16 +21,6 @@ jobs:
       - name: ESLint
         run: npm run lint
         working-directory: docs
-  prettier:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: bahmutov/npm-install@v1
-        with:
-          working-directory: docs
-      - name: Prettier check
-        run: npm run prettier:check
-        working-directory: docs
   typecheck:
     runs-on: ubuntu-latest
     steps:

.github/workflows/doc-checks.yml

@@ -15,21 +15,10 @@ on:
       - "app/scripts/west_commands/metadata.py"
 
 jobs:
-  check-metadata-format:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/checkout@v3
-      - uses: bahmutov/npm-install@v1
-        with:
-          working-directory: app
-      - name: Prettier Check
-        run: npm run prettier:check
-        working-directory: app
   validate-metadata:
     runs-on: ubuntu-latest
     container:
-      image: docker.io/zmkfirmware/zmk-dev-arm:3.0
+      image: docker.io/zmkfirmware/zmk-dev-arm:3.2
     steps:
       - uses: actions/checkout@v3
       - name: Install dependencies

.github/workflows/hardware-metadata-validation.yml

@@ -0,0 +1,15 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: pre-commit/[email protected]

.github/workflows/pre-commit.yml

@@ -33,7 +33,7 @@ jobs:
         test: ${{ fromJSON(needs.collect-tests.outputs.test-dirs) }}
     runs-on: ubuntu-latest
     container:
-      image: docker.io/zmkfirmware/zmk-build-arm:3.0
+      image: docker.io/zmkfirmware/zmk-build-arm:3.2
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/test.yml

@@ -1,12 +1,28 @@
 fail_fast: false
 repos:
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.1
+    hooks:
+      - id: remove-tabs
+        exclude: "vendor-prefixes\\.txt$"
   - repo: https://github.com/pocc/pre-commit-hooks
-    rev: v1.1.1
+    rev: v1.3.5
     hooks:
       - id: clang-format
         args:
           - -i
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.2.1
+    rev: v2.7.1
     hooks:
       - id: prettier
+        # Workaround for https://github.com/pre-commit/mirrors-prettier/issues/29
+        additional_dependencies:
+          - [email protected]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-shebang-scripts-are-executable
+        exclude: "\\.mustache$"

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "ms-python.python",
+    "ms-vscode.cpptools",
+    "plorefice.devicetree",
+    "twxs.cmake"
+  ]
+}

.vscode/extensions.json

@@ -3,5 +3,20 @@
     "*.overlay": "dts",
     "*.keymap": "dts"
   },
-  "python.formatting.provider": "black"
-}
+  "python.formatting.provider": "black",
+  "[c]": {
+    "editor.formatOnSave": true
+  },
+  "[javascript][javascriptreact][typescript][typescriptreact]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "ms-python.python"
+  },
+  "[css][json][jsonc][html][markdown][yaml]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

.vscode/settings.json

@@ -1,3 +1,3 @@
 module.exports = {
-    endOfLine: "auto",
+  endOfLine: "auto",
 };

app/.prettierrc.js

@@ -51,7 +51,9 @@ if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
   target_sources(app PRIVATE src/behaviors/behavior_to_layer.c)
   target_sources(app PRIVATE src/behaviors/behavior_transparent.c)
   target_sources(app PRIVATE src/behaviors/behavior_none.c)
-  target_sources(app PRIVATE src/behaviors/behavior_sensor_rotate_key_press.c)
+  target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_SENSOR_ROTATE app PRIVATE src/behaviors/behavior_sensor_rotate.c)
+  target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_SENSOR_ROTATE_VAR app PRIVATE src/behaviors/behavior_sensor_rotate_var.c)
+  target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_SENSOR_ROTATE_COMMON app PRIVATE src/behaviors/behavior_sensor_rotate_common.c)
   target_sources(app PRIVATE src/combo.c)
   target_sources(app PRIVATE src/behaviors/behavior_tap_dance.c)
   target_sources(app PRIVATE src/behavior_queue.c)