chore: update to the latest version of template

nik-rev · nik-rev · commit 9f786c0dfcd7 · 2025-07-05T15:33:38.000+01:00
diff --git a/.clippy.toml b/.clippy.toml
@@ -0,0 +1,4 @@
+allow-expect-in-tests = true
+allow-unwrap-in-tests = true
+allow-dbg-in-tests = true
+allow-print-in-tests = true
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,45 @@
+name: Bug Report
+description: Create a report to help us improve
+labels: bug
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for filing a bug report! 🐛
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: Please provide a short summary of the bug
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Reproduction Steps
+      description: Steps to replicate the bug
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-outcome
+    attributes:
+      label: Expected Outcome
+      description: What you expected to happen
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-outcome
+    attributes:
+      label: Actual Outcome
+      description: What actually happened
+    validations:
+      required: true
+
+  - type: textarea
+    id: extra-info
+    attributes:
+      label: Additional information
+      description: Please provide any additional information that could be useful
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,5 @@
+---
+name: Enhancement
+about: Suggest an improvement
+labels: C-enhancement
+---
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      rust-dependencies:
+        update-types:
+          - "minor"
+          - "patch"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml
@@ -0,0 +1,33 @@
+name: Security audit
+
+on:
+  schedule:
+    - cron: '0 0 * * 1' # every Monday at 00:00 UTC
+  pull_request:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+  push:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+    branches:
+      - main
+
+env:
+  RUST_BACKTRACE: 1
+  CARGO_TERM_COLOR: always
+  CLICOLOR: 1
+
+jobs:
+  security_audit:
+    permissions:
+      issues: write
+      checks: write
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - uses: rustsec/audit-check@v2
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -1,12 +1,14 @@
-name: Build
+name: Check
 on:
   pull_request:
   push:
     branches:
       - main
 
 env:
+  RUST_BACKTRACE: 1
   CARGO_TERM_COLOR: always
+  CLICOLOR: 1
 
 jobs:
   check:
@@ -52,3 +54,12 @@ jobs:
       - uses: cachix/install-nix-action@v27
 
       - run: nix build
+
+  spelling:
+    name: Check spelling errors
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Actions Repository
+      uses: actions/checkout@v4
+    - name: Spell Check Repo
+      uses: crate-ci/typos@master
diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml
@@ -0,0 +1,25 @@
+name: Automatic dependency updates
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --rebase "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/.github/workflows/lint_pr_title.yml b/.github/workflows/lint_pr_title.yml
@@ -0,0 +1,19 @@
+name: Enforce conventional commit PR titles
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - reopened
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1 +1,5 @@
-target/
+# cargo builds into this directory
+/target
+
+# output from `nix build`
+result
diff --git a/.rustfmt.toml b/.rustfmt.toml
@@ -0,0 +1 @@
+use_field_init_shorthand = true
diff --git a/Cargo.toml b/Cargo.toml
@@ -51,12 +51,143 @@ textwrap = "0.16"
 
 openssl = { version = "0.10", features = ["vendored"] }
 
-[workspace.lints.clippy]
-pedantic = { priority = -1, level = "warn" }
-nursery = { priority = -1, level = "warn" }
-
 # The profile that 'dist' will build with
 [profile.dist]
 inherits = "release"
 codegen-units = 1
 lto = true
