feat: Generate setup scripts from metadata.

Author: petejohanson

docs/.prettierignore

@@ -1,3 +1,5 @@
 node_modules
 build
-.docusaurus
+.docusaurus
+*.mustache
+hardware-metadata.json

docs/docusaurus.config.js

@@ -12,6 +12,7 @@ module.exports = {
     path.resolve(__dirname, "src/docusaurus-tree-sitter-plugin"),
     path.resolve(__dirname, "src/hardware-metadata-collection-plugin"),
     path.resolve(__dirname, "src/hardware-schema-typescript-plugin"),
+    path.resolve(__dirname, "src/setup-script-generation-plugin"),
   ],
   themeConfig: {
     colorMode: {

docs/package-lock.json

@@ -26,7 +26,8 @@
     "react-copy-to-clipboard": "^5.0.3",
     "react-dom": "^17.0.2",
     "react-toastify": "^7.0.4",
-    "web-tree-sitter": "^0.19.4"
+    "web-tree-sitter": "^0.19.4",
+    "@mdx-js/react": "^1.6.22"
   },
   "browserslist": {
     "production": [
@@ -46,12 +47,14 @@
     "eslint-plugin-mdx": "^1.13.0",
     "eslint-plugin-react": "^7.23.2",
     "json-schema-to-typescript": "^10.1.3",
+    "mustache": "^4.2.0",
     "null-loader": "^4.0.0",
     "prebuild-webpack-plugin": "^1.1.1",
     "prettier": "2.3.1",
     "string-replace-loader": "^3.0.3",
     "typescript": "^4.2.3",
-    "@docusaurus/module-type-aliases": "^2.0.0-alpha.72",
+    "webpack": "^5.46.0",
+    "@docusaurus/module-type-aliases": "^2.0.0-beta.3",
     "@tsconfig/docusaurus": "^1.0.2",
     "@types/react": "^17.0.3",
     "@types/react-helmet": "^6.1.0",

docs/package.json

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2021 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+var PrebuildPlugin = require("prebuild-webpack-plugin");
+const fs = require("fs");
+const glob = require("glob");
+const yaml = require("js-yaml");
+const Mustache = require("mustache");
+
+function generateSetupScripts() {
+  return glob("../app/boards/**/*.zmk.yml", (error, files) => {
+    const aggregated = files.flatMap((f) =>
+      yaml.safeLoadAll(fs.readFileSync(f, "utf8"))
+    );
+
+    const data = aggregated.reduce(
+      (agg, item) => {
+        switch (item.type) {
+          case "shield":
+            item.compatible = true;
+            item.split = item.siblings?.length > 1;
+            agg.keyboards.push(item);
+            break;
+          case "board":
+            if (!item.features?.includes("keys")) {
+              agg.boards.push(item);
+            }
+            break;
+        }
+        return agg;
+      },
+      { keyboards: [], boards: [] }
+    );
+
+    for (let script_ext of ["sh", "ps1"]) {
+      const templateBuffer = fs.readFileSync(
+        `src/templates/setup.${script_ext}.mustache`,
+        "utf8"
+      );
+      const script = Mustache.render(templateBuffer, data);
+      fs.writeFileSync(`static/setup.${script_ext}`, script);
+    }
+  });
+}
+
+module.exports = function () {
+  return {
+    name: "setup-script-generation-plugin",
+    configureWebpack() {
+      return {
+        plugins: [
+          new PrebuildPlugin({
+            build: generateSetupScripts,
+          }),
+        ],
+      };
+    },
+  };
+};