mirror of
https://github.com/zmkfirmware/zmk.git
synced 2026-03-20 04:55:20 -05:00
feat: Generate setup scripts from metadata.
This commit is contained in:
Peter Johanson
committed by
Pete Johanson
Pete Johanson
parent
683991aa93
commit
b82bbb5ba2
62
docs/src/setup-script-generation-plugin/index.js
Normal file
62
docs/src/setup-script-generation-plugin/index.js
Normal file
@@ -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,
|
||||
}),
|
||||
],
|
||||
};
|
||||
},
|
||||
};
|
||||
};
|
||||
205
docs/src/templates/setup.ps1.mustache
Normal file
205
docs/src/templates/setup.ps1.mustache
Normal file
@@ -0,0 +1,205 @@
|
||||
# Copyright (c) 2020 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
function Get-Choice-From-Options {
|
||||
param(
|
||||
[String[]] $Options,
|
||||
[String] $Prompt
|
||||
)
|
||||
|
||||
while ($true) {
|
||||
for ($i = 0; $i -lt $Options.length; $i++) {
|
||||
Write-Host "$($i + 1)) $($Options[$i])"
|
||||
}
|
||||
|
||||
Write-Host "$($Options.length + 1)) Quit"
|
||||
$selection = (Read-Host $Prompt) -as [int]
|
||||
|
||||
if ($selection -eq $Options.length + 1) {
|
||||
Write-Host "Goodbye!"
|
||||
exit 1
|
||||
}
|
||||
elseif ($selection -le $Options.length -and $selection -gt 0) {
|
||||
$choice = $($selection - 1)
|
||||
break
|
||||
}
|
||||
else {
|
||||
Write-Host "Invalid Option. Try another one."
|
||||
}
|
||||
}
|
||||
|
||||
return $choice
|
||||
}
|
||||
|
||||
function Test-Git-Config {
|
||||
param(
|
||||
[String] $Option,
|
||||
[String] $ErrMsg
|
||||
)
|
||||
|
||||
git config $Option | Out-Null
|
||||
|
||||
if ($lastExitCode -ne 0) {
|
||||
Write-Host $ErrMsg
|
||||
exit 1
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
git | Out-Null
|
||||
}
|
||||
catch [System.Management.Automation.CommandNotFoundException] {
|
||||
Write-Host "Git is not installed, and is required for this script!"
|
||||
exit 1
|
||||
}
|
||||
|
||||
Test-Git-Config -Option "user.name" -ErrMsg "Git username not set!`nRun: git config --global user.name 'My Name'"
|
||||
Test-Git-Config -Option "user.email" -ErrMsg "Git email not set!`nRun: git config --global user.email 'example@myemail.com'"
|
||||
|
||||
$permission = (Get-Acl $pwd).Access |
|
||||
?{$_.IdentityReference -match $env:UserName `
|
||||
-and $_.FileSystemRights -match "FullControl" `
|
||||
-or $_.FileSystemRights -match "Write" } |
|
||||
|
||||
Select IdentityReference,FileSystemRights
|
||||
|
||||
If (-Not $permission){
|
||||
Write-Host "Sorry, you do not have write permissions in this directory."
|
||||
Write-Host "Please try running this script again from a directory that you do have write permissions for."
|
||||
exit 1
|
||||
}
|
||||
|
||||
$repo_path = "https://github.com/zmkfirmware/zmk-config-split-template.git"
|
||||
|
||||
$title = "ZMK Config Setup:"
|
||||
$prompt = "Pick an MCU board"
|
||||
$options = {{#boards}}"{{{name}}}", {{/boards}} "" | Where-Object { $_ -ne "" }
|
||||
$boards = {{#boards}}"{{id}}", {{/boards}} "" | Where-Object { $_ -ne "" }
|
||||
|
||||
Write-Host "$title"
|
||||
Write-Host ""
|
||||
Write-Host "MCU Board Selection:"
|
||||
|
||||
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
|
||||
$board = $($boards[$choice])
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "Keyboard Shield Selection:"
|
||||
$prompt = "Pick a keyboard"
|
||||
|
||||
# TODO: Add support for "Other" and linking to docs on adding custom shields in user config repos.
|
||||
$options = {{#keyboards}}"{{name}}", {{/keyboards}} "" | Where-Object { $_ -ne "" }
|
||||
$names = {{#keyboards}}"{{id}}", {{/keyboards}} "" | Where-Object { $_ -ne "" }
|
||||
$splits = {{#keyboards}}"{{#split}}y{{/split}}{{^split}}n{{/split}}", {{/keyboards}} "" | Where-Object { $_ -ne "" }
|
||||
|
||||
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
|
||||
$shield_title = $($options[$choice])
|
||||
$shield = $($names[$choice])
|
||||
$split = $($splits[$choice])
|
||||
|
||||
if ($split -eq "n") {
|
||||
$repo_path = "https://github.com/zmkfirmware/zmk-config-template.git"
|
||||
}
|
||||
|
||||
$copy_keymap = Read-Host "Copy in the stock keymap for customisation? [Yn]"
|
||||
|
||||
if ($copy_keymap -eq "" -or $copy_keymap -eq "Y" -or $copy_keymap -eq "y") {
|
||||
$copy_keymap = "yes"
|
||||
}
|
||||
|
||||
$github_user = Read-Host "GitHub Username (leave empty to skip GitHub repo creation)"
|
||||
|
||||
if ($github_user -ne "") {
|
||||
$repo_name = Read-Host "GitHub Repo Name [zmk-config]"
|
||||
|
||||
if ($repo_name -eq "") {
|
||||
$repo_name = "zmk-config"
|
||||
}
|
||||
|
||||
$github_repo = Read-Host "GitHub Repo [https://github.com/$github_user/$repo_name.git]"
|
||||
|
||||
if ($github_repo -eq "") {
|
||||
$github_repo = "https://github.com/$github_user/$repo_name.git"
|
||||
}
|
||||
}
|
||||
else {
|
||||
$repo_name = "zmk-config"
|
||||
$github_repo = ""
|
||||
}
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "Preparing a user config for:"
|
||||
Write-Host "* MCU Board: ${board}"
|
||||
Write-Host "* Shield: ${shield}"
|
||||
|
||||
if ($copy_keymap -eq "yes") {
|
||||
Write-Host "* Copy Keymap?: Yes"
|
||||
}
|
||||
else {
|
||||
Write-Host "* Copy Keymap?: No"
|
||||
}
|
||||
|
||||
if ($github_repo -ne "") {
|
||||
Write-Host "* GitHub Repo to Push (please create this in GH first!): $github_repo"
|
||||
}
|
||||
|
||||
Write-Host ""
|
||||
$do_it = Read-Host "Continue? [Yn]"
|
||||
|
||||
if ($do_it -ne "" -and $do_it -ne "Y" -and $do_it -ne "y") {
|
||||
Write-Host "Aborting..."
|
||||
exit 1
|
||||
}
|
||||
|
||||
git clone --single-branch "$repo_path" "$repo_name"
|
||||
Set-Location "$repo_name"
|
||||
|
||||
Push-Location config
|
||||
|
||||
Invoke-RestMethod -Uri "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.conf" -OutFile "${shield}.conf"
|
||||
|
||||
if ($copy_keymap -eq "yes") {
|
||||
Invoke-RestMethod -Uri "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.keymap" -OutFile "${shield}.keymap"
|
||||
}
|
||||
|
||||
Pop-Location
|
||||
|
||||
$build_file = (Get-Content .github/workflows/build.yml).replace("BOARD_NAME", $board)
|
||||
$build_file = $build_file.replace("SHIELD_NAME", $shield)
|
||||
$build_file = $build_file.replace("KEYBOARD_TITLE", $shield_title)
|
||||
|
||||
if ($board -eq "proton_c") {
|
||||
$build_file = $build_file.replace("uf2", "hex")
|
||||
}
|
||||
|
||||
Set-Content -Path .github/workflows/build.yml -Value $build_file
|
||||
|
||||
Remove-Item -Recurse -Force .git
|
||||
git init .
|
||||
git add .
|
||||
git commit -m "Initial User Config."
|
||||
|
||||
if ($github_repo -ne "") {
|
||||
git remote add origin "$github_repo"
|
||||
|
||||
git push --set-upstream origin $(git symbolic-ref --short HEAD)
|
||||
|
||||
# If push failed, assume that the origin was incorrect and give instructions on fixing.
|
||||
if ($lastExitCode -ne 0) {
|
||||
Write-Host "Remote repository $github_repo not found..."
|
||||
Write-Host "Check GitHub URL, and try adding again."
|
||||
Write-Host "Run the following: "
|
||||
Write-Host " git remote rm origin"
|
||||
Write-Host " git remote add origin FIXED_URL"
|
||||
Write-Host " git push --set-upstream origin $(git symbolic-ref --short HEAD)"
|
||||
Write-Host "Once pushed, your firmware should be availalbe from GitHub Actions at: $actions"
|
||||
exit 1
|
||||
}
|
||||
|
||||
if ($github_repo -imatch "https") {
|
||||
$actions = "$($github_repo.substring(0, $github_repo.length - 4))/actions"
|
||||
Write-Host "Your firmware should be availalbe from GitHub Actions shortly: $actions"
|
||||
}
|
||||
}
|
||||
228
docs/src/templates/setup.sh.mustache
Normal file
228
docs/src/templates/setup.sh.mustache
Normal file
@@ -0,0 +1,228 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2020 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
set -e
|
||||
|
||||
check_exists() {
|
||||
command_to_run=$1
|
||||
error_message=$2
|
||||
local __resultvar=$3
|
||||
|
||||
if ! eval "$command_to_run" &> /dev/null; then
|
||||
if [[ "$__resultvar" != "" ]]; then
|
||||
eval $__resultvar="'false'"
|
||||
else
|
||||
printf "%s\n" "$error_message"
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
if [[ "$__resultvar" != "" ]]; then
|
||||
eval $__resultvar="'true'"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
check_exists "command -v git" "git is not installed, and is required for this script!"
|
||||
check_exists "command -v curl" "curl is not installed, and is required for this script!" curl_exists
|
||||
check_exists "command -v wget" "wget is not installed, and is required for this script!" wget_exists
|
||||
|
||||
check_exists "git config user.name" "Git username not set!\nRun: git config --global user.name 'My Name'"
|
||||
check_exists "git config user.email" "Git email not set!\nRun: git config --global user.email 'example@myemail.com'"
|
||||
|
||||
# Check to see if the user has write permissions in this directory to prevent a cryptic error later on
|
||||
if [ ! -w `pwd` ]; then
|
||||
echo 'Sorry, you do not have write permissions in this directory.';
|
||||
echo 'Please try running this script again from a directory that you do have write permissions for.';
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Parse all commandline options
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case $1 in
|
||||
-w|--wget) force_wget="true"; break;;
|
||||
*) echo "Unknown parameter: $1"; exit 1;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if [[ $curl_exists == "true" && $wget_exists == "true" ]]; then
|
||||
if [[ $force_wget == "true" ]]; then
|
||||
download_command="wget "
|
||||
else
|
||||
download_command="curl -O "
|
||||
fi
|
||||
elif [[ $curl_exists == "true" ]]; then
|
||||
download_command="curl -O "
|
||||
elif [[ $wget_exists == "true" ]]; then
|
||||
download_command="wget "
|
||||
else
|
||||
echo 'Neither curl nor wget are installed. One of the two is required for this script!'
|
||||
exit 1
|
||||
fi
|
||||
|
||||
repo_path="https://github.com/zmkfirmware/zmk-config-split-template.git"
|
||||
title="ZMK Config Setup:"
|
||||
|
||||
echo ""
|
||||
echo "Keyboard Selection:"
|
||||
PS3="Pick a keyboard: "
|
||||
options=({{#keyboards}}"{{{name}}}" {{/keyboards}})
|
||||
keyboards_id=({{#keyboards}}"{{id}}" {{/keyboards}})
|
||||
keyboards_type=({{#keyboards}}"{{type}}" {{/keyboards}})
|
||||
keyboards_split=({{#keyboards}}"{{#split}}y{{/split}}{{^split}}n{{/split}}" {{/keyboards}})
|
||||
keyboards_shield=({{#keyboards}}"{{#compatible}}y{{/compatible}}{{^compatible}}n{{/compatible}}" {{/keyboards}})
|
||||
select opt in "${options[@]}" "Quit"; do
|
||||
case "$REPLY" in
|
||||
''|*[!0-9]*) echo "Invalid option. Try another one."; continue;;
|
||||
|
||||
$(( ${#options[@]}+1 )) ) echo "Goodbye!"; exit 1;;
|
||||
*)
|
||||
if [ $REPLY -gt $(( ${#options[@]}+1 )) ] || [ $REPLY -lt 0 ]; then
|
||||
echo "Invalid option. Try another one."
|
||||
continue
|
||||
fi
|
||||
keyboard_index=$(( $REPLY-1 ))
|
||||
keyboard=${keyboards_id[$keyboard_index]}
|
||||
keyboard_title=${options[$keyboard_index]}
|
||||
split=${keyboards_split[$keyboard_index]}
|
||||
type=${keyboards_type[$keyboard_index]}
|
||||
keyboard_shield=${keyboards_shield[$keyboard_index]}
|
||||
break
|
||||
;;
|
||||
|
||||
esac
|
||||
done
|
||||
|
||||
if [ "$keyboard_shield" == "y" ]; then
|
||||
shield=${keyboard}
|
||||
shield_title=${keyboard_title}
|
||||
|
||||
prompt="Pick an MCU board:"
|
||||
options=({{#boards}}"{{{name}}}" {{/boards}})
|
||||
board_ids=({{#boards}}"{{id}}" {{/boards}})
|
||||
|
||||
echo ""
|
||||
echo "MCU Board Selection:"
|
||||
PS3="$prompt "
|
||||
select opt in "${options[@]}" "Quit"; do
|
||||
case "$REPLY" in
|
||||
''|*[!0-9]*) echo "Invalid option. Try another one."; continue;;
|
||||
|
||||
$(( ${#options[@]}+1 )) ) echo "Goodbye!"; exit 1;;
|
||||
*)
|
||||
if [ $REPLY -gt $(( ${#options[@]}+1 )) ] || [ $REPLY -lt 0 ]; then
|
||||
echo "Invalid option. Try another one."
|
||||
continue
|
||||
fi
|
||||
board_index=$(( $REPLY-1 ))
|
||||
board=${board_ids[$board_index]}
|
||||
board_title=${options[$board_index]}
|
||||
break
|
||||
;;
|
||||
|
||||
esac
|
||||
done
|
||||
else
|
||||
board=${keyboard}
|
||||
echo "Support for onboard microcontroller keyboards is still a work in progress."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "$split" == "n" ]; then
|
||||
repo_path="https://github.com/zmkfirmware/zmk-config-template.git"
|
||||
fi
|
||||
|
||||
read -r -e -p "Copy in the stock keymap for customization? [Yn]: " copy_keymap
|
||||
|
||||
if [ -z "$copy_keymap" ] || [ "$copy_keymap" == "Y" ] || [ "$copy_keymap" == "y" ]; then copy_keymap="yes"; fi
|
||||
|
||||
read -r -e -p "GitHub Username (leave empty to skip GitHub repo creation): " github_user
|
||||
if [ -n "$github_user" ]; then
|
||||
read -r -p "GitHub Repo Name [zmk-config]: " repo_name
|
||||
if [ -z "$repo_name" ]; then repo_name="zmk-config"; fi
|
||||
|
||||
read -r -p "GitHub Repo [https://github.com/${github_user}/${repo_name}.git]: " github_repo
|
||||
|
||||
if [ -z "$github_repo" ]; then github_repo="https://github.com/${github_user}/${repo_name}.git"; fi
|
||||
else
|
||||
repo_name="zmk-config"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Preparing a user config for:"
|
||||
echo "* MCU Board: ${board}"
|
||||
echo "* Shield: ${shield}"
|
||||
|
||||
if [ "$copy_keymap" == "yes" ]; then
|
||||
echo "* Copy Keymap?: ✓"
|
||||
else
|
||||
echo "* Copy Keymap?: ❌"
|
||||
fi
|
||||
|
||||
if [ -n "$github_repo" ]; then
|
||||
echo "* GitHub Repo To Push (please create this in GH first!): ${github_repo}"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
read -r -p "Continue? [Yn]: " do_it
|
||||
|
||||
if [ -n "$do_it" ] && [ "$do_it" != "y" ] && [ "$do_it" != "Y" ]; then
|
||||
echo "Aborting..."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
git clone --single-branch $repo_path ${repo_name}
|
||||
cd ${repo_name}
|
||||
|
||||
pushd config
|
||||
|
||||
$download_command "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.conf"
|
||||
|
||||
if [ "$copy_keymap" == "yes" ]; then
|
||||
$download_command "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.keymap"
|
||||
fi
|
||||
|
||||
popd
|
||||
|
||||
sed -i'.orig' \
|
||||
-e "s/BOARD_NAME/$board/" \
|
||||
-e "s/SHIELD_NAME/$shield/" \
|
||||
-e "s/KEYBOARD_TITLE/$shield_title/" \
|
||||
.github/workflows/build.yml
|
||||
|
||||
if [ "$board" == "proton_c" ]; then
|
||||
# Proton-C board still fa
|
||||
sed -i'.orig' -e "s/uf2/hex/g" .github/workflows/build.yml
|
||||
fi
|
||||
|
||||
rm .github/workflows/*.yml.orig
|
||||
|
||||
rm -rf .git
|
||||
git init .
|
||||
git add .
|
||||
git commit -m "Initial User Config."
|
||||
|
||||
if [ -n "$github_repo" ]; then
|
||||
git remote add origin "$github_repo"
|
||||
git push --set-upstream origin "$(git symbolic-ref --short HEAD)"
|
||||
push_return_code=$?
|
||||
|
||||
# If push failed, assume that the origin was incorrect and give instructions on fixing.
|
||||
if [ ${push_return_code} -ne 0 ]; then
|
||||
echo "Remote repository $github_repo not found..."
|
||||
echo "Check GitHub URL, and try adding again."
|
||||
echo "Run the following: "
|
||||
echo " git remote rm origin"
|
||||
echo " git remote add origin FIXED_URL"
|
||||
echo " git push --set-upstream origin $(git symbolic-ref --short HEAD)"
|
||||
echo "Once pushed, your firmware should be availalbe from GitHub Actions at: ${github_repo%.git}/actions"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# TODO: Support determing the actions URL when non-https:// repo URL is used.
|
||||
if [ "${github_repo}" != "${github_repo#https://}" ]; then
|
||||
echo "Your firmware should be available from GitHub Actions shortly: ${github_repo%.git}/actions"
|
||||
fi
|
||||
fi
|
||||
Reference in New Issue
Block a user