+
+# ============================
+# 
+#            Lints
+#
+# - strict set of lints for a
+#   more consistent codebase
+#
+# - delegate as much as possible
+#   to automated tooling 
+# 
+# ============================
+
+[workspace.lints.rust]
+# do not import if its already in scope
+# e.g. `use std::option::Option::None`
+redundant_imports = "warn"
+# Documentation for all public items
+missing_docs = "warn"
+# `foo::bar::baz` => `bar::baz` if `bar` is in scope
+unused_qualifications = "warn"
+# detects rules of macros that weren't used
+unused_macro_rules = "warn"
+# lints against e.g. undefined meta variables
+meta_variable_misuse = "warn"
+# all types must `#[derive(Copy)]`
+missing_copy_implementations = "warn"
+# all types must `#[derive(Debug)]`
+missing_debug_implementations = "warn"
+
+[workspace.lints.clippy]
+pedantic = { priority = -1, level = "warn" }
+
+# --- more consistent ways of writing code
+# 
+# `if $a { Some($b) } else { None }` => `$a.then(|| $b)`
+if_then_some_else_none = "warn"
+# `use Trait` => `use Trait as _`
+unused_trait_names = "warn"
+# `foo.rs` => `foo/mod.rs`
+self_named_module_files = "warn"
+# omit `test_` prefix in tests: `fn test_foo` => `fn foo`
+redundant_test_prefix = "warn"
+# `123832i64` => `123832_i64`
+unseparated_literal_suffix = "warn"
+# `Foo { a: _, b: 0, .. }` => `Foo { b: 0, .. }`
+# do not bind unused by `_` when pattern matching, bind by `..` instead
+unneeded_field_pattern = "warn"
+# `Err(x)?` => `return Err(x)`
+try_err = "warn"
+# `#[test] fn` must be in `#[cfg(test)]`
+tests_outside_test_module = "warn"
+# functions ending in `.and_then` could be better expressed as `?`
+return_and_then = "warn"
+# `match (A { a }) { A { a, .. } => () }` => `match (A { a: 5 }) { A { a } => () }`
+rest_pat_in_fully_bound_structs = "warn"
+# do not use differing names from the trait itself when implementing its method
+renamed_function_params = "warn"
+# `0x2345 & 0xF000 >> 12` => `0x2345 & (0xF000 >> 12)`
+precedence_bits = "warn"
+# omitting type annotations make code easier to modify
+redundant_type_annotations = "warn"
+# `assert!(r.is_ok())` => `r.unwrap()`
+assertions_on_result_states = "warn"
+# `fs::read_to_string` requires much less steps than `File::read_to_string`
+verbose_file_reads = "warn"
+# `use std::io::{self}` => `use std::io`
+unnecessary_self_imports = "warn"
+# do not lose type information about NonZero numbers
+non_zero_suggestions = "warn"
+# exit obscures flow of the program
+exit = "warn"
+# no need for a `SAFETY:` comment on safe code
+unnecessary_safety_comment = "warn"
+# each `unsafe` block must contain only 1 unsafe operation
+multiple_unsafe_ops_per_block = "warn"
+# ---
+
+# --- explain more things
+# 
+# `#[allow]` => `#[allow, reason = "why"]`
+allow_attributes_without_reason = "warn"
+# `unsafe` blocks need a `SAFETY:` comment
+undocumented_unsafe_blocks = "warn"
+# `.unwrap()` => `.expect("why")`
+unwrap_used = "warn"
+# `arr[4]` => `arr.get(4).expect("why")`
+indexing_slicing = "warn"
+# `assert!(...)` => `assert!(..., "why")`
+missing_assert_message = "warn"
+# documentation for everything
+missing_docs_in_private_items = "warn"
+# `path_buf.push("foo")` => `... = PathBuf::new().join("foo")`
+pathbuf_init_then_push = "warn"
+# explicitly mark return type as `!` for infinite loop fns
+infinite_loop = "warn"
+# ---
+
+# --- catch debug remnants
+#
+dbg_macro = "warn"
+todo = "warn"
+use_debug = "warn"
+unimplemented = "warn"
+# explicitly `#[allow]` functions to print to stdout
+print_stdout = "warn" 
+# explicitly `#[allow]` functions to print to stderr
+print_stderr = "warn"
+# ---
+
+# --- prevent bugs
+# new variants added by libraries become errors
+# instead of being silently ignored
+wildcard_enum_match_arm = "warn"
+# if function and trait provide method of same name, it is confusing
+same_name_method = "warn"
+# `create_dir(...)` => `create_dir_all(...)`
+# usually, failing when dir already exists is
+# not what we want
+create_dir = "warn"
+# ---
+
+# --- allowed lints
+# 
+# `$a * $b + $c` is slower and less precise than `$a.mul_add($b, $c)`
+# but it is more readable, the gain in speed / precision
+# will be negligible in most situations
+suboptimal_flops = "allow"
+# arbitrary limit imposes unnecessary
+# restriction and can make code harder to follow
+too_many_lines = "allow"
+# if we need it const, make it const.
+# no need to make everything that can be const, const
+missing_const_for_fn = "allow"
+# ---
diff --git a/generate_country_data/src/country_parts.rs b/generate_country_data/src/country_parts.rs
@@ -147,7 +147,7 @@ pub async fn generate_country_data(country: &countryfetch::Country) -> CountryDa
     let top_level_domains = country
         .top_level_domain
         .iter()
-        .map(|tld| format!("\"{}\"", tld))
+        .map(|tld| format!("\"{tld}\""))
         .collect();
 
     let colors = format!(
@@ -180,19 +180,19 @@ pub async fn generate_country_data(country: &countryfetch::Country) -> CountryDa
     let capital = country
         .capital
         .iter()
-        .map(|n| format!("\"{}\"", n))
+        .map(|n| format!("\"{n}\""))
         .collect();
 
     let neighbours = country
         .neighbours
         .iter()
-        .map(|n| format!("\"{}\"", n))
+        .map(|n| format!("\"{n}\""))
         .collect();
 
     let continents = country
         .continents
         .iter()
-        .map(|c| format!("\"{}\"", c))
+        .map(|c| format!("\"{c}\""))
         .collect();
 
     CountryData {
diff --git a/generate_country_data/src/main.rs b/generate_country_data/src/main.rs
@@ -39,7 +39,7 @@ async fn main() -> Result<()> {
             .join("generated_country_data.rs"),
     )
     .expect("Failed to create generated country enum")
-    .write_all(format!("{}\n{}", country_enum, country_impl).as_bytes())
+    .write_all(format!("{country_enum}\n{country_impl}").as_bytes())
     .expect("Failed to write to country.rs");
 
     Ok(())
diff --git a/rust-toolchain.toml b/rust-toolchain.toml
@@ -1,2 +1,2 @@
 toolchain.channel = "1.88"
-toolchain.components = ["rust-analyzer", "cargo", "rustfmt", "clippy"]
+toolchain.components = ["rust-analyzer", "cargo", "rustfmt", "clippy", "rustc"]

-Original file line number
+Diff line change
@@ @@ -1 +1,5 @@ @@
 -target/
 +# cargo builds into this directory
 +/target
++
 +# output from `nix build`
 +result