bitcoindevkit / bdk_wallet / 15166368710

85%

push

github

Merge bitcoindevkit/bdk_wallet#213: chore: create and apply rustfmt.toml

<a class=hub.com/bitcoindevkit/bdk_wallet/commit/a06439334c16ff3851a7c84be632516f1ae92f40">a06439334<a href="https://github.com/bitcoindevkit/bdk_wallet/commit/606a34d34a0dcb34025c08203648a36c561ab8d9"> chore: apply fmt (Luis Schwab)
<a class="double-link" href="https://github.com/bitcoindevkit/bdk_wallet/commit/9caa9ec362b0eafbc7010f19d677b225d7289b61">9caa9ec36</a><a href="https://github.com/bitcoindevkit/bdk_wallet/commit/606a34d34a0dcb34025c08203648a36c561ab8d9"> chore: use nightly toolchain for fmt job (Luis Schwab)
</a><a class="double-link" href="https://github.com/bitcoindevkit/bdk_wallet/commit/95e4d766276438bb014359a55d74849d83d93d17">95e4d7662</a> chore: create rustfmt.toml (Luis Schwab)

Pull request description:

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description

  Closes #3.

  This PR adds basic formatting configuration for uniform comments. Note that the nightly toolchain is necessary.

  Changes:
  - Add `rustfmt.toml` with this config:
  ```
  comment_width = 100
  format_code_in_doc_comments = true
  wrap_comments = true
  ```
  - Apply `rustfmt.toml`.
  - Update the `fmt` CI job to use the nightly toolchain.
  - Update PR template to use nightly toolchain (`cargo fmt` -> `cargo +nightly fmt`).

  Note: I had to add `#[rustfmt::skip]` to `test_extract_satisfaction_timelock()` because the base64 PSBT would get wrapped due to the slashes.

  <!-- Notice the release manager should include in the release tag message changelog -->
  <!-- See https://keepachangelog.com/en/1.0.0/ for examples -->

  ### 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 `cargo +nightly fmt` and `cargo clippy` before committing

  #### Bugfixes:

  * [ ] This pull request breaks the existing API
  * [ ] I've added tests to reproduce the issue which are now passing
  * [X] I'm linking the issue being fixed by this PR

ACKs for top commit:
  notmandatory:
    ACK a06439334c16ff3851a7c84be632516f1ae92f40

Tree-SHA512: e1d9ae25f0071fe91a48aca0a80645bf78d

21 of 21 new or added lines in 3 files covered. (100.0%)

7273 of 8522 relevant lines covered (85.34%)

3465.96 hits per line