From 53c51f1d16b40fdd3e68a6afc5844917d3d58640 Mon Sep 17 00:00:00 2001
From: fauxpark <fauxpark@gmail.com>
Date: Sun, 28 Apr 2019 09:42:16 +1000
Subject: A better new_project.sh (#5191)

* A better new_project.sh

* Fix docstrings

* Use single quotes for anything not shown to user

* Missed this docstring

* Simplify get_git_username()

Thanks @vomindoraan

* chmod +x

* Add docstring for print_error()

* Break up git username call into multiple lines

* Use with statement here

* Conform to PEP 8 even more

* Turn it back into a shell script

* chmod +x again

* Update docs to reflect new keyboard generator usage

* Tweak wording slightly

* Trim trailing whitespace

* Don't actually need to escape the newlines here

* As I suspected, you can pass shift a number

* Prepend ./ to match the other code block

* Minor syntax tweaks

* The username token has changed

* Replace name in the readme too

* Make some reasonable assumptions about the presence of Git
---
 util/new_keyboard.sh | 159 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 159 insertions(+)
 create mode 100755 util/new_keyboard.sh

(limited to 'util/new_keyboard.sh')

diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
new file mode 100755
index 0000000000..e9ce309784
--- /dev/null
+++ b/util/new_keyboard.sh
@@ -0,0 +1,159 @@
+#!/bin/bash
+
+# This script generates a new keyboard directory under keyboards/,
+# and copies the template files from quantum/template/ into it.
+
+# Print an error message with the word "ERROR" in red.
+echo_error() {
+    echo -e "[\033[0;91mERROR\033[m]: $1"
+}
+
+# Print a message in bold.
+echo_bold() {
+    echo -e "\033[1m$1\033[m"
+}
+
+# Prompt the user for information, showing the default value in brackets.
+prompt() {
+    local message="$1"
+    local default="$2"
+
+    [ -n "$default" ] && message+=" [$default]"
+    message+=": "
+
+    read -rp "$message" prompt_return
+    [ -z "$prompt_return" ] && prompt_return="$default"
+}
+
+# Grab a username from Git config.
+set_git_username() {
+    git_username="$(git config --get user.name)"
+}
+
+# Copy the template files to the new keyboard directory.
+copy_templates() {
+    echo -n "Copying base template files..."
+    cp -r "quantum/template/base" "${keyboard_dir}"
+    echo " done"
+
+    echo -n "Copying $keyboard_type template files..."
+    cp -r "quantum/template/${keyboard_type}/." "${keyboard_dir}"
+    echo " done"
+
+    echo -n "Renaming keyboard files..."
+    mv "${keyboard_dir}/template.c" "${keyboard_dir}/${keyboard_name}.c"
+    mv "${keyboard_dir}/template.h" "${keyboard_dir}/${keyboard_name}.h"
+    echo " done"
+}
+
+# Set the inplace editing parameter for sed.
+# macOS/BSD sed expects a file extension immediately following -i.
+set_sed_i() {
+    sed_i=(-i)
+
+    case $(uname -a) in
+        *Darwin*) sed_i=(-i "")
+    esac
+}
+
+# Replace a token with a value in the given list of files.
+replace_placeholders() {
+    local replace_token="$1"
+    local replace_value="$2"
+    shift 2
+    local replace_filenames=("$@")
+
+    echo -n "Replacing $replace_token with $replace_value..."
+    for replace_filename in "${replace_filenames[@]}"; do
+        sed "${sed_i[@]}" -e "s/${replace_token}/${replace_value}/g" "$replace_filename"
+    done
+    echo " done"
+}
+
+# Replace %KEYBOARD% with the keyboard name.
+replace_keyboard_placeholders() {
+    local replace_keyboard_filenames=(
+        "${keyboard_dir}/config.h"
+        "${keyboard_dir}/readme.md"
+        "${keyboard_dir}/${keyboard_name}.c"
+        "${keyboard_dir}/keymaps/default/readme.md"
+    )
+    replace_placeholders "%KEYBOARD%" "$keyboard_name" "${replace_keyboard_filenames[@]}"
+}
+
+# Replace %YOUR_NAME% with the username.
+replace_name_placeholders() {
+    local replace_name_filenames=(
+        "${keyboard_dir}/config.h"
+        "${keyboard_dir}/readme.md"
+        "${keyboard_dir}/${keyboard_name}.c"
+        "${keyboard_dir}/${keyboard_name}.h"
+        "${keyboard_dir}/keymaps/default/config.h"
+        "${keyboard_dir}/keymaps/default/keymap.c"
+    )
+    replace_placeholders "%YOUR_NAME%" "$username" "${replace_name_filenames[@]}"
+}
+
+# Check if an array contains an element.
+array_contains() {
+    local e match="$1"
+    shift
+    for e; do
+        [[ "$e" == "$match" ]] && return 0;
+    done
+
+    return 1
+}
+
+# If we've been started from util/, we want to be in qmk_firmware/
+[[ "$PWD" == *util ]] && cd ..
+
+# The root qmk_firmware/ directory should have a subdirectory called quantum/
+if [ ! -d "quantum" ]; then
+    echo_error "Could not detect the QMK firmware directory!"
+    echo_error "Are you sure you're in the right place?"
+    exit 1
+fi
+
+echo_bold "Generating a new QMK keyboard directory"
+echo
+
+# Keyboard name is required, so keep prompting until we get one
+while [ -z "$keyboard_name" ]; do
+    prompt "Keyboard Name" ""
+    keyboard_name=$prompt_return
+done
+
+keyboard_dir="keyboards/$keyboard_name"
+
+if [ -d "$keyboard_dir" ]; then
+    echo_error "Keyboard $keyboard_name already exists!"
+    exit 1
+fi
+
+KEYBOARD_TYPES=("avr" "ps2avrgb")
+
+prompt "Keyboard Type" "avr"
+keyboard_type=$prompt_return
+
+if ! array_contains "$keyboard_type" "${KEYBOARD_TYPES[@]}"; then
+    echo_error "Keyboard type must be one of: ${KEYBOARD_TYPES[*]}"
+    exit 1
+fi
+
+set_git_username
+prompt "Your Name" "$git_username"
+username=$prompt_return
+
+echo
+
+copy_templates
+set_sed_i
+replace_keyboard_placeholders
+[ -n "$username" ] && replace_name_placeholders
+
+echo
+echo_bold "Created a new keyboard called $keyboard_name."
+echo
+echo_bold "To start working on things, cd into keyboards/$keyboard_name,"
+echo_bold "or open the directory in your favourite text editor."
-- 
cgit v1.2.3


