Compare commits

...

2 commits

Author SHA1 Message Date
KemoNine 16b47df18b Add notes on how to setup commitlint+husky 2021-01-08 20:16:00 +00:00
KemoNine a2df1a590f Flip to usb logging kconfig 2021-01-08 20:15:38 +00:00
4 changed files with 27 additions and 93 deletions

View file

@ -4,6 +4,27 @@
Need to have the `zmk-config` directory mounted at `/workspaces/zmk-config` in Docker container Need to have the `zmk-config` directory mounted at `/workspaces/zmk-config` in Docker container
## git commit linting setup
Issue 575 on GitHub
``` sh
# cd /path/to/zmk
npm install --save-dev @commitlint/{cli,config-conventional}
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
npm install --save-dev husky@next
npm install pinst --save-dev
npx husky install
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
npx commitlint --from HEAD~1 --to HEAD --verbose
touch foo
git commit -m "foo: this will fail"
git commit -m "chore: lint on commitmsg"
git reset HEAD~1
rm foo
```
## Building ## Building
``` sh ``` sh

View file

@ -21,34 +21,5 @@ CONFIG_ZMK_IDLE_TIMEOUT=15000
# Save settings after 10s instaed of 60s # Save settings after 10s instaed of 60s
#CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE=10000 #CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE=10000
################################################################################ # Add debug logging
# Debugging CONFIG_ZMK_USB_LOGGING=y
################################################################################
# Turn on logging, and set ZMK logging to debug output
CONFIG_LOG=y
CONFIG_ZMK_LOG_LEVEL_DBG=y
# Turn on USB CDC ACM device
CONFIG_USB=y
CONFIG_USB_DEVICE_STACK=y
CONFIG_USB_CDC_ACM=y
CONFIG_USB_CDC_ACM_RINGBUF_SIZE=1024
CONFIG_USB_CDC_ACM_DEVICE_NAME="CDC_ACM"
CONFIG_USB_CDC_ACM_DEVICE_COUNT=1
# Enable serial console
CONFIG_SERIAL=y
CONFIG_CONSOLE=y
CONFIG_UART_INTERRUPT_DRIVEN=y
CONFIG_UART_LINE_CTRL=y
# Enable USB UART, and set the console device
CONFIG_UART_CONSOLE=y
CONFIG_USB_UART_CONSOLE=y
CONFIG_UART_CONSOLE_ON_DEV_NAME="CDC_ACM_0"
# Sensor logging
CONFIG_SENSOR_LOG_LEVEL_DBG=y
#CONFIG_SENSOR_LOG_LEVEL=4
CONFIG_SENSOR_INIT_PRIORITY=90

View file

@ -10,34 +10,5 @@ CONFIG_ZMK_IDLE_TIMEOUT=15000
# Save settings after 10s instaed of 60s # Save settings after 10s instaed of 60s
#CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE=10000 #CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE=10000
################################################################################ # Add debug logging
# Debugging CONFIG_ZMK_USB_LOGGING=y
################################################################################
# Turn on logging, and set ZMK logging to debug output
CONFIG_LOG=y
CONFIG_ZMK_LOG_LEVEL_DBG=y
# Turn on USB CDC ACM device
CONFIG_USB=y
CONFIG_USB_DEVICE_STACK=y
CONFIG_USB_CDC_ACM=y
CONFIG_USB_CDC_ACM_RINGBUF_SIZE=1024
CONFIG_USB_CDC_ACM_DEVICE_NAME="CDC_ACM"
CONFIG_USB_CDC_ACM_DEVICE_COUNT=1
# Enable serial console
CONFIG_SERIAL=y
CONFIG_CONSOLE=y
CONFIG_UART_INTERRUPT_DRIVEN=y
CONFIG_UART_LINE_CTRL=y
# Enable USB UART, and set the console device
CONFIG_UART_CONSOLE=y
CONFIG_USB_UART_CONSOLE=y
CONFIG_UART_CONSOLE_ON_DEV_NAME="CDC_ACM_0"
# Sensor logging
CONFIG_SENSOR_LOG_LEVEL_DBG=y
#CONFIG_SENSOR_LOG_LEVEL=4
CONFIG_SENSOR_INIT_PRIORITY=90

View file

@ -22,34 +22,5 @@ CONFIG_ZMK_IDLE_TIMEOUT=15000
# Save settings after 10s instaed of 60s # Save settings after 10s instaed of 60s
#CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE=10000 #CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE=10000
################################################################################ # Add debug logging
# Debugging CONFIG_ZMK_USB_LOGGING=y
################################################################################
# Turn on logging, and set ZMK logging to debug output
CONFIG_LOG=y
CONFIG_ZMK_LOG_LEVEL_DBG=y
# Turn on USB CDC ACM device
CONFIG_USB=y
CONFIG_USB_DEVICE_STACK=y
CONFIG_USB_CDC_ACM=y
CONFIG_USB_CDC_ACM_RINGBUF_SIZE=1024
CONFIG_USB_CDC_ACM_DEVICE_NAME="CDC_ACM"
CONFIG_USB_CDC_ACM_DEVICE_COUNT=1
# Enable serial console
CONFIG_SERIAL=y
CONFIG_CONSOLE=y
CONFIG_UART_INTERRUPT_DRIVEN=y
CONFIG_UART_LINE_CTRL=y
# Enable USB UART, and set the console device
CONFIG_UART_CONSOLE=y
CONFIG_USB_UART_CONSOLE=y
CONFIG_UART_CONSOLE_ON_DEV_NAME="CDC_ACM_0"
# Sensor logging
CONFIG_SENSOR_LOG_LEVEL_DBG=y
#CONFIG_SENSOR_LOG_LEVEL=4
CONFIG_SENSOR_INIT_PRIORITY=90