bitcoindevkit / bdk_wallet / 15719064446

85%

push

github

Merge bitcoindevkit/bdk_wallet#268: feat: add `justfile`

<a class=hub.com/bitcoindevkit/bdk_wallet/commit/789c77bc54e624f8b5ff112edb12117fd9540ea4">789c77bc5 feat: add `justfile` (Luis Schwab)

Pull request description:

  ### Description

  Closes #240.

  This PR adds a `justfile`, updates the PR template to use it, and adds a section on the `README.md` to show available recipes.

  These are the implemented recipes:
  ```justfile
  alias b := build
  alias c := check
  alias f := fmt
  alias t := test
  alias p := pre-push

  build:
      cargo build

  check:
      cargo +nightly fmt --all -- --check
      cargo check --workspace --exclude 'example_*' --all-features
      cargo clippy --all-features --all-targets -- -D warnings
      @[ "$(git log --pretty='format:%G?' -1 HEAD)" = "N" ] && \
          echo "\n⚠️  Unsigned commit: BDK requires that commits be signed." || \
          true

  fmt:
      cargo +nightly fmt

  test:
      cargo test --workspace --exclude 'example_*' --all-features

  pre-push: fmt check test
  ```

  `check` will verify if `HEAD` was signed and echo that warning if not. It does not check all commits, but I think that checking only the last is a pretty good heuristic (who only signs the last commit?).

  Before pushing, one only needs to run `just p`.

  ### Checklists

  #### All Submissions:

  * [X] I've signed all my commits
  * [X] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [X] I ran `just p` before pushing

ACKs for top commit:
  notmandatory:
    ACK 789c77bc54e624f8b5ff112edb12117fd9540ea4

Tree-SHA512: deead107f1be4d43bf3f2a8246999a899a3

7377 of 8623 relevant lines covered (85.55%)

3484.2 hits per line