tooling: Add Makefile and npm hooks for dev workflow. #229
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| #!/usr/bin/env sh | ||
| npx --no-install commitlint --edit "$1" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| #!/usr/bin/env sh | ||
| npx --no-install validate-branch-name && npx --no-install git-precommit-checks && npx --no-install lint-staged | ||
|
There was a problem hiding this comment. These Husky hook files don’t include a shebang (e.g.
Comment on lines
+1
to
+2
There was a problem hiding this comment.
These hook files were added with mode Useful? React with 👍 / 👎. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "endOfLine": "lf", | ||
| "semi": true, | ||
| "singleQuote": true, | ||
| "tabWidth": 4, | ||
| "arrowParens": "avoid", | ||
| "trailingComma": "all", | ||
| "useTabs": false | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "branches": ["main"], | ||
| "repositoryUrl": "https://github.com/steamicc/micropython-steami-lib.git", | ||
| "debug": false, | ||
| "plugins": [ | ||
| "@semantic-release/commit-analyzer", | ||
| "@semantic-release/release-notes-generator", | ||
| [ | ||
| "@semantic-release/changelog", | ||
| { | ||
| "changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file. See\n[Conventional Commits](https://conventionalcommits.org) for commit guidelines." | ||
| } | ||
| ], | ||
| [ | ||
| "@semantic-release/github", | ||
| { | ||
| "assets": "pack/*.tgz" | ||
| } | ||
| ], | ||
| [ | ||
| "@semantic-release/git", | ||
| { | ||
| "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}" | ||
| } | ||
| ] | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,4 @@ | ||||||
| module.exports = { | ||||||
| pattern: "^(main)$|^(feat|fix|docs|tooling|ci|test|style|chore|refactor)\/([a-z0-9]+-)*[a-z0-9]+$|^release\/v([0-9]+)\\.([0-9]+)\\.([0-9]+)([a-z0-9-]*)$", | ||||||
| errorMsg: "🤨 La branche que tu essaies de pusher ne respecte pas nos conventions, tu peux la renommer avec `git branch -m <nom-actuel> <nouveau-nom>`", | ||||||
|
There was a problem hiding this comment. Branch-name validation error message is in French and includes emojis, while the repo docs are primarily English. Consider switching to an English message (or making language configurable) so the hook output is understandable for all contributors.
Suggested change
|
||||||
| } | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,120 @@ | ||||||
| .DEFAULT_GOAL := help | ||||||
|
|
||||||
| .ONESHELL: # Applies to every targets | ||||||
|
|
||||||
| include env.mk | ||||||
|
|
||||||
| # --- Setup --- | ||||||
|
|
||||||
| # npm install is re-run only when package.json changes | ||||||
| node_modules/.package-lock.json: package.json package-lock.json | ||||||
| npm install | ||||||
| @touch $@ | ||||||
|
Comment on lines
+10
to
+12
There was a problem hiding this comment.
Because Useful? React with 👍 / 👎. |
||||||
|
|
||||||
| .PHONY: prepare | ||||||
| prepare: node_modules/.package-lock.json ## Install git hooks | ||||||
| husky | ||||||
|
There was a problem hiding this comment.
Useful? React with 👍 / 👎. There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| .PHONY: setup | ||||||
| setup: install prepare ## Full dev environment setup | ||||||
|
|
||||||
| .PHONY: install | ||||||
| install: node_modules/.package-lock.json ## Install dev tools (pip + npm) | ||||||
| python3 -m pip install -e ".[dev,test]" | ||||||
|
|
||||||
|
Comment on lines
+21
to
+24
There was a problem hiding this comment.
|
||||||
| # --- Linting --- | ||||||
|
|
||||||
| .PHONY: lint | ||||||
| lint: ## Run ruff linter | ||||||
| ruff check | ||||||
|
|
||||||
| .PHONY: lint-fix | ||||||
| lint-fix: ## Auto-fix lint issues | ||||||
| ruff check --fix | ||||||
|
|
||||||
| # --- Testing --- | ||||||
|
|
||||||
| # Dynamic per-scenario targets (test-apds9960, test-hts221, etc.) | ||||||
| # Uses 'driver' field for driver scenarios, filename stem for board scenarios. | ||||||
| # Convention: for board scenarios, the YAML 'name' field must match the filename. | ||||||
| SCENARIOS := $(shell python3 -c "import yaml,glob,os; [print(d.get('driver',os.path.basename(f).replace('.yaml',''))) for f in sorted(glob.glob('tests/scenarios/*.yaml')) for d in [yaml.safe_load(open(f))]]" 2>/dev/null) | ||||||
| $(foreach s,$(SCENARIOS),$(eval .PHONY: test-$(s))$(eval test-$(s): ; python3 -m pytest tests/ -v -k "$(s)" --port $$(PORT) -s)) | ||||||
|
There was a problem hiding this comment.
The generated Useful? React with 👍 / 👎. There was a problem hiding this comment. Dynamic per-scenario targets are generated from YAML filenames (e.g.
Suggested change
|
||||||
|
|
||||||
| .PHONY: test-mock | ||||||
| test-mock: ## Run mock tests (no hardware needed) | ||||||
| python3 -m pytest tests/ -v -k mock | ||||||
|
|
||||||
| .PHONY: test | ||||||
| test: test-mock ## Run mock tests (use 'make test-all' for mock + hardware) | ||||||
| @echo "" | ||||||
| @echo "ℹ️ Only mock tests were run. Use 'make test-all' to include hardware tests." | ||||||
|
|
||||||
| .PHONY: test-hardware | ||||||
| test-hardware: ## Run all hardware tests (needs board on PORT) | ||||||
| python3 -m pytest tests/ -v --port $(PORT) -s -k hardware | ||||||
|
|
||||||
| .PHONY: test-board | ||||||
| test-board: ## Run board tests only (buttons, LEDs, buzzer, screen) | ||||||
| python3 -m pytest tests/ -v --port $(PORT) -s -k "board_ and hardware" | ||||||
|
|
||||||
| .PHONY: test-sensors | ||||||
| test-sensors: ## Run sensor driver hardware tests (I2C devices) | ||||||
| python3 -m pytest tests/ -v --port $(PORT) -s -k "hardware and not board_" | ||||||
|
Comment on lines
+58
to
+62
There was a problem hiding this comment.
These targets split board vs sensor suites using Useful? React with 👍 / 👎. |
||||||
|
|
||||||
| .PHONY: test-all | ||||||
| test-all: ## Run all tests (mock + hardware) | ||||||
| python3 -m pytest tests/ -v --port $(PORT) -s | ||||||
|
|
||||||
| .PHONY: test-examples | ||||||
| test-examples: ## Validate all example files (syntax + imports) | ||||||
| python3 -m pytest tests/test_examples.py -v | ||||||
|
|
||||||
| # --- CI --- | ||||||
|
|
||||||
| .PHONY: ci | ||||||
| ci: lint test test-examples ## Run all CI checks (lint + tests + examples) | ||||||
|
|
||||||
| # --- Build / Package --- | ||||||
|
|
||||||
| .PHONY: build | ||||||
| build: lint test ## Build (lint + test) | ||||||
|
|
||||||
| # --- Hardware --- | ||||||
|
|
||||||
| .PHONY: repl | ||||||
| repl: ## Open MicroPython REPL on the board | ||||||
| mpremote connect $(PORT) | ||||||
|
|
||||||
| .PHONY: mount | ||||||
| mount: ## Mount lib/ on the board for live testing | ||||||
| mpremote connect $(PORT) mount lib/ | ||||||
|
|
||||||
| # --- Utilities --- | ||||||
|
|
||||||
| .PHONY: clean | ||||||
| clean: ## Remove build artifacts and caches | ||||||
| find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true | ||||||
| find . -type d -name .pytest_cache -exec rm -rf {} + 2>/dev/null || true | ||||||
| find . -type d -name .ruff_cache -exec rm -rf {} + 2>/dev/null || true | ||||||
| find . -type d -name .mypy_cache -exec rm -rf {} + 2>/dev/null || true | ||||||
|
|
||||||
| .PHONY: deepclean | ||||||
| deepclean: clean ## Remove everything including node_modules | ||||||
| rm -rf node_modules | ||||||
|
|
||||||
| .PHONY: help | ||||||
| help: ## Show this help | ||||||
| @grep -E '^[a-zA-Z_-]+:.*?## .*$$' Makefile | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-15s\033[0m %s\n", $$1, $$2}' | ||||||
|
|
||||||
| # A useful debug Make Target - found from | ||||||
| # http://lists.gnu.org/archive/html/help-make/2005-08/msg00137.html | ||||||
| .PHONY: printvars | ||||||
| printvars: | ||||||
| @$(foreach V,$(sort $(.VARIABLES)), \ | ||||||
| $(if $(filter-out environment% default automatic, \ | ||||||
| $(origin $V)),$(warning $V=$($V) ($(value $V))))) | ||||||
|
|
||||||
| # Affiche toutes les cibles disponibles dans le Makefile | ||||||
| .PHONY: list | ||||||
| list: | ||||||
| @LC_ALL=C $(MAKE) -pRrq -f $(firstword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/(^|\n)# Files(\n|$$)/,/(^|\n)# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | grep -E -v -e '^[^[:alnum:]]' -e '^$@$$' | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,58 @@ | ||||||
| module.exports = { | ||||||
| extends: ['@commitlint/config-conventional'], | ||||||
| parserPreset: { | ||||||
| parserOpts: { | ||||||
| issuePrefixes: ['#'], | ||||||
| }, | ||||||
| }, | ||||||
| rules: { | ||||||
| 'subject-case': [0], | ||||||
| 'subject-full-stop': [0], | ||||||
| 'header-max-length': [2, 'always', 78], | ||||||
| 'scope-enum': [ | ||||||
| 1, | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| 'always', | ||||||
| [ | ||||||
| 'apds9960', | ||||||
| 'bme280', | ||||||
| 'bq27441', | ||||||
| 'daplink_flash', | ||||||
| 'gc9a01', | ||||||
| 'hts221', | ||||||
| 'im34dt05', | ||||||
| 'ism330dl', | ||||||
| 'lis2mdl', | ||||||
| 'mcp23009e', | ||||||
| 'ssd1327', | ||||||
| 'steami_config', | ||||||
| 'vl53l1x', | ||||||
| 'wsen-hids', | ||||||
| 'wsen-pads', | ||||||
| 'ci', | ||||||
| 'docs', | ||||||
| 'style', | ||||||
| 'tests', | ||||||
| 'tooling', | ||||||
| ], | ||||||
| ], | ||||||
| 'type-enum': [ | ||||||
| 2, | ||||||
| 'always', | ||||||
| [ | ||||||
| 'build', | ||||||
|
Comment on lines
+38
to
+42
There was a problem hiding this comment.
The new Useful? React with 👍 / 👎. |
||||||
| 'chore', | ||||||
| 'ci', | ||||||
| 'docs', | ||||||
| 'feat', | ||||||
| 'fix', | ||||||
| 'perf', | ||||||
| 'refactor', | ||||||
| 'revert', | ||||||
| 'style', | ||||||
| 'test', | ||||||
| 'tooling', | ||||||
| ], | ||||||
| ], | ||||||
| 'body-max-line-length': [1, 'always', 100], | ||||||
| }, | ||||||
| }; | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export PATH := $(CURDIR)/node_modules/.bin:$(PATH) | ||
| PORT ?= /dev/ttyACM0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This Husky hook file doesn’t include a shebang (e.g.
#!/usr/bin/env sh). Depending on platform and how Git executes the hook, a missing shebang can cause the hook to fail to run. Add the standard Husky header (and any required initialization for your Husky major version) so the hook executes reliably.