Update forbid script (#542)

Author: casey

.github/workflows/build.yaml

@@ -81,11 +81,11 @@ jobs:
     - name: Clippy
       run: cargo clippy --all-targets --all-features
 
-    - name: Lint
+    - name: Check for Forbidden Words
       if: matrix.target == 'x86_64-apple-darwin'
       run: |
         brew install ripgrep
-        ./bin/lint
+        ./bin/forbid
 
     - name: Check Formatting
       run: cargo fmt --all -- --check

bin/forbid

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+which rg
+
+! rg \
+  --glob !bin/forbid \
+  --glob !CHANGELOG.md \
+  --ignore-case \
+  'dbg!|fixme|todo|xxx'

bin/lint

@@ -38,8 +38,8 @@ clippy:
 fmt:
 	cargo +nightly fmt --all
 
-lint:
-	./bin/lint
+forbid:
+	./bin/forbid
 
 preview-readme:
 	grip -b README.md
@@ -64,7 +64,7 @@ gen:
 check-minimal-versions:
 	./bin/check-minimal-versions
 
-check: test clippy lint check-minimal-versions gen
+check: test clippy forbid check-minimal-versions gen
 	git diff --no-ext-diff --quiet --exit-code
 	cargo +nightly fmt --all -- --check
 

justfile

@@ -51,7 +51,7 @@ impl Message {
   //
   // where prefix is the network byte order encoding of `x + 1` into a u32.
   pub(crate) fn serialize(&self) -> Result<Vec<u8>> {
-    // TODO: find a way to test this without blowing the stack.
+    // find a way to test this without blowing the stack.
     let message_length = self.len().try_into().context(error::PeerMessagePayload)?;
     let mut buf: Vec<u8> = u32::to_be_bytes(message_length).to_vec();
     buf.push(self.flavour.into());

src/peer/message.rs

@@ -75,7 +75,7 @@ mod tests {
     let mut msg = bendy::serde::ser::to_bytes(&req).unwrap();
     let benc = b"d8:msg_typei1e5:piecei1ee";
     assert_eq!(benc, &*msg);
-    msg.extend_from_slice(b"piece data goes here xxxx...");
+    msg.extend_from_slice(b"piece data goes here...");
     let req2 = bendy::serde::de::from_bytes(&msg).unwrap();
     assert_eq!(req, req2);
   }

src/peer/message/extended/ut_metadata.rs

@@ -16,12 +16,12 @@ impl Client {
 
   pub fn connect<A: ToSocketAddrs>(address: A) -> Result<Self> {
     let addrs = address
-      .to_socket_addrs() // XXX: this may cause DNS look-ups!
+      .to_socket_addrs() // this may cause DNS look-ups!
       .context(error::TrackerSocketAddrs)?;
 
     for tracker_addr in addrs {
       let Ok(sock) = Self::new_udp_socket(tracker_addr) else {
-        continue; // TODO: log these as warnings
+        continue; // log these as warnings
       };
       let mut client = Client {
         peer_id: rand::thread_rng().gen(),