Merge #1680: ci: migrate issue #523 to internal linting tool

1d3ba50 ci(lint): switch testing workflow to internal linting tool (Jose Celano)
7085250 fix(lint/toml): normalize taplo formatting across workspace (Jose Celano)
0e174af fix(lint/yaml): resolve workflow yamllint issues (Jose Celano)
b654fa5 fix(lint/markdown): resolve markdownlint violations (Jose Celano)
f9b59f0 fix(lint/cspell): configure ignores and dictionary for repo (Jose Celano)
bc1f8cc fix(lint/clippy): resolve pedantic duration and style violations (Jose Celano)
fa3b491 ci(lint): add linter config files (Jose Celano)
f2612dc docs(issue-523): add internal linting implementation plan (Jose Celano)

Pull request description:

  ## Summary
  - implement issue #523 using internal Torrust linting tool instead of MegaLinter
  - add/adapt linter config files for markdown, yaml, and toml
  - fix lint violations by category (clippy, cspell, markdown, yaml, toml) with separate commits
  - update .github/workflows/testing.yaml static-analysis job to run linter all

  ## Why
  Use the organization internal linting workflow for consistent lint behavior across Torrust repositories.

  ## Validation
  - local linter all passes

  ## Related
  - Closes #523

ACKs for top commit:
  josecelano:
    ACK 1d3ba50

Tree-SHA512: 14ce3772b280c3f1e47bcdebd91e46dacc2f4aa5911c41e8bf118cffeed80cc6b4fe20d6e98a63fe028afa94cb2a9828da225fcd5b715914ea2f024fa6703311

Author: josecelano

.cargo/config.toml

@@ -7,20 +7,20 @@ time = "build --timings --all-targets"
 
 [build]
 rustflags = [
-    "-D",
-    "warnings",
-    "-D",
-    "future-incompatible",
-    "-D",
-    "let-underscore",
-    "-D",
-    "nonstandard-style",
-    "-D",
-    "rust-2018-compatibility",
-    "-D",
-    "rust-2018-idioms",
-    "-D",
-    "rust-2021-compatibility",
-    "-D",
-    "unused",
+  "-D",
+  "warnings",
+  "-D",
+  "future-incompatible",
+  "-D",
+  "let-underscore",
+  "-D",
+  "nonstandard-style",
+  "-D",
+  "rust-2018-compatibility",
+  "-D",
+  "rust-2018-idioms",
+  "-D",
+  "rust-2021-compatibility",
+  "-D",
+  "unused",
 ]

.github/workflows/container.yaml

@@ -80,9 +80,15 @@ jobs:
                 echo "continue=true" >> $GITHUB_OUTPUT
                 echo "On \`develop\` Branch, Type: \`development\`"
 
-              elif [[ $(echo "${{ github.ref }}" | grep -P '^(refs\/heads\/releases\/)(v)(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$') ]]; then
+              elif [[ "${{ github.ref }}" =~ ^refs/heads/releases/ ]]; then
+                semver_regex='^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(\.(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?(\+([0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*))?$'
+                version=$(echo "${{ github.ref }}" | sed -n -E 's#^refs/heads/releases/##p')
+
+                if [[ ! "$version" =~ $semver_regex ]]; then
+                  echo "Not a valid release branch semver. Will Not Continue"
+                  exit 0
+                fi
 
-                version=$(echo "${{ github.ref }}" | sed -n -E 's/^(refs\/heads\/releases\/)//p')
                 echo "version=$version" >> $GITHUB_OUTPUT
                 echo "type=release" >> $GITHUB_OUTPUT
                 echo "continue=true" >> $GITHUB_OUTPUT

.github/workflows/coverage.yaml

@@ -44,7 +44,7 @@ jobs:
       - id: coverage
         name: Generate Coverage Report
         run: |
-          cargo clean 
+          cargo clean
           cargo llvm-cov --all-features --workspace --codecov --output-path ./codecov.json
 
       - id: upload
@@ -54,4 +54,4 @@ jobs:
           verbose: true
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ${{ github.workspace }}/codecov.json
-          fail_ci_if_error: true
+          fail_ci_if_error: true

