2019-04-18 14:27:27 +00:00
|
|
|
## help commands:
|
|
|
|
|
|
|
|
help: ## show this help
|
|
|
|
@awk -f ./tools/help.awk $(MAKEFILE_LIST)
|
|
|
|
|
|
|
|
## style commands:
|
|
|
|
|
2022-02-14 13:22:17 +00:00
|
|
|
PY_FILES = $(shell find . -type f -name '*.py' | sed 'sO^\./OO' | grep -f ./tools/style.py.include | grep -v -f ./tools/style.py.exclude )
|
2019-05-13 13:13:43 +00:00
|
|
|
C_FILES = $(shell find . -type f -name '*.[ch]' | grep -f ./tools/style.c.include | grep -v -f ./tools/style.c.exclude )
|
2019-05-06 16:03:41 +00:00
|
|
|
|
|
|
|
|
2021-09-08 11:50:56 +00:00
|
|
|
style_check: pystyle_check ruststyle_check cstyle_check changelog_check yaml_check editor_check ## run all style checks
|
2019-05-13 15:20:35 +00:00
|
|
|
|
2021-09-08 11:50:56 +00:00
|
|
|
style: pystyle ruststyle cstyle ## apply all code styles (C+Rust+Py)
|
2019-05-13 15:20:35 +00:00
|
|
|
|
|
|
|
pystyle_check: ## run code style check on application sources and tests
|
2019-04-18 14:27:27 +00:00
|
|
|
flake8 --version
|
|
|
|
isort --version | awk '/VERSION/{print $$2}'
|
|
|
|
black --version
|
2021-10-13 13:45:26 +00:00
|
|
|
pylint --version
|
2022-01-05 10:41:48 +00:00
|
|
|
pyright --version
|
|
|
|
@echo [TYPECHECK]
|
|
|
|
@make -C core typecheck
|
2019-05-13 15:20:35 +00:00
|
|
|
@echo [FLAKE8]
|
|
|
|
@flake8 $(PY_FILES)
|
|
|
|
@echo [ISORT]
|
|
|
|
@isort --check-only $(PY_FILES)
|
|
|
|
@echo [BLACK]
|
|
|
|
@black --check $(PY_FILES)
|
2021-10-13 13:45:26 +00:00
|
|
|
@echo [PYLINT]
|
|
|
|
@pylint $(PY_FILES)
|
2021-11-26 13:18:30 +00:00
|
|
|
@echo [PYTHON]
|
2019-05-06 16:03:41 +00:00
|
|
|
make -C python style_check
|
2019-04-18 14:27:27 +00:00
|
|
|
|
2022-02-14 17:15:11 +00:00
|
|
|
pystyle_quick_check: ## run the basic style checks, suitable for a quick git hook
|
|
|
|
@isort --check-only $(PY_FILES)
|
|
|
|
@black --check $(PY_FILES)
|
|
|
|
make -C python style_quick_check
|
|
|
|
|
2019-05-13 15:20:35 +00:00
|
|
|
pystyle: ## apply code style on application sources and tests
|
|
|
|
@echo [ISORT]
|
|
|
|
@isort $(PY_FILES)
|
|
|
|
@echo [BLACK]
|
|
|
|
@black $(PY_FILES)
|
2022-01-05 10:41:48 +00:00
|
|
|
@echo [TYPECHECK]
|
|
|
|
@make -C core typecheck
|
2019-08-06 08:08:23 +00:00
|
|
|
@echo [FLAKE8]
|
|
|
|
@flake8 $(PY_FILES)
|
2021-10-13 13:45:26 +00:00
|
|
|
@echo [PYLINT]
|
|
|
|
@pylint $(PY_FILES)
|
2021-11-26 13:18:30 +00:00
|
|
|
@echo [PYTHON]
|
2019-05-06 16:03:41 +00:00
|
|
|
make -C python style
|
2019-04-18 14:27:27 +00:00
|
|
|
|
2020-11-11 13:23:28 +00:00
|
|
|
changelog_check: ## check changelog format
|
2021-04-19 11:32:52 +00:00
|
|
|
./tools/generate-changelog.py --check core
|
2021-06-21 22:43:04 +00:00
|
|
|
./tools/generate-changelog.py --check core/embed/boardloader
|
|
|
|
./tools/generate-changelog.py --check core/embed/bootloader
|
|
|
|
./tools/generate-changelog.py --check core/embed/bootloader_ci
|
2021-04-19 11:32:52 +00:00
|
|
|
./tools/generate-changelog.py --check legacy/bootloader
|
2021-06-21 22:43:04 +00:00
|
|
|
./tools/generate-changelog.py --check legacy/firmware
|
|
|
|
./tools/generate-changelog.py --check legacy/intermediate_fw
|
|
|
|
./tools/generate-changelog.py --check python
|
2020-07-02 13:36:38 +00:00
|
|
|
|
2020-11-11 13:23:28 +00:00
|
|
|
yaml_check: ## check yaml formatting
|
2020-11-09 17:52:34 +00:00
|
|
|
yamllint .
|
|
|
|
|
2020-11-11 13:43:09 +00:00
|
|
|
editor_check: ## check editorconfig formatting
|
|
|
|
editorconfig-checker -exclude '.*\.(so|dat|toif|der)'
|
|
|
|
|
2019-04-18 14:27:27 +00:00
|
|
|
cstyle_check: ## run code style check on low-level C code
|
2019-05-14 14:41:06 +00:00
|
|
|
clang-format --version
|
2019-05-13 15:20:35 +00:00
|
|
|
@echo [CLANG-FORMAT]
|
|
|
|
@./tools/clang-format-check $(C_FILES)
|
2019-04-18 14:27:27 +00:00
|
|
|
|
|
|
|
cstyle: ## apply code style on low-level C code
|
2019-05-13 15:20:35 +00:00
|
|
|
@echo [CLANG-FORMAT]
|
|
|
|
@clang-format -i $(C_FILES)
|
2019-05-13 15:57:29 +00:00
|
|
|
|
|
|
|
defs_check: ## check validity of coin definitions and protobuf files
|
|
|
|
jsonlint common/defs/*.json common/defs/*/*.json
|
|
|
|
python3 common/tools/cointool.py check
|
2021-10-27 10:35:58 +00:00
|
|
|
python3 common/tools/support.py check
|
2019-05-13 15:57:29 +00:00
|
|
|
python3 common/protob/check.py
|
|
|
|
python3 common/protob/graph.py common/protob/*.proto
|
2019-05-17 12:21:26 +00:00
|
|
|
|
2021-09-08 11:50:56 +00:00
|
|
|
ruststyle:
|
|
|
|
@echo [RUSTFMT]
|
|
|
|
@cd core/embed/rust ; cargo fmt
|
2023-06-06 04:06:10 +00:00
|
|
|
@cd rust/trezor-client ; cargo fmt
|
2021-09-08 11:50:56 +00:00
|
|
|
|
|
|
|
ruststyle_check:
|
|
|
|
rustfmt --version
|
|
|
|
@echo [RUSTFMT]
|
|
|
|
@cd core/embed/rust ; cargo fmt -- --check
|
2023-06-06 04:06:10 +00:00
|
|
|
@cd rust/trezor-client ; cargo fmt -- --check
|
2021-09-08 11:50:56 +00:00
|
|
|
|
2022-05-27 14:15:21 +00:00
|
|
|
python_support_check:
|
|
|
|
./tests/test_python_support.py
|
|
|
|
|
2019-05-17 12:21:26 +00:00
|
|
|
## code generation commands:
|
|
|
|
|
|
|
|
mocks: ## generate mock python headers from C modules
|
|
|
|
./core/tools/build_mocks
|
|
|
|
|
|
|
|
mocks_check: ## check validity of mock python headers
|
|
|
|
./core/tools/build_mocks --check
|
|
|
|
flake8 core/mocks/generated
|
|
|
|
|
2021-11-04 10:05:15 +00:00
|
|
|
templates: icons ## rebuild coin lists from definitions in common
|
2019-05-17 12:21:26 +00:00
|
|
|
./core/tools/build_templates
|
|
|
|
|
|
|
|
templates_check: ## check that coin lists are up to date
|
|
|
|
./core/tools/build_templates --check
|
|
|
|
|
2023-10-18 10:02:09 +00:00
|
|
|
solana_templates: ## rebuild Solana instruction template file
|
|
|
|
./core/tools/build_solana_templates
|
|
|
|
|
|
|
|
solana_templates_check: ## check that Solana instruction template file is up to date
|
|
|
|
./core/tools/build_solana_templates --check
|
|
|
|
|
2019-11-28 13:44:00 +00:00
|
|
|
icons: ## generate FIDO service icons
|
|
|
|
python3 core/tools/build_icons.py
|
|
|
|
|
|
|
|
icons_check: ## generate FIDO service icons
|
|
|
|
python3 core/tools/build_icons.py --check
|
|
|
|
|
2023-09-29 18:13:00 +00:00
|
|
|
protobuf: ## generate python and rust protobuf headers
|
2019-05-17 12:21:26 +00:00
|
|
|
./tools/build_protobuf
|
2023-09-29 18:13:00 +00:00
|
|
|
./rust/trezor-client/scripts/build_protos
|
2019-05-17 12:21:26 +00:00
|
|
|
|
|
|
|
protobuf_check: ## check that generated protobuf headers are up to date
|
|
|
|
./tools/build_protobuf --check
|
2023-09-29 18:13:00 +00:00
|
|
|
./rust/trezor-client/scripts/build_protos --check
|
2019-05-17 12:21:26 +00:00
|
|
|
|
2022-03-14 19:10:10 +00:00
|
|
|
ci_docs: ## generate CI documentation
|
|
|
|
./tools/generate_ci_docs.py
|
2019-05-17 13:08:42 +00:00
|
|
|
|
2022-03-14 19:10:10 +00:00
|
|
|
ci_docs_check: ## check that generated CI documentation is up to date
|
|
|
|
./tools/generate_ci_docs.py --check
|
|
|
|
|
2023-08-10 11:31:51 +00:00
|
|
|
vendorheader: ## generate vendor header
|
|
|
|
./core/embed/vendorheader/generate.sh --quiet
|
2022-03-14 19:10:10 +00:00
|
|
|
|
2023-08-10 11:31:51 +00:00
|
|
|
vendorheader_check: ## check that vendor header is up to date
|
|
|
|
./core/embed/vendorheader/generate.sh --quiet --check
|
|
|
|
|
2023-10-18 10:02:09 +00:00
|
|
|
gen: mocks icons templates protobuf ci_docs vendorheader solana_templates ## regenerate auto-generated files from sources
|
2023-08-10 11:31:51 +00:00
|
|
|
|
2023-10-18 10:02:09 +00:00
|
|
|
gen_check: mocks_check icons_check templates_check protobuf_check ci_docs_check vendorheader_check solana_templates_check ## check validity of auto-generated files
|