From c7e513634d2425dbdf21ccd693872301f80cad65 Mon Sep 17 00:00:00 2001
From: Peter Johanson <peter@peterjohanson.com>
Date: Fri, 10 Sep 2021 16:33:39 +0000
Subject: [PATCH] feat(metadata): Add YAML check/format npm scripts.

---
 .../hardware-metadata-validation.yml          | 16 +++++++--
 app/.gitignore                                |  1 +
 app/.prettierrc.js                            |  3 ++
 app/package-lock.json                         | 36 +++++++++++++++++++
 app/package.json                              | 23 ++++++++++++
 5 files changed, 76 insertions(+), 3 deletions(-)
 create mode 100644 app/.prettierrc.js
 create mode 100644 app/package-lock.json
 create mode 100644 app/package.json

diff --git a/.github/workflows/hardware-metadata-validation.yml b/.github/workflows/hardware-metadata-validation.yml
index 3972ed81..1318b4bd 100644
--- a/.github/workflows/hardware-metadata-validation.yml
+++ b/.github/workflows/hardware-metadata-validation.yml
@@ -15,6 +15,17 @@ on:
       - "app/scripts/west_commands/metadata.py"
 
 jobs:
+  check-metadata-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
+      - 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:
@@ -30,6 +41,5 @@ jobs:
       - name: Export Zephyr CMake package (west zephyr-export)
         run: west zephyr-export
       - name: Validate Hardware Metadata
-        run: |
-          cd app
-          west metadata check
+        working-directory: app
+        run: west metadata check
diff --git a/app/.gitignore b/app/.gitignore
index 567609b1..3e2e84b0 100644
--- a/app/.gitignore
+++ b/app/.gitignore
@@ -1 +1,2 @@
 build/
+node_modules/
diff --git a/app/.prettierrc.js b/app/.prettierrc.js
new file mode 100644
index 00000000..806328d9
--- /dev/null
+++ b/app/.prettierrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+    endOfLine: "auto",
+};
diff --git a/app/package-lock.json b/app/package-lock.json
new file mode 100644
index 00000000..afd730a5
--- /dev/null
+++ b/app/package-lock.json
@@ -0,0 +1,36 @@
+{
+  "name": "zmkfirmware",
+  "version": "1.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "zmkfirmware",
+      "version": "1.0.0",
+      "license": "MIT",
+      "devDependencies": {
+        "prettier": "^2.4.0"
+      }
+    },
+    "node_modules/prettier": {
+      "version": "2.4.0",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.4.0.tgz",
+      "integrity": "sha512-DsEPLY1dE5HF3BxCRBmD4uYZ+5DCbvatnolqTqcxEgKVZnL2kUfyu7b8pPQ5+hTBkdhU9SLUmK0/pHb07RE4WQ==",
+      "dev": true,
+      "bin": {
+        "prettier": "bin-prettier.js"
+      },
+      "engines": {
+        "node": ">=10.13.0"
+      }
+    }
+  },
+  "dependencies": {
+    "prettier": {
+      "version": "2.4.0",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.4.0.tgz",
+      "integrity": "sha512-DsEPLY1dE5HF3BxCRBmD4uYZ+5DCbvatnolqTqcxEgKVZnL2kUfyu7b8pPQ5+hTBkdhU9SLUmK0/pHb07RE4WQ==",
+      "dev": true
+    }
+  }
+}
diff --git a/app/package.json b/app/package.json
new file mode 100644
index 00000000..e75d9695
--- /dev/null
+++ b/app/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "zmkfirmware",
+  "version": "1.0.0",
+  "description": "ZMK Firmware tooling",
+  "private": "true",
+  "scripts": {
+    "prettier:check": "prettier --check boards/**/*.yml",
+    "prettier:format": "prettier --write boards/**/*.yml"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zmkfirware/zmk.git"
+  },
+  "author": "ZMK Contributors",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/zmkfirware/zmk/issues"
+  },
+  "homepage": "https://zmk.dev/",
+  "devDependencies": {
+    "prettier": "^2.4.0"
+  }
+}
\ No newline at end of file