itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-29 13:21:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a simple pre-commit git hook to verify each package's formatting

Browse Source
This commit is contained in:
Jesse Braham 2023-01-16 08:18:38 -08:00 committed by Jesse Braham
parent 4d036c38e0
commit a542735847
2 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -6,11 +6,11 @@
**H**ardware **A**bstraction **L**ayer crates for the **ESP32**, **ESP32-C2**, **ESP32-C3**, **ESP32-S2**, and **ESP32-S3** from Espressif.
These HALs are `no_std`; if you are looking for `std` support please use [esp-idf-hal] instead.
These HALs are `no_std`; if you are looking for `std` support, please use [esp-idf-hal] instead.
This project is still in the early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented (you can see a full list [here]) but have varying levels of functionality. For most basic tasks, this should be usable already.
If you have any questions, comments, or concerns please [open an issue], [start a new discussion], or join us on [Matrix]. For additional information regarding any of the crates in this repository please refer to the crate's README.
If you have any questions, comments, or concerns, please [open an issue], [start a new discussion], or join us on [Matrix]. For additional information regarding any of the crates in this repository, please refer to the crate's README.
| Crate | Target | Technical Reference Manual |
| :-----------: | :-----------------------------------------------------------------: | :------------------------: |
@ -48,7 +48,7 @@ $ cargo install cargo-generate
$ cargo generate --git https://github.com/esp-rs/esp-template
```
For more information on using this template please refer to [its README].
For more information on using this template, please refer to [its README].
[cargo-generate]: https://github.com/cargo-generate/cargo-generate
[esp-template]: https://github.com/esp-rs/esp-template
@ -86,6 +86,16 @@ RISC-V is officially supported by the official Rust compiler.
[esp-rs/rust]: https://github.com/esp-rs/rust
[esp-rs/rust-build]: https://github.com/esp-rs/rust-build
## Git Hooks
We provide a simple `pre-commit` hook to verify the formatting of each package prior to committing changes. This can be enabled by placing it in the `.git/hooks/` directory:
```bash
$ cp pre-commit .git/hooks/pre-commit
```
When using this hook, you can choose to ignore its failure on a per-commit basis by committing with the `--no-verify` flag; however, you will need to be sure that all packages are formatted when submitting a pull request.
## License
Licensed under either of:

14
pre-commit Executable file
View File

@ -0,0 +1,14 @@
#!/usr/bin/env bash
# Exit immediately on first non-zero status from a command in the script.
set -o errexit
# Ensure all tools being used are available.
command -v "cargo" >/dev/null 2>&1 || { echo >&2 "The 'cargo' command is not installed, exiting"; exit 1; }
command -v "rustfmt" >/dev/null 2>&1 || { echo >&2 "The 'rustfmt' command is not installed, exiting"; exit 1; }
# Check the formatting of all Rust code for every package.
for package in "esp"*/; do
# Check package is correctly formatted.
cargo fmt --all --manifest-path "${package}Cargo.toml" -- --check
done