summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--data/templates/avr/config.h22
-rw-r--r--data/templates/avr/readme.md10
-rw-r--r--data/templates/base/%(KEYBOARD)s.c4
-rw-r--r--data/templates/base/%(KEYBOARD)s.h22
-rw-r--r--data/templates/base/info.json4
-rw-r--r--data/templates/base/keyboard.c17
-rw-r--r--data/templates/base/keyboard.h35
-rw-r--r--data/templates/base/keymaps/default/keymap.c48
-rw-r--r--data/templates/base/keymaps/default/readme.md2
-rw-r--r--data/templates/ps2avrgb/config.h22
-rw-r--r--data/templates/ps2avrgb/readme.md10
-rw-r--r--docs/coding_conventions_python.md2
-rw-r--r--lib/python/qmk/cli/new/keyboard.py79
13 files changed, 90 insertions, 187 deletions
diff --git a/data/templates/avr/config.h b/data/templates/avr/config.h
index 4192bbcfa2..7c15e8e704 100644
--- a/data/templates/avr/config.h
+++ b/data/templates/avr/config.h
@@ -1,19 +1,5 @@
-/*
-Copyright %YEAR% %YOUR_NAME%
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>.
-*/
+// Copyright %(YEAR)s %(YOUR_NAME)s (@%(USER_NAME)s)
+// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
@@ -23,8 +9,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define VENDOR_ID 0xFEED
#define PRODUCT_ID 0x0000
#define DEVICE_VER 0x0001
-#define MANUFACTURER %YOUR_NAME%
-#define PRODUCT %KEYBOARD%
+#define MANUFACTURER %(USER_NAME)s
+#define PRODUCT %(KEYBOARD)s
/* key matrix size */
#define MATRIX_ROWS 2
diff --git a/data/templates/avr/readme.md b/data/templates/avr/readme.md
index b099ed726d..207850e065 100644
--- a/data/templates/avr/readme.md
+++ b/data/templates/avr/readme.md
@@ -1,20 +1,20 @@
-# %KEYBOARD%
+# %(KEYBOARD)s
-![%KEYBOARD%](imgur.com image replace me!)
+![%(KEYBOARD)s](imgur.com image replace me!)
*A short description of the keyboard/project*
-* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
+* Keyboard Maintainer: [%(YOUR_NAME)s](https://github.com/%(USER_NAME)s)
* Hardware Supported: *The PCBs, controllers supported*
* Hardware Availability: *Links to where you can find this hardware*
Make example for this keyboard (after setting up your build environment):
- make %KEYBOARD%:default
+ make %(KEYBOARD)s:default
Flashing example for this keyboard:
- make %KEYBOARD%:default:flash
+ make %(KEYBOARD)s:default:flash
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/data/templates/base/%(KEYBOARD)s.c b/data/templates/base/%(KEYBOARD)s.c
new file mode 100644
index 0000000000..0c509aff65
--- /dev/null
+++ b/data/templates/base/%(KEYBOARD)s.c
@@ -0,0 +1,4 @@
+// Copyright %(YEAR)s %(YOUR_NAME)s (@%(USER_NAME)s)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "%(KEYBOARD)s.h"
diff --git a/data/templates/base/%(KEYBOARD)s.h b/data/templates/base/%(KEYBOARD)s.h
new file mode 100644
index 0000000000..3e8ca3912d
--- /dev/null
+++ b/data/templates/base/%(KEYBOARD)s.h
@@ -0,0 +1,22 @@
+// Copyright %(YEAR)s %(YOUR_NAME)s (@%(USER_NAME)s)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "quantum.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+ k00, k01, k02, \
+ k10, k12 \
+) { \
+ { k00, k01, k02 }, \
+ { k10, KC_NO, k12 } \
+}
diff --git a/data/templates/base/info.json b/data/templates/base/info.json
index 3993d85467..a50ccba7bf 100644
--- a/data/templates/base/info.json
+++ b/data/templates/base/info.json
@@ -1,7 +1,7 @@
{
- "keyboard_name": "%KEYBOARD%",
+ "keyboard_name": "%(KEYBOARD)s",
"url": "",
- "maintainer": "%YOUR_NAME%",
+ "maintainer": "%(USER_NAME)s",
"layouts": {
"LAYOUT": {
"layout": [
diff --git a/data/templates/base/keyboard.c b/data/templates/base/keyboard.c
deleted file mode 100644
index f69ae16ede..0000000000
--- a/data/templates/base/keyboard.c
+++ /dev/null
@@ -1,17 +0,0 @@
-/* Copyright %YEAR% %YOUR_NAME%
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-#include "%KEYBOARD%.h"
diff --git a/data/templates/base/keyboard.h b/data/templates/base/keyboard.h
deleted file mode 100644
index bd2e88d12b..0000000000
--- a/data/templates/base/keyboard.h
+++ /dev/null
@@ -1,35 +0,0 @@
-/* Copyright %YEAR% %YOUR_NAME%
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-#pragma once
-
-#include "quantum.h"
-
-/* This is a shortcut to help you visually see your layout.
- *
- * The first section contains all of the arguments representing the physical
- * layout of the board and position of the keys.
- *
- * The second converts the arguments into a two-dimensional array which
- * represents the switch matrix.
- */
-#define LAYOUT( \
- k00, k01, k02, \
- k10, k12 \
-) { \
- { k00, k01, k02 }, \
- { k10, KC_NO, k12 } \
-}
diff --git a/data/templates/base/keymaps/default/keymap.c b/data/templates/base/keymaps/default/keymap.c
index d8020ab3e3..3fec3d5120 100644
--- a/data/templates/base/keymaps/default/keymap.c
+++ b/data/templates/base/keymaps/default/keymap.c
@@ -1,18 +1,6 @@
-/* Copyright %YEAR% %YOUR_NAME%
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
+// Copyright %(YEAR)s %(YOUR_NAME)s (@%(USER_NAME)s)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
#include QMK_KEYBOARD_H
// Defines names for use in layer keycodes and the keymap
@@ -21,12 +9,6 @@ enum layer_names {
_FN
};
-// Defines the keycodes used by our macros in process_record_user
-enum custom_keycodes {
- QMKBEST = SAFE_RANGE,
- QMKURL
-};
-
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base */
[_BASE] = LAYOUT(
@@ -34,29 +16,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
KC_TAB, KC_SPC
),
[_FN] = LAYOUT(
- QMKBEST, QMKURL, _______,
+ _______, _______, _______,
RESET, XXXXXXX
)
};
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
- switch (keycode) {
- case QMKBEST:
- if (record->event.pressed) {
- // when keycode QMKBEST is pressed
- SEND_STRING("QMK is the best thing ever!");
- } else {
- // when keycode QMKBEST is released
- }
- break;
- case QMKURL:
- if (record->event.pressed) {
- // when keycode QMKURL is pressed
- SEND_STRING("https://qmk.fm/\n");
- } else {
- // when keycode QMKURL is released
- }
- break;
- }
- return true;
-}
diff --git a/data/templates/base/keymaps/default/readme.md b/data/templates/base/keymaps/default/readme.md
index e052ed80f1..63a0643275 100644
--- a/data/templates/base/keymaps/default/readme.md
+++ b/data/templates/base/keymaps/default/readme.md
@@ -1 +1 @@
-# The default keymap for %KEYBOARD%
+# The default keymap for %(KEYBOARD)s
diff --git a/data/templates/ps2avrgb/config.h b/data/templates/ps2avrgb/config.h
index 6150bcce6d..876a60252f 100644
--- a/data/templates/ps2avrgb/config.h
+++ b/data/templates/ps2avrgb/config.h
@@ -1,19 +1,5 @@
-/*
-Copyright %YEAR% %YOUR_NAME%
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>.
-*/
+// Copyright %(YEAR)s %(YOUR_NAME)s (@%(USER_NAME)s)
+// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
@@ -23,8 +9,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define VENDOR_ID 0xFEED
#define PRODUCT_ID 0x0000
#define DEVICE_VER 0x0001
-#define MANUFACTURER %YOUR_NAME%
-#define PRODUCT %KEYBOARD%
+#define MANUFACTURER %(USER_NAME)s
+#define PRODUCT %(KEYBOARD)s
/* key matrix size */
#define MATRIX_ROWS 8
diff --git a/data/templates/ps2avrgb/readme.md b/data/templates/ps2avrgb/readme.md
index 94063f9ebc..a2ac4495b6 100644
--- a/data/templates/ps2avrgb/readme.md
+++ b/data/templates/ps2avrgb/readme.md
@@ -1,20 +1,20 @@
-# %KEYBOARD%
+# %(KEYBOARD)s
-![%KEYBOARD%](imgur.com image replace me!)
+![%(KEYBOARD)s](imgur.com image replace me!)
*A short description of the keyboard/project*
-* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
+* Keyboard Maintainer: [%(YOUR_NAME)s](https://github.com/yourusername)
* Hardware Supported: *The PCBs, controllers supported*
* Hardware Availability: *Links to where you can find this hardware*
Make example for this keyboard (after setting up your build environment):
- make %KEYBOARD%:default
+ make %(KEYBOARD)s:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
- make %KEYBOARD%:default:flash
+ make %(KEYBOARD)s:default:flash
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/docs/coding_conventions_python.md b/docs/coding_conventions_python.md
index 47dff7f8ee..960b9cb49e 100644
--- a/docs/coding_conventions_python.md
+++ b/docs/coding_conventions_python.md
@@ -2,7 +2,7 @@
Most of our style follows PEP8 with some local modifications to make things less nit-picky.
-* We target Python 3.6 for compatability with all supported platforms.
+* We target Python 3.7 for compatability with all supported platforms.
* We indent using four (4) spaces (soft tabs)
* We encourage liberal use of comments
* Think of them as a story describing the feature
diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py
index 369d2bd7da..4093b8c90d 100644
--- a/lib/python/qmk/cli/new/keyboard.py
+++ b/lib/python/qmk/cli/new/keyboard.py
@@ -1,10 +1,8 @@
"""This script automates the creation of new keyboard directories using a starter template.
"""
from datetime import date
-import fileinput
from pathlib import Path
import re
-import shutil
from qmk.commands import git_get_username
import qmk.path
@@ -32,6 +30,7 @@ def validate_keyboard_name(name):
@cli.argument('-kb', '--keyboard', help='Specify the name for the new keyboard directory', arg_only=True, type=keyboard_name)
@cli.argument('-t', '--type', help='Specify the keyboard type', arg_only=True, choices=KEYBOARD_TYPES)
@cli.argument('-u', '--username', help='Specify your username (default from Git config)', arg_only=True)
+@cli.argument('-n', '--realname', help='Specify your real name if you want to use that. Defaults to username', arg_only=True)
@cli.subcommand('Creates a new keyboard directory')
def new_keyboard(cli):
"""Creates a new keyboard.
@@ -69,7 +68,7 @@ def new_keyboard(cli):
# Get username
user_name = None
while not user_name:
- user_name = question('Your Name:', default=find_user_name())
+ user_name = question('Your GitHub User Name:', default=find_user_name())
if not user_name:
cli.log.error('You didn\'t provide a username, and we couldn\'t find one set in your QMK or Git configs. Please try again.')
@@ -78,26 +77,21 @@ def new_keyboard(cli):
if cli.args.username:
return False
- # Copy all the files
- copy_templates(keyboard_type, keyboard_path)
+ real_name = None
+ while not real_name:
+ real_name = question('Your real name:', default=user_name)
- # Replace all the placeholders
keyboard_basename = keyboard_path.name
- replacements = [
- ('%YEAR%', str(date.today().year)),
- ('%KEYBOARD%', keyboard_basename),
- ('%YOUR_NAME%', user_name),
- ]
- filenames = [
- keyboard_path / 'config.h',
- keyboard_path / 'info.json',
- keyboard_path / 'readme.md',
- keyboard_path / f'{keyboard_basename}.c',
- keyboard_path / f'{keyboard_basename}.h',
- keyboard_path / 'keymaps/default/readme.md',
- keyboard_path / 'keymaps/default/keymap.c',
- ]
- replace_placeholders(replacements, filenames)
+ replacements = {
+ "YEAR": str(date.today().year),
+ "KEYBOARD": keyboard_basename,
+ "USER_NAME": user_name,
+ "YOUR_NAME": real_name,
+ }
+
+ template_dir = Path('data/templates')
+ template_tree(template_dir / 'base', keyboard_path, replacements)
+ template_tree(template_dir / keyboard_type, keyboard_path, replacements)
cli.echo('')
cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{new_keyboard_name}{{fg_green}}.{{fg_reset}}')
@@ -114,29 +108,32 @@ def find_user_name():
return git_get_username()
-def copy_templates(keyboard_type, keyboard_path):
- """Copies the template files from data/templates to the new keyboard directory.
- """
- template_base_path = Path('data/templates')
- keyboard_basename = keyboard_path.name
+def template_tree(src: Path, dst: Path, replacements: dict):
+ """Recursively copy template and replace placeholders
- cli.log.info('Copying base template files...')
- shutil.copytree(template_base_path / 'base', keyboard_path)
+ Args:
+ src (Path)
+ The source folder to copy from
+ dst (Path)
+ The destination folder to copy to
+ replacements (dict)
+ a dictionary with "key":"value" pairs to replace.
- cli.log.info(f'Copying {{fg_cyan}}{keyboard_type}{{fg_reset}} template files...')
- shutil.copytree(template_base_path / keyboard_type, keyboard_path, dirs_exist_ok=True)
+ Raises:
+ FileExistsError
+ When trying to overwrite existing files
+ """
- cli.log.info(f'Renaming {{fg_cyan}}keyboard.[ch]{{fg_reset}} to {{fg_cyan}}{keyboard_basename}.[ch]{{fg_reset}}...')
- shutil.move(keyboard_path / 'keyboard.c', keyboard_path / f'{keyboard_basename}.c')
- shutil.move(keyboard_path / 'keyboard.h', keyboard_path / f'{keyboard_basename}.h')
+ dst.mkdir(parents=True, exist_ok=True)
+ for child in src.iterdir():
+ if child.is_dir():
+ template_tree(child, dst / child.name, replacements=replacements)
-def replace_placeholders(replacements, filenames):
- """Replaces the given placeholders in each template file.
- """
- for replacement in replacements:
- cli.log.info(f'Replacing {{fg_cyan}}{replacement[0]}{{fg_reset}} with {{fg_cyan}}{replacement[1]}{{fg_reset}}...')
+ if child.is_file():
+ file_name = dst / (child.name % replacements)
- with fileinput.input(files=filenames, inplace=True) as file:
- for line in file:
- print(line.replace(replacement[0], replacement[1]), end='')
+ with file_name.open(mode='x') as dst_f:
+ with child.open() as src_f:
+ template = src_f.read()
+ dst_f.write(template % replacements)
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 08:08:37 +0000