From 8b1cdd1e3d27cce830c36f9604e5f69337b2c83e Mon Sep 17 00:00:00 2001
From: fauxpark <fauxpark@gmail.com>
Date: Tue, 9 Jul 2019 07:07:36 +1000
Subject: Add copyright year placeholders to new keyboard script (#6280)

* Add copyright year placeholders to new keyboard script

* More copyright header tweaks
---
 util/new_keyboard.sh | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'util/new_keyboard.sh')

diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
index e9ce309784..35d89e4026 100755
--- a/util/new_keyboard.sh
+++ b/util/new_keyboard.sh
@@ -70,6 +70,18 @@ replace_placeholders() {
     echo " done"
 }
 
+# Replace %YEAR% with the current year.
+replace_year_placeholders() {
+    local replace_year_filenames=(
+        "${keyboard_dir}/config.h"
+        "${keyboard_dir}/${keyboard_name}.c"
+        "${keyboard_dir}/${keyboard_name}.h"
+        "${keyboard_dir}/keymaps/default/config.h"
+        "${keyboard_dir}/keymaps/default/keymap.c"
+    )
+    replace_placeholders "%YEAR%" "$(date +%Y)" "${replace_year_filenames[@]}"
+}
+
 # Replace %KEYBOARD% with the keyboard name.
 replace_keyboard_placeholders() {
     local replace_keyboard_filenames=(
@@ -149,6 +161,7 @@ echo
 
 copy_templates
 set_sed_i
+replace_year_placeholders
 replace_keyboard_placeholders
 [ -n "$username" ] && replace_name_placeholders
 
-- 
cgit v1.2.3


From ed1bf3afa25d7e7674df7e8618dfaf243de3058b Mon Sep 17 00:00:00 2001
From: fauxpark <fauxpark@gmail.com>
Date: Thu, 10 Oct 2019 21:48:37 +1100
Subject: Prevent clang-format messing up placeholder tokens within keyboard
 templates (#6790)

* Use .template file extension for keyboard template files

* Filter out .template files completely before passing to clang-format

* Undo file extension stuff; just ignore quantum/template dir
---
 util/new_keyboard.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'util/new_keyboard.sh')

diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
index 35d89e4026..fe7c1a8299 100755
--- a/util/new_keyboard.sh
+++ b/util/new_keyboard.sh
@@ -41,8 +41,8 @@ copy_templates() {
     echo " done"
 
     echo -n "Renaming keyboard files..."
-    mv "${keyboard_dir}/template.c" "${keyboard_dir}/${keyboard_name}.c"
-    mv "${keyboard_dir}/template.h" "${keyboard_dir}/${keyboard_name}.h"
+    mv "${keyboard_dir}/keyboard.c" "${keyboard_dir}/${keyboard_name}.c"
+    mv "${keyboard_dir}/keyboard.h" "${keyboard_dir}/${keyboard_name}.h"
     echo " done"
 }
 
-- 
cgit v1.2.3


From e6cc9cc78d40af1386f9a116d5fcc95c20233110 Mon Sep 17 00:00:00 2001
From: fauxpark <fauxpark@gmail.com>
Date: Sat, 2 Nov 2019 13:06:03 +1100
Subject: Template updates (#7221)

* Template updates

* Flesh out info.json & keymap.c, and turn double spaces section into a list

* Add enum to demonstrate layer naming

* Semicolon
---
 util/new_keyboard.sh | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'util/new_keyboard.sh')

diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
index fe7c1a8299..11c6497e23 100755
--- a/util/new_keyboard.sh
+++ b/util/new_keyboard.sh
@@ -86,6 +86,7 @@ replace_year_placeholders() {
 replace_keyboard_placeholders() {
     local replace_keyboard_filenames=(
         "${keyboard_dir}/config.h"
+        "${keyboard_dir}/info.json"
         "${keyboard_dir}/readme.md"
         "${keyboard_dir}/${keyboard_name}.c"
         "${keyboard_dir}/keymaps/default/readme.md"
@@ -97,6 +98,7 @@ replace_keyboard_placeholders() {
 replace_name_placeholders() {
     local replace_name_filenames=(
         "${keyboard_dir}/config.h"
+        "${keyboard_dir}/info.json"
         "${keyboard_dir}/readme.md"
         "${keyboard_dir}/${keyboard_name}.c"
         "${keyboard_dir}/${keyboard_name}.h"
-- 
cgit v1.2.3


From 59b017381c96ce5fd200d4db590accf8cbea9313 Mon Sep 17 00:00:00 2001
From: shikamiya <46595896+shikamiya@users.noreply.github.com>
Date: Wed, 1 Jan 2020 19:07:54 +0900
Subject: Add creation of new keyboard in child directory (#6018)

* Add creation of new chlid keyboard

* Add creation of new keyboard's parent directories

* Remove redundant message and if statement

* Divide creating new keyboard directory from copying template files

* Fix variables of year placeholder

* Fix filename of keyboard.[ch]
---
 util/new_keyboard.sh | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

(limited to 'util/new_keyboard.sh')

diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
index 11c6497e23..1f08790ad4 100755
--- a/util/new_keyboard.sh
+++ b/util/new_keyboard.sh
@@ -32,8 +32,10 @@ set_git_username() {
 
 # Copy the template files to the new keyboard directory.
 copy_templates() {
+    mkdir -p "$keyboard_dir"
+
     echo -n "Copying base template files..."
-    cp -r "quantum/template/base" "${keyboard_dir}"
+    cp -r "quantum/template/base/." "${keyboard_dir}"
     echo " done"
 
     echo -n "Copying $keyboard_type template files..."
@@ -41,8 +43,8 @@ copy_templates() {
     echo " done"
 
     echo -n "Renaming keyboard files..."
-    mv "${keyboard_dir}/keyboard.c" "${keyboard_dir}/${keyboard_name}.c"
-    mv "${keyboard_dir}/keyboard.h" "${keyboard_dir}/${keyboard_name}.h"
+    mv "${keyboard_dir}/keyboard.c" "${keyboard_dir}/${keyboard_base_name}.c"
+    mv "${keyboard_dir}/keyboard.h" "${keyboard_dir}/${keyboard_base_name}.h"
     echo " done"
 }
 
@@ -74,8 +76,8 @@ replace_placeholders() {
 replace_year_placeholders() {
     local replace_year_filenames=(
         "${keyboard_dir}/config.h"
-        "${keyboard_dir}/${keyboard_name}.c"
-        "${keyboard_dir}/${keyboard_name}.h"
+        "${keyboard_dir}/${keyboard_base_name}.c"
+        "${keyboard_dir}/${keyboard_base_name}.h"
         "${keyboard_dir}/keymaps/default/config.h"
         "${keyboard_dir}/keymaps/default/keymap.c"
     )
@@ -88,10 +90,10 @@ replace_keyboard_placeholders() {
         "${keyboard_dir}/config.h"
         "${keyboard_dir}/info.json"
         "${keyboard_dir}/readme.md"
-        "${keyboard_dir}/${keyboard_name}.c"
+        "${keyboard_dir}/${keyboard_base_name}.c"
         "${keyboard_dir}/keymaps/default/readme.md"
     )
-    replace_placeholders "%KEYBOARD%" "$keyboard_name" "${replace_keyboard_filenames[@]}"
+    replace_placeholders "%KEYBOARD%" "$keyboard_base_name" "${replace_keyboard_filenames[@]}"
 }
 
 # Replace %YOUR_NAME% with the username.
@@ -100,8 +102,8 @@ replace_name_placeholders() {
         "${keyboard_dir}/config.h"
         "${keyboard_dir}/info.json"
         "${keyboard_dir}/readme.md"
-        "${keyboard_dir}/${keyboard_name}.c"
-        "${keyboard_dir}/${keyboard_name}.h"
+        "${keyboard_dir}/${keyboard_base_name}.c"
+        "${keyboard_dir}/${keyboard_base_name}.h"
         "${keyboard_dir}/keymaps/default/config.h"
         "${keyboard_dir}/keymaps/default/keymap.c"
     )
@@ -136,6 +138,7 @@ echo
 while [ -z "$keyboard_name" ]; do
     prompt "Keyboard Name" ""
     keyboard_name=$prompt_return
+    keyboard_base_name=$(basename $keyboard_name)
 done
 
 keyboard_dir="keyboards/$keyboard_name"
-- 
cgit v1.2.3


From e8d577c081469608a9c203f97aece82d4253e99e Mon Sep 17 00:00:00 2001
From: Ryan <fauxpark@gmail.com>
Date: Wed, 15 Jul 2020 18:52:02 +1000
Subject: Update new keyboard templates (#9636)

* Update new keyboard templates

* Switch on Bootmagic Lite by default

* Remove MIDI_ENABLE and FAUXCLICKY_ENABLE
---
 util/new_keyboard.sh | 2 --
 1 file changed, 2 deletions(-)

(limited to 'util/new_keyboard.sh')

diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
index 1f08790ad4..cf3339f9a7 100755
--- a/util/new_keyboard.sh
+++ b/util/new_keyboard.sh
@@ -78,7 +78,6 @@ replace_year_placeholders() {
         "${keyboard_dir}/config.h"
         "${keyboard_dir}/${keyboard_base_name}.c"
         "${keyboard_dir}/${keyboard_base_name}.h"
-        "${keyboard_dir}/keymaps/default/config.h"
         "${keyboard_dir}/keymaps/default/keymap.c"
     )
     replace_placeholders "%YEAR%" "$(date +%Y)" "${replace_year_filenames[@]}"
@@ -104,7 +103,6 @@ replace_name_placeholders() {
         "${keyboard_dir}/readme.md"
         "${keyboard_dir}/${keyboard_base_name}.c"
         "${keyboard_dir}/${keyboard_base_name}.h"
-        "${keyboard_dir}/keymaps/default/config.h"
         "${keyboard_dir}/keymaps/default/keymap.c"
     )
     replace_placeholders "%YOUR_NAME%" "$username" "${replace_name_filenames[@]}"
-- 
cgit v1.2.3