[proposal] Refactor/qmk arsenik generator

.gitignore

@@ -1 +1,2 @@
 kanata*.exe
+**/output/*

qmk/generator.sh

@@ -0,0 +1,191 @@
+#!/usr/bin/env bash
+
+# Arsenik QMK keymap generator
+# Generates files required by QMK to build/flash an arsenik layout keymap for a given keyboard
+# Outputs files in ./output/<keyboard_model>/keymaps/arsenik
+
+set -euo pipefail
+
+# Colors for logs
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+CYAN='\033[0;36m'
+NC='\033[0m' # No Color
+
+log_info() { echo -e "${BLUE}[INFO]${NC} $1"; }
+log_warn() { echo -e "${YELLOW}[WARN]${NC} $1"; }
+log_success() { echo -e "${GREEN}[SUCCESS]${NC} $1"; }
+log_error() { echo -e "${RED}[ERROR]${NC} $1" >&2; }
+
+# Print usage and exit
+usage() {
+    echo "Usage: $0 [-kb <keyboard_model>] [-km <keymap>] [--generate|-g] [--copy|-cp]"
+    echo "  -kb <keyboard_model>   Specify the keyboard model (optional, will use qmk config if not provided)"
+    echo "  -km <keymap>           Specify the keymap (optional, will use qmk config if not provided)"
+    echo "  --generate, -g         Generate the Arsenik keymap (default: off)"
+    echo "  --copy, -cp            Copy ./output/<keyboard_model>/keymaps/arsenik to $QMK_HOME/keyboards/<keyboard_model>/keymaps/arsenik (default: off)"
+    exit 1
+}
+
+# Parse arguments
+copy_keymap=false
+generate_keymap=false
+keyboard_model=""
+keymap=""
+
+while [ "$#" -gt 0 ]; do
+    case "$1" in
+    -kb)
+        shift
+        keyboard_model="$1"
+        ;;
+    -km)
+        shift
+        keymap="$1"
+        ;;
+    --copy | -cp)
+        copy_keymap=true
+        ;;
+    --generate | -g)
+        generate_keymap=true
+        ;;
+    *)
+        usage
+        ;;
+    esac
+    shift
+done
+
+if [ -z "$keyboard_model" ] || [ -z "$keymap" ]; then
+    log_info "Requirements: It is recommended to have set QMK user.keyboard, user.keymap, and user.qmk_home using 'qmk config'."
+    log_info "See https://docs.qmk.fm/cli_configuration#setting-user-defaults for more information."
+    log_info "Your current configuration:"
+    qmk config || true
+fi
+
+# If keyboard_model or keymap is empty, get from qmk config
+if [ -z "$keyboard_model" ]; then
+    keyboard_model=$(qmk config user.keyboard | awk -F= '{print $2}' | xargs)
+    log_info "No keyboard_model provided with '-kb' argument, using value from qmk config: ${CYAN}$keyboard_model${NC}"
+fi
+if [ -z "$keymap" ]; then
+    keymap=$(qmk config user.keymap | awk -F= '{print $2}' | xargs)
+    log_info "No keymap provided with '-km' argument, using value from qmk config: ${CYAN}$keymap${NC}"
+fi
+
+# Set QMK_HOME if not already set
+if [ -z "${QMK_HOME+x}" ]; then
+    QMK_HOME=$(qmk config user.qmk_home | awk -F= '{print $2}' | xargs)
+fi
+
+# Find the keymaps folder for a given keyboard name
+get_keymaps_folder() {
+    local keyboard_model="$1"
+    local keymap="$2"
+    while [ ! -d "$QMK_HOME/keyboards/$keyboard_model/keymaps/$keymap" ]; do
+        if [ "$keyboard_model" = "." ]; then
+            echo "Couldn't find keymap folder for your keyboard/keymap" >&2
+            exit 1
+        fi
+        keyboard_model=$(dirname "$keyboard_model")
+    done
+    echo "$QMK_HOME/keyboards/$keyboard_model/keymaps/$keymap"
+}
+
+# Detect layout name
+detect_layout_name() {
+    local keyboard_model="$1"
+    local keymap="$2"
+
+    local keymap_folder
+    keymap_folder=$(get_keymaps_folder "$keyboard_model" "$keymap")
+
+    local layout=""
+    if [ -f "$keymap_folder/keymap.c" ]; then
+        layout=$(grep 'LAYOUT' "$keymap_folder/keymap.c" | sed 's/.*= \(.*\)(/\1/' | head -n 1)
+    elif [ -f "$keymap_folder/keymap.json" ]; then
+        layout=$(grep 'LAYOUT' "$keymap_folder/keymap.json" | sed 's/ *\"layout\": \"\(.*\)\",/\1/')
+    fi
+
+    if [ "$layout" = "LAYOUT" ]; then
+        layout+="_$(echo "$keyboard_model" | sed 's,/,_,g' | sed 's/_rev[0-9]*$//')"
+    fi
+    echo "ARSENIK_$layout"
+}
+
+create_output_dir() {
+    local output_dir="$1"
+    if [ -d "$output_dir" ]; then
+        log_warn "Output directory ${CYAN}$output_dir${NC} already exists."
+        read -p "Do you want to remove it and continue? [y/N]: " confirm
+        if [[ ! "$confirm" =~ ^[Yy]$ ]]; then
+            log_info "Aborted by user."
+            exit 0
+        fi
+        log_info "Removing existing output directory: ${CYAN}$output_dir${NC}"
+        rm -rf "$output_dir"
+    fi
+    log_info "Creating output directory: ${CYAN}$output_dir${NC}"
+    mkdir -p "$output_dir"
+}
+
+# Generate the Arsenik keymap in ./output/<keyboard_model>/<keymap>
+generate_arsenik_keymap() {
+    local keyboard_model="$1"
+    local keymap="$2"
+    local output_dir="$3"
+
+    local layout_name="$(detect_layout_name "$keyboard_model" "$keymap")"
+    log_info "Detected layout name: ${CYAN}$layout_name${NC}"
+
+    log_info "Copying required Arsenik files to output directory..."
+    rsync -a keymap/ "$output_dir"
+
+    # Replace placeholder in config.h template file
+    log_info "Set ${CYAN}$layout_name${NC} layout name in config.h template file..."
+    sed -i "s/ARSENIK_PLACEHOLDER_LAYOUT/$layout_name/" "$output_dir/config.h"
+
+    log_success "Generated Arsenik keymap in ${CYAN}$output_dir${NC}"
+}
+
+# Main
+output_dir="./output/$keyboard_model/keymaps/arsenik"
+
+if [ "$generate_keymap" = true ]; then
+    create_output_dir "$output_dir"
+    generate_arsenik_keymap "$keyboard_model" "$keymap" "$output_dir"
+    log_info "Now you may want to copy the '/output' directory into your QMK home directory."
+    log_info "This can be done with the './generator.sh --copy' command."
+fi
+
+if [ "$copy_keymap" = true ]; then
+    if [ ! -d "$output_dir" ]; then
+        log_error "Output directory ${CYAN}$output_dir${NC} does not exist. Cannot copy."
+        exit 1
+    fi
+    dest_dir="$QMK_HOME/keyboards/$keyboard_model/keymaps/arsenik"
+    if [ -d "$dest_dir" ]; then
+        log_warn "Destination directory ${CYAN}$dest_dir${NC} already exists."
+        read -p "Do you want to overwrite it and continue? [y/N]: " confirm
+        if [[ ! "$confirm" =~ ^[Yy]$ ]]; then
+            log_info "Aborted by user."
+            exit 0
+        fi
+        log_info "Removing existing destination directory: ${CYAN}$dest_dir${NC}"
+        rm -rf "$dest_dir"
+    fi
+    log_info "Copying ${CYAN}$output_dir${NC} to ${CYAN}$dest_dir${NC} ..."
+    rsync -a "$output_dir/" "$dest_dir"
+    log_success "Copied Arsenik keymap to ${CYAN}$dest_dir${NC}"
+    log_info "Finally, you may want to :"
+    log_info "    cd $dest_dir"
+    log_info "    qmk compile -kb $keyboard_model -km arsenik    # compile the keymap"
+    log_info "    # connect the keyboard"
+    log_info "    qmk flash -kb $keyboard_model -km arsenik      # flash the keyboard"
+fi
+
+if [ "$generate_keymap" = false ] && [ "$copy_keymap" = false ]; then
+    log_info "No action requested (--generate/-g or --copy/-cp). Nothing to do."
+fi