diff --git a/.editorconfig b/.editorconfig index 60827f04baf..3a537d01b28 100644 --- a/.editorconfig +++ b/.editorconfig @@ -4,39 +4,39 @@ root = true [*] +end_of_line = lf indent_style = space indent_size = 4 - -# We recommend you to keep these unchanged charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true +[{*.yaml,*.yml}] # To match GitHub Actions formatting +indent_size = 2 + [*.md] trim_trailing_whitespace = false -indent_size = 4 -[{qmk,*.py}] -charset = utf-8 -max_line_length = 200 - -# Make these match what we have in .gitattributes -[*.mk] -end_of_line = lf +[{Makefile,*.mk}] indent_style = tab -[Makefile] -end_of_line = lf -indent_style = tab - -[*.sh] -end_of_line = lf - -# The gitattributes file will handle the line endings conversion properly according to the operating system settings for other files - - -# We don't have gitattributes properly for these -# So if the user have for example core.autocrlf set to true -# the line endings would be wrong. +# Don't override anything in `lib/`... [lib/**] +indent_style = unset +indent_size = unset +tab_width = unset end_of_line = unset +charset = unset +spelling_language = unset +trim_trailing_whitespace = unset +insert_final_newline = unset + +# ...except QMK's `lib/python`. +[{*.py,lib/python/**.py}] +end_of_line = lf +indent_style = space +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +max_line_length = 200 diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py index ce956d0ce14..cb50acf8bb9 100644 --- a/lib/python/qmk/cli/new/keyboard.py +++ b/lib/python/qmk/cli/new/keyboard.py @@ -15,7 +15,7 @@ from qmk.json_schema import load_jsonschema from qmk.path import keyboard from qmk.json_encoders import InfoJSONEncoder from qmk.json_schema import deep_update, json_load -from qmk.constants import MCU2BOOTLOADER +from qmk.constants import MCU2BOOTLOADER, QMK_FIRMWARE COMMUNITY = Path('layouts/default/') TEMPLATE = Path('data/templates/keyboard/') @@ -254,6 +254,6 @@ def new_keyboard(cli): augment_community_info(community_info, keyboard(kb_name) / community_info.name) cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{kb_name}{{fg_green}}.{{fg_reset}}') - cli.log.info(f'To start working on things, `cd` into {{fg_cyan}}keyboards/{kb_name}{{fg_reset}},') - cli.log.info('or open the directory in your preferred text editor.') - cli.log.info(f"And build with {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.") + cli.log.info(f"Build Command: {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.") + cli.log.info(f'Project Location: {{fg_cyan}}{QMK_FIRMWARE}/{keyboard(kb_name)}{{fg_reset}},') + cli.log.info("{{fg_yellow}}Now update the config files to match the hardware!{{fg_reset}}")