Merge pull request #98 from epage/template

chore: Update from _rust/main template

Author: epage

.cargo/config.toml

@@ -0,0 +1,2 @@
+[resolver]
+incompatible-rust-versions = "fallback"

.github/renovate.json5

@@ -9,13 +9,13 @@
   customManagers: [
     {
       customType: 'regex',
-      fileMatch: [
-        '^rust-toolchain\\.toml$',
-        'Cargo.toml$',
-        'clippy.toml$',
-        '\\.clippy.toml$',
-        '^\\.github/workflows/ci.yml$',
-        '^\\.github/workflows/rust-next.yml$',
+      managerFilePatterns: [
+        '/^rust-toolchain\\.toml$/',
+        '/Cargo.toml$/',
+        '/clippy.toml$/',
+        '/\\.clippy.toml$/',
+        '/^\\.github/workflows/ci.yml$/',
+        '/^\\.github/workflows/rust-next.yml$/',
       ],
       matchStrings: [
         'STABLE.*?(?<currentValue>\\d+\\.\\d+(\\.\\d+)?)',

.github/workflows/ci.yml

@@ -54,7 +54,7 @@ jobs:
     - name: Build
       run: cargo test --workspace --no-run
     - name: Test
-      run: cargo hack test --feature-powerset --workspace
+      run: cargo hack test --each-feature --workspace
   msrv:
     name: "Check MSRV"
     runs-on: ubuntu-latest
@@ -68,7 +68,7 @@ jobs:
     - uses: Swatinem/rust-cache@v2
     - uses: taiki-e/install-action@cargo-hack
     - name: Default features
-      run: cargo hack check --feature-powerset --locked --rust-version --ignore-private --workspace --all-targets
+      run: cargo hack check --each-feature --locked --rust-version --ignore-private --workspace --all-targets --keep-going
   minimal-versions:
     name: Minimal versions
     runs-on: ubuntu-latest
@@ -86,7 +86,7 @@ jobs:
     - name: Downgrade dependencies to minimal versions
       run: cargo +nightly generate-lockfile -Z minimal-versions
     - name: Compile with minimal versions
-      run: cargo +stable check --workspace --all-features --locked
+      run: cargo +stable check --workspace --all-features --locked --keep-going
   lockfile:
     runs-on: ubuntu-latest
     steps:
@@ -113,7 +113,7 @@ jobs:
     - name: Check documentation
       env:
         RUSTDOCFLAGS: -D warnings
-      run: cargo doc --workspace --all-features --no-deps --document-private-items
+      run: cargo doc --workspace --all-features --no-deps --document-private-items --keep-going
   rustfmt:
     name: rustfmt
     runs-on: ubuntu-latest
@@ -159,7 +159,7 @@ jobs:
         sarif_file: clippy-results.sarif
         wait-for-processing: true
     - name: Report status
-      run: cargo clippy --workspace --all-features --all-targets -- -D warnings --allow deprecated
+      run: cargo clippy --workspace --all-features --all-targets --keep-going -- -D warnings --allow deprecated
   coverage:
     name: Coverage
     runs-on: ubuntu-latest

.github/workflows/rust-next.yml

@@ -44,7 +44,7 @@ jobs:
     - name: Build
       run: cargo test --workspace --no-run
     - name: Test
-      run: cargo hack test --feature-powerset --workspace
+      run: cargo hack test --each-feature --workspace
   latest:
     name: "Check latest dependencies"
     runs-on: ubuntu-latest
@@ -66,4 +66,4 @@ jobs:
     - name: Build
       run: cargo test --workspace --no-run
     - name: Test
-      run: cargo hack test --feature-powerset --workspace
+      run: cargo hack test --each-feature --workspace

.pre-commit-config.yaml

@@ -1,26 +1,19 @@
+default_install_hook_types: ["pre-commit", "commit-msg"]
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
     - id: check-yaml
-      stages: [commit]
     - id: check-json
-      stages: [commit]
     - id: check-toml
-      stages: [commit]
     - id: check-merge-conflict
-      stages: [commit]
     - id: check-case-conflict
-      stages: [commit]
     - id: detect-private-key
-      stages: [commit]
   - repo: https://github.com/crate-ci/typos
-    rev: v1.16.20
+    rev: v1.32.0
     hooks:
     - id: typos
-      stages: [commit]
   - repo: https://github.com/crate-ci/committed
-    rev: v1.0.20
+    rev: v1.1.7
     hooks:
     - id: committed
-      stages: [commit-msg]

CONTRIBUTING.md

@@ -7,18 +7,18 @@ appreciate any level you're willing to do.
 
 Need some new functionality to help?  You can let us know by opening an
 [issue][new issue]. It's helpful to look through [all issues][all issues] in
-case its already being talked about.
+case it's already being talked about.
 
 ## Bug Reports
 
 Please let us know about what problems you run into, whether in behavior or
 ergonomics of API.  You can do this by opening an [issue][new issue]. It's
-helpful to look through [all issues][all issues] in case its already being
+helpful to look through [all issues][all issues] in case it's already being
 talked about.
 
 ## Pull Requests
 
-Looking for an idea? Check our [issues][issues]. If it's look more open ended,
+Looking for an idea? Check our [issues][issues]. If the issue looks open ended,
 it is probably best to post on the issue how you are thinking of resolving the
 issue so you can get feedback early in the process. We want you to be
 successful and it can be discouraging to find out a lot of re-work is needed.
@@ -41,15 +41,18 @@ As a heads up, we'll be running your PR through the following gauntlet:
 Not everything can be checked automatically though.
 
 We request that the commit history gets cleaned up.
+
 We ask that commits are atomic, meaning they are complete and have a single responsibility.
-PRs should tell a cohesive story, with test and refactor commits that keep the
+A complete commit should build, pass tests, update documentation and tests, and not have dead code.
+
+PRs should tell a cohesive story, with refactor and test commits that keep the
 fix or feature commits simple and clear.
 
 Specifically, we would encourage
 - File renames be isolated into their own commit
-- Add tests in a commit before their feature or fix, showing the current behavior.
+- Add tests in a commit before their feature or fix, showing the current behavior (i.e. they should pass).
   The diff for the feature/fix commit will then show how the behavior changed,
-  making it clearer to reviewers and the community and showing people that the
+  making the commit's intent clearer to reviewers and the community, and showing people that the
   test is verifying the expected state.
   - e.g. [clap#5520](https://github.com/clap-rs/clap/pull/5520)
 

Cargo.toml

@@ -13,12 +13,12 @@ include = [
   "Cargo.lock",
   "LICENSE*",
   "README.md",
-  "benches/**/*",
   "examples/**/*"
 ]
 
 [workspace.lints.rust]
 rust_2018_idioms = { level = "warn", priority = -1 }
+unnameable_types = "warn"
 unreachable_pub = "warn"
 unsafe_op_in_unsafe_fn = "warn"
 unused_lifetimes = "warn"
@@ -61,7 +61,7 @@ lossy_float_literal = "warn"
 macro_use_imports = "warn"
 mem_forget = "warn"
 mutex_integer = "warn"
-needless_continue = "warn"
+needless_continue = "allow"
 needless_for_each = "warn"
 negative_feature_names = "warn"
 path_buf_push_overwrite = "warn"
@@ -86,6 +86,15 @@ verbose_file_reads = "warn"
 wildcard_imports = "warn"
 zero_sized_map_values = "warn"
 
+[profile.dev]
+panic = "abort"
+
+[profile.release]
+panic = "abort"
+codegen-units = 1
+lto = true
+# debug = "line-tables-only"  # requires Cargo 1.71
+
 [package]
 name = "git2-ext"
 version = "0.6.3"

README.md

@@ -25,7 +25,7 @@ at your option.
 
 Unless you explicitly state otherwise, any contribution intentionally
 submitted for inclusion in the work by you, as defined in the Apache-2.0
-license, shall be dual licensed as above, without any additional terms or
+license, shall be dual-licensed as above, without any additional terms or
 conditions.
 
 [Crates.io]: https://crates.io/crates/git2-ext

deny.toml

@@ -87,12 +87,14 @@ allow = [
     "MIT",
     "MIT-0",
     "Apache-2.0",
+    "BSD-2-Clause",
     "BSD-3-Clause",
     "MPL-2.0",
     "Unicode-DFS-2016",
     "CC0-1.0",
     "ISC",
     "OpenSSL",
+    "Zlib",
 ]
 # The confidence threshold for detecting a license from license text.
 # The higher the value, the more closely the license text must be to the

src/lib.rs

@@ -17,3 +17,7 @@ pub(crate) mod bytes;
 
 #[cfg(test)]
 mod testing;
+
+#[doc = include_str!("../README.md")]
+#[cfg(doctest)]
+pub struct ReadmeDoctests;