diff options
author | fauxpark <fauxpark@gmail.com> | 2019-10-10 21:48:37 +1100 |
---|---|---|
committer | Joel Challis <git@zvecr.com> | 2019-10-10 11:48:37 +0100 |
commit | ed1bf3afa25d7e7674df7e8618dfaf243de3058b (patch) | |
tree | cfe0e4331b8f00d09706dd0aaa8fef2cac3f61d7 | |
parent | 528ddb79871b76d026c4b2ca8b1debf9feb1e751 (diff) | |
download | qmk_firmware-ed1bf3afa25d7e7674df7e8618dfaf243de3058b.tar.gz qmk_firmware-ed1bf3afa25d7e7674df7e8618dfaf243de3058b.zip |
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
-rw-r--r-- | quantum/template/avr/config.h | 10 | ||||
-rw-r--r-- | quantum/template/avr/keyboard.c (renamed from quantum/template/avr/template.c) | 0 | ||||
-rw-r--r-- | quantum/template/base/keyboard.h (renamed from quantum/template/base/template.h) | 10 | ||||
-rw-r--r-- | quantum/template/base/keymaps/default/keymap.c | 23 | ||||
-rw-r--r-- | quantum/template/base/keymaps/default/readme.md | 2 | ||||
-rw-r--r-- | quantum/template/ps2avrgb/config.h | 11 | ||||
-rw-r--r-- | quantum/template/ps2avrgb/keyboard.c (renamed from quantum/template/ps2avrgb/template.c) | 0 | ||||
-rwxr-xr-x | util/new_keyboard.sh | 4 | ||||
-rwxr-xr-x | util/travis_compiled_push.sh | 2 |
9 files changed, 37 insertions, 25 deletions
diff --git a/quantum/template/avr/config.h b/quantum/template/avr/config.h index 713d6be3a..304a54ae5 100644 --- a/quantum/template/avr/config.h +++ b/quantum/template/avr/config.h | |||
@@ -23,8 +23,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
23 | #define VENDOR_ID 0xFEED | 23 | #define VENDOR_ID 0xFEED |
24 | #define PRODUCT_ID 0x0000 | 24 | #define PRODUCT_ID 0x0000 |
25 | #define DEVICE_VER 0x0001 | 25 | #define DEVICE_VER 0x0001 |
26 | #define MANUFACTURER % YOUR_NAME % | 26 | #define MANUFACTURER %YOUR_NAME% |
27 | #define PRODUCT % KEYBOARD % | 27 | #define PRODUCT %KEYBOARD% |
28 | #define DESCRIPTION A custom keyboard | 28 | #define DESCRIPTION A custom keyboard |
29 | 29 | ||
30 | /* key matrix size */ | 30 | /* key matrix size */ |
@@ -41,10 +41,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
41 | * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) | 41 | * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) |
42 | * | 42 | * |
43 | */ | 43 | */ |
44 | #define MATRIX_ROW_PINS \ | 44 | #define MATRIX_ROW_PINS { D0, D5 } |
45 | { D0, D5 } | 45 | #define MATRIX_COL_PINS { F1, F0, B0 } |
46 | #define MATRIX_COL_PINS \ | ||
47 | { F1, F0, B0 } | ||
48 | #define UNUSED_PINS | 46 | #define UNUSED_PINS |
49 | 47 | ||
50 | /* COL2ROW, ROW2COL*/ | 48 | /* COL2ROW, ROW2COL*/ |
diff --git a/quantum/template/avr/template.c b/quantum/template/avr/keyboard.c index e852a42c4..e852a42c4 100644 --- a/quantum/template/avr/template.c +++ b/quantum/template/avr/keyboard.c | |||
diff --git a/quantum/template/base/template.h b/quantum/template/base/keyboard.h index 595da73c6..2e531b1fd 100644 --- a/quantum/template/base/template.h +++ b/quantum/template/base/keyboard.h | |||
@@ -25,5 +25,11 @@ | |||
25 | * The second converts the arguments into a two-dimensional array which | 25 | * The second converts the arguments into a two-dimensional array which |
26 | * represents the switch matrix. | 26 | * represents the switch matrix. |
27 | */ | 27 | */ |
28 | #define LAYOUT(k00, k01, k02, k10, k11) \ | 28 | #define LAYOUT( \ |
29 | { {k00, k01, k02}, {k10, KC_NO, k11}, } | 29 | k00, k01, k02, \ |
30 | k10, k11 \ | ||
31 | ) \ | ||
32 | { \ | ||
33 | { k00, k01, k02 }, \ | ||
34 | { k10, KC_NO, k11 }, \ | ||
35 | } | ||
diff --git a/quantum/template/base/keymaps/default/keymap.c b/quantum/template/base/keymaps/default/keymap.c index 308cb92a7..3508055b7 100644 --- a/quantum/template/base/keymaps/default/keymap.c +++ b/quantum/template/base/keymaps/default/keymap.c | |||
@@ -16,11 +16,16 @@ | |||
16 | #include QMK_KEYBOARD_H | 16 | #include QMK_KEYBOARD_H |
17 | 17 | ||
18 | // Defines the keycodes used by our macros in process_record_user | 18 | // Defines the keycodes used by our macros in process_record_user |
19 | enum custom_keycodes { QMKBEST = SAFE_RANGE, QMKURL }; | 19 | enum custom_keycodes { |
20 | QMKBEST = SAFE_RANGE, | ||
21 | QMKURL | ||
22 | }; | ||
20 | 23 | ||
21 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | 24 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { |
22 | [0] = LAYOUT(/* Base */ | 25 | [0] = LAYOUT( /* Base */ |
23 | KC_A, KC_1, KC_H, KC_TAB, KC_SPC), | 26 | KC_A, KC_1, KC_H, |
27 | KC_TAB, KC_SPC | ||
28 | ), | ||
24 | }; | 29 | }; |
25 | 30 | ||
26 | bool process_record_user(uint16_t keycode, keyrecord_t *record) { | 31 | bool process_record_user(uint16_t keycode, keyrecord_t *record) { |
@@ -45,8 +50,14 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
45 | return true; | 50 | return true; |
46 | } | 51 | } |
47 | 52 | ||
48 | void matrix_init_user(void) {} | 53 | void matrix_init_user(void) { |
54 | |||
55 | } | ||
49 | 56 | ||
50 | void matrix_scan_user(void) {} | 57 | void matrix_scan_user(void) { |
51 | 58 | ||
52 | void led_set_user(uint8_t usb_led) {} | 59 | } |
60 | |||
61 | void led_set_user(uint8_t usb_led) { | ||
62 | |||
63 | } | ||
diff --git a/quantum/template/base/keymaps/default/readme.md b/quantum/template/base/keymaps/default/readme.md index 21aa663d5..e052ed80f 100644 --- a/quantum/template/base/keymaps/default/readme.md +++ b/quantum/template/base/keymaps/default/readme.md | |||
@@ -1 +1 @@ | |||
# The default keymap for %KEYBOARD% \ No newline at end of file | # The default keymap for %KEYBOARD% | ||
diff --git a/quantum/template/ps2avrgb/config.h b/quantum/template/ps2avrgb/config.h index a780a10af..f6d7c25e0 100644 --- a/quantum/template/ps2avrgb/config.h +++ b/quantum/template/ps2avrgb/config.h | |||
@@ -23,7 +23,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
23 | #define PRODUCT_ID 0x422D | 23 | #define PRODUCT_ID 0x422D |
24 | #define DEVICE_VER 0x0001 | 24 | #define DEVICE_VER 0x0001 |
25 | #define MANUFACTURER You | 25 | #define MANUFACTURER You |
26 | #define PRODUCT % KEYBOARD % | 26 | #define PRODUCT %KEYBOARD% |
27 | #define DESCRIPTION A custom keyboard | 27 | #define DESCRIPTION A custom keyboard |
28 | 28 | ||
29 | #define RGBLED_NUM 16 | 29 | #define RGBLED_NUM 16 |
@@ -31,13 +31,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
31 | #define MATRIX_ROWS 8 | 31 | #define MATRIX_ROWS 8 |
32 | #define MATRIX_COLS 11 | 32 | #define MATRIX_COLS 11 |
33 | 33 | ||
34 | #define MATRIX_ROW_PINS \ | 34 | #define MATRIX_ROW_PINS { B0, B1, B2, B3, B4, B5, B6, B7 } |
35 | { B0, B1, B2, B3, B4, B5, B6, B7 } | 35 | #define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5 } |
36 | #define MATRIX_COL_PINS \ | ||
37 | { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5 } | ||
38 | // #define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5, C4, C3, C2, C1, C0, D7 } | 36 | // #define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5, C4, C3, C2, C1, C0, D7 } |
39 | #define UNUSED_PINS \ | 37 | #define UNUSED_PINS {} |
40 | {} | ||
41 | 38 | ||
42 | #define DIODE_DIRECTION COL2ROW | 39 | #define DIODE_DIRECTION COL2ROW |
43 | #define DEBOUNCE 5 | 40 | #define DEBOUNCE 5 |
diff --git a/quantum/template/ps2avrgb/template.c b/quantum/template/ps2avrgb/keyboard.c index efc851748..efc851748 100644 --- a/quantum/template/ps2avrgb/template.c +++ b/quantum/template/ps2avrgb/keyboard.c | |||
diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh index 35d89e402..fe7c1a829 100755 --- a/util/new_keyboard.sh +++ b/util/new_keyboard.sh | |||
@@ -41,8 +41,8 @@ copy_templates() { | |||
41 | echo " done" | 41 | echo " done" |
42 | 42 | ||
43 | echo -n "Renaming keyboard files..." | 43 | echo -n "Renaming keyboard files..." |
44 | mv "${keyboard_dir}/template.c" "${keyboard_dir}/${keyboard_name}.c" | 44 | mv "${keyboard_dir}/keyboard.c" "${keyboard_dir}/${keyboard_name}.c" |
45 | mv "${keyboard_dir}/template.h" "${keyboard_dir}/${keyboard_name}.h" | 45 | mv "${keyboard_dir}/keyboard.h" "${keyboard_dir}/${keyboard_name}.h" |
46 | echo " done" | 46 | echo " done" |
47 | } | 47 | } |
48 | 48 | ||
diff --git a/util/travis_compiled_push.sh b/util/travis_compiled_push.sh index 4737d693b..8ca65f21a 100755 --- a/util/travis_compiled_push.sh +++ b/util/travis_compiled_push.sh | |||
@@ -12,7 +12,7 @@ if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" ]] ; the | |||
12 | # fix formatting | 12 | # fix formatting |
13 | git checkout master | 13 | git checkout master |
14 | git diff --diff-filter=AM --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 dos2unix | 14 | git diff --diff-filter=AM --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 dos2unix |
15 | git diff --diff-filter=AM --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | grep -e '^drivers' -e '^quantum' -e '^tests' -e '^tmk_core' | xargs -0 clang-format | 15 | git diff --diff-filter=AM --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | grep -e '^drivers' -e '^quantum' -e '^tests' -e '^tmk_core' | grep -v 'quantum/template' | xargs -0 clang-format |
16 | git diff --diff-filter=AM --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 git add | 16 | git diff --diff-filter=AM --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 git add |
17 | git commit -m "format code according to conventions [skip ci]" && git push git@github.com:qmk/qmk_firmware.git master | 17 | git commit -m "format code according to conventions [skip ci]" && git push git@github.com:qmk/qmk_firmware.git master |
18 | 18 | ||