.github/workflows/generate_coverage_pr.yaml

@@ -44,7 +44,7 @@ jobs:
       - id: coverage
         name: Generate Coverage Report
         run: |
-          cargo clean 
+          cargo clean
           cargo llvm-cov --all-features --workspace --codecov --output-path ./codecov.json
 
       - name: Store PR number and commit SHA

.github/workflows/testing.yaml

@@ -33,9 +33,10 @@ jobs:
         run: cargo fmt --check
 
   check:
-    name: Static Analysis
+    name: Linting
     runs-on: ubuntu-latest
     needs: format
+    timeout-minutes: 15
 
     strategy:
       matrix:
@@ -51,39 +52,25 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: ${{ matrix.toolchain }}
-          components: clippy
+          components: clippy, rustfmt
+
+      - id: node
+        name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: "20"
 
       - id: cache
         name: Enable Workflow Cache
         uses: Swatinem/rust-cache@v2
 
       - id: tools
-        name: Install Tools
-        uses: taiki-e/install-action@v2
-        with:
-          tool: cargo-machete
-
-      - id: check
-        name: Run Build Checks
-        run: cargo check --tests --benches --examples --workspace --all-targets --all-features
+        name: Install Internal Linter
+        run: cargo install --locked --git https://github.com/torrust/torrust-linting --bin linter
 
       - id: lint
-        name: Run Lint Checks
-        run: cargo clippy --tests --benches --examples --workspace --all-targets --all-features
-
-      - id: docs
-        name: Lint Documentation
-        env:
-          RUSTDOCFLAGS: "-D warnings"
-        run: cargo doc --no-deps --bins --examples --workspace --all-features
-
-      - id: clean
-        name: Clean Build Directory
-        run: cargo clean
-
-      - id: deps
-        name: Check Unused Dependencies
-        run: cargo machete
+        name: Run All Linters
+        run: linter all
 
   build:
     name: Build on ${{ matrix.os }} (${{ matrix.toolchain }})

.github/workflows/upload_coverage_pr.yaml

@@ -1,7 +1,7 @@
 name: Upload Coverage Report (PR)
 
 on:
-  # This workflow is triggered after every successfull execution
+  # This workflow is triggered after every successful execution
   # of `Generate Coverage Report` workflow.
   workflow_run:
     workflows: ["Generate Coverage Report (PR)"]

.markdownlint.json

@@ -0,0 +1,18 @@
+{
+    "default": true,
+    "MD013": false,
+    "MD031": true,
+    "MD032": true,
+    "MD040": true,
+    "MD022": true,
+    "MD009": true,
+    "MD007": {
+        "indent": 2
+    },
+    "MD026": false,
+    "MD041": false,
+    "MD034": false,
+    "MD024": false,
+    "MD033": false,
+    "MD060": false
+}

.taplo.toml

@@ -0,0 +1,27 @@
+# Taplo configuration file for TOML formatting
+# Used by the "Even Better TOML" VS Code extension
+
+# Exclude generated and runtime folders from linting
+exclude = [ ".coverage/**", "storage/**", "target/**" ]
+
+[formatting]
+# Preserve blank lines that exist
+allowed_blank_lines = 1
+# Don't reorder keys to maintain structure
+reorder_keys = false
+# Array formatting
+array_auto_collapse = false
+array_auto_expand = false
+array_trailing_comma = true
+# Inline table formatting
+compact_arrays = false
+compact_inline_tables = false
+inline_table_expand = false
+# Alignment
+align_comments = true
+align_entries = false
+# Indentation
+indent_entries = false
+indent_tables = false
+# Other
+trailing_newline = true

.yamllint-ci.yml

@@ -0,0 +1,16 @@
+extends: default
+
+rules:
+  line-length:
+    max: 200 # More reasonable for infrastructure code
+  comments:
+    min-spaces-from-content: 1 # Allow single space before comments
+  document-start: disable # Most project YAML files don't require ---
+  truthy:
+    allowed-values: ["true", "false", "yes", "no", "on", "off"] # Allow common GitHub Actions values
+
+# Ignore generated/runtime directories
+ignore: |
+  target/**
+  storage/**
+  .coverage/**

Cargo.toml

@@ -19,13 +19,13 @@ version.workspace = true
 name = "torrust_tracker_lib"
 
 [workspace.package]
-authors = ["Nautilus Cyberneering <info@nautilus-cyberneering.de>, Mick van Dijke <mick@dutchbits.nl>"]
-categories = ["network-programming", "web-programming"]
+authors = [ "Nautilus Cyberneering <info@nautilus-cyberneering.de>, Mick van Dijke <mick@dutchbits.nl>" ]
+categories = [ "network-programming", "web-programming" ]
 description = "A feature rich BitTorrent tracker."
 documentation = "https://docs.rs/crate/torrust-tracker/"
 edition = "2021"
 homepage = "https://torrust.com/"
-keywords = ["bittorrent", "file-sharing", "peer-to-peer", "torrent", "tracker"]
+keywords = [ "bittorrent", "file-sharing", "peer-to-peer", "torrent", "tracker" ]
 license = "AGPL-3.0-only"
 publish = true
 repository = "https://github.com/torrust/torrust-tracker"
@@ -34,19 +34,19 @@ version = "3.0.0-develop"
 
 [dependencies]
 anyhow = "1"
-axum-server = { version = "0", features = ["tls-rustls-no-provider"] }
+axum-server = { version = "0", features = [ "tls-rustls-no-provider" ] }
 bittorrent-http-tracker-core = { version = "3.0.0-develop", path = "packages/http-tracker-core" }
 bittorrent-tracker-core = { version = "3.0.0-develop", path = "packages/tracker-core" }
 bittorrent-udp-tracker-core = { version = "3.0.0-develop", path = "packages/udp-tracker-core" }
-chrono = { version = "0", default-features = false, features = ["clock"] }
-clap = { version = "4", features = ["derive", "env"] }
+chrono = { version = "0", default-features = false, features = [ "clock" ] }
+clap = { version = "4", features = [ "derive", "env" ] }
 rand = "0"
 regex = "1"
-reqwest = { version = "0", features = ["json"] }
-serde = { version = "1", features = ["derive"] }
-serde_json = { version = "1", features = ["preserve_order"] }
+reqwest = { version = "0", features = [ "json" ] }
+serde = { version = "1", features = [ "derive" ] }
+serde_json = { version = "1", features = [ "preserve_order" ] }
 thiserror = "2.0.12"
-tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
+tokio = { version = "1", features = [ "macros", "net", "rt-multi-thread", "signal", "sync" ] }
 tokio-util = "0.7.15"
 torrust-axum-health-check-api-server = { version = "3.0.0-develop", path = "packages/axum-health-check-api-server" }
 torrust-axum-http-tracker-server = { version = "3.0.0-develop", path = "packages/axum-http-tracker-server" }
@@ -59,7 +59,7 @@ torrust-tracker-configuration = { version = "3.0.0-develop", path = "packages/co
 torrust-tracker-swarm-coordination-registry = { version = "3.0.0-develop", path = "packages/swarm-coordination-registry" }
 torrust-udp-tracker-server = { version = "3.0.0-develop", path = "packages/udp-tracker-server" }
 tracing = "0"
-tracing-subscriber = { version = "0", features = ["json"] }
+tracing-subscriber = { version = "0", features = [ "json" ] }
 
 [dev-dependencies]
 bittorrent-primitives = "0.1.0"
@@ -70,7 +70,7 @@ torrust-rest-tracker-api-client = { version = "3.0.0-develop", path = "packages/
 torrust-tracker-test-helpers = { version = "3.0.0-develop", path = "packages/test-helpers" }
 
 [workspace]
-members = ["console/tracker-client", "packages/torrent-repository-benchmarking"]
+members = [ "console/tracker-client", "packages/torrent-repository-benchmarking" ]
 
 [profile.dev]
 debug = 1