setup formatter

Author: ngalaiko

.github/workflows/build.yaml

@@ -20,8 +20,9 @@ jobs:
     steps:
       - uses: actions/checkout@v5
       - uses: nixbuild/nix-quick-install-action@v35
+      # Includes the treefmt `formatting` check (nix/python/shell/yaml), so a
+      # dirty format fails here — no separate `nix fmt && git diff` step needed.
       - run: nix flake check --all-systems
-      - run: nix fmt . && git diff --exit-code
 
   build:
     name: Build ${{ matrix.system }}

README.md

@@ -3,6 +3,7 @@
 # computer
 
 nix files for:
+
 - my mac
 - my remote [exe.dev](https://exe.dev) machine
 
@@ -93,12 +94,12 @@ nodes; use an ephemeral key so retired ones auto-clean (see step 3).
    statedir (not backed up), so a fresh machine registers new nodes; the
    ephemeral key lets retired ones auto-remove once offline — no manual cleanup.
 
-4. Enable **HTTPS Certificates** (admin console → DNS → *Enable HTTPS*, needs
+4. Enable **HTTPS Certificates** (admin console → DNS → _Enable HTTPS_, needs
    MagicDNS on). Required to provision the `*.ts.net` certs. The `computer`
    node's `tailscale-serve` service re-asserts this on every boot:
    - `https://computer.<tailnet>.ts.net/<tenant>/` → ingress, **public via
      Funnel** (needs the `nodeAttrs` above). Unauthenticated — see the note in
-     `hosts/exedev/default.nix`. This one is named after the *node*, so on a
+     `hosts/exedev/default.nix`. This one is named after the _node_, so on a
      recreation where the retired ephemeral node hasn't dropped yet Tailscale
      may suffix it (`computer-1`) until the stale one is culled; exe.dev's
      public share is the stable public path if that matters.
@@ -161,9 +162,9 @@ nodes; use an ephemeral key so retired ones auto-clean (see step 3).
 
 We have to store it outside of the machine to be able to restore everything else on startup.
 
-| Variable | Description |
-| --- | --- |
+| Variable            | Description                              |
+| ------------------- | ---------------------------------------- |
 | `RESTIC_REPOSITORY` | B2 restic repo, e.g. `b2:backups:exedev` |
-| `RESTIC_PASSWORD` | restic repo encryption password |
-| `B2_ACCOUNT_ID` | B2 key id |
-| `B2_ACCOUNT_KEY` | B2 application key (scope to the bucket) |
+| `RESTIC_PASSWORD`   | restic repo encryption password          |
+| `B2_ACCOUNT_ID`     | B2 key id                                |
+| `B2_ACCOUNT_KEY`    | B2 application key (scope to the bucket) |

flake.lock

@@ -37,6 +37,12 @@
     # nix-darwin `homebrew` module only manages an already-installed brew.
     # (No nixpkgs input to follow; it pins Homebrew/brew via its own brew-src.)
     nix-homebrew.url = "github:zhaofengli/nix-homebrew";
+    # One `nix fmt` / `nix flake check` gate over the whole tree (nix, python,
+    # shell, yaml) instead of nix-only. Config lives in ./treefmt.nix.
+    treefmt-nix = {
+      url = "github:numtide/treefmt-nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
   };
 
   outputs =
@@ -70,6 +76,9 @@
           ./hosts/exedev;
 
       releaseFor = system: import ./packages/release { pkgs = nixpkgs.legacyPackages.${system}; };
+
+      treefmtFor =
+        system: inputs.treefmt-nix.lib.evalModule nixpkgs.legacyPackages.${system} ./treefmt.nix;
     in
     {
       # This Mac, configured with a Linux builder VM (so it can build *-linux).
@@ -110,6 +119,12 @@
           };
       });
 
-      formatter = lib.genAttrs allSystems (system: nixpkgs.legacyPackages.${system}.nixfmt-tree);
+      formatter = lib.genAttrs allSystems (system: (treefmtFor system).config.build.wrapper);
+
+      # `nix flake check` fails if the tree isn't treefmt-clean. CI relies on this
+      # instead of a bespoke `nix fmt && git diff` step.
+      checks = lib.genAttrs allSystems (system: {
+        formatting = (treefmtFor system).config.build.check self;
+      });
     };
 }

flake.nix

@@ -90,7 +90,9 @@ def sync_release(item, references, attachments, token, lp_date, index):
     url = release_url(info)
     title = info["title"]
     year = info.get("year") or ""
-    artists = [clean_artist(a["name"]) for a in info.get("artists", []) if a.get("name")]
+    artists = [
+        clean_artist(a["name"]) for a in info.get("artists", []) if a.get("name")
+    ]
 
     existing = index.get(url.rstrip("/"))
     if existing:
@@ -107,16 +109,21 @@ def sync_release(item, references, attachments, token, lp_date, index):
         ext = os.path.splitext(cover.split("?")[0])[1] or ".jpeg"
         cover_file = f"{base}{ext}"
         try:
-            vaultlib.download(cover, os.path.join(attachments, cover_file),
-                              {"User-Agent": UA, "Authorization": f"Discogs token={token}"})
+            vaultlib.download(
+                cover,
+                os.path.join(attachments, cover_file),
+                {"User-Agent": UA, "Authorization": f"Discogs token={token}"},
+            )
         except Exception as e:
             print(f"  war: cover download failed for {title}: {e}", file=sys.stderr)
             cover_file = None
 
     for a in artists:
         vaultlib.ensure_person_note(references, a, "Artists")
 
-    vaultlib.write_note(path, album_note(title, year, artists, cover_file, url, lp_date))
+    vaultlib.write_note(
+        path, album_note(title, year, artists, cover_file, url, lp_date)
+    )
     index[url.rstrip("/")] = path
     kind = "owned" if lp_date else "wishlist"
     print(f"  new album ({kind}): {os.path.basename(path)}  ({', '.join(artists)})")
@@ -132,10 +139,14 @@ def main(username, token, vault, include_wantlist):
     index = vaultlib.index_by_field(references, "discogs")
     created = updated = 0
 
-    collection = urljoin(BASE_URL, f"/users/{username}/collection/folders/0/releases?sort=artist")
+    collection = urljoin(
+        BASE_URL, f"/users/{username}/collection/folders/0/releases?sort=artist"
+    )
     for item in paginate(collection, token, "releases"):
         date_added = (item.get("date_added") or "")[:10]  # ISO ts -> YYYY-MM-DD
-        result = sync_release(item, references, attachments, token, date_added or None, index)
+        result = sync_release(
+            item, references, attachments, token, date_added or None, index
+        )
         created += result == "new"
         updated += result == "updated"
 
@@ -149,11 +160,23 @@ def main(username, token, vault, include_wantlist):
 
 
 if __name__ == "__main__":
-    p = argparse.ArgumentParser(description="Sync Discogs collection + wantlist into vault Album notes.")
-    p.add_argument("-u", "--username", default=os.environ.get("DISCOGS_USERNAME", "ngalaiko"))
+    p = argparse.ArgumentParser(
+        description="Sync Discogs collection + wantlist into vault Album notes."
+    )
+    p.add_argument(
+        "-u", "--username", default=os.environ.get("DISCOGS_USERNAME", "ngalaiko")
+    )
     p.add_argument("-t", "--token", default=os.environ.get("DISCOGS_TOKEN"))
-    p.add_argument("--vault", default=os.environ.get("OBSIDIAN_VAULT_DIR", "/var/lib/assistant/Vault"))
-    p.add_argument("--no-wantlist", dest="wantlist", action="store_false", help="skip the wantlist (owned records only)")
+    p.add_argument(
+        "--vault",
+        default=os.environ.get("OBSIDIAN_VAULT_DIR", "/var/lib/assistant/Vault"),
+    )
+    p.add_argument(
+        "--no-wantlist",
+        dest="wantlist",
+        action="store_false",
+        help="skip the wantlist (owned records only)",
+    )
     args = p.parse_args()
     if not args.token:
         sys.exit("discogs: no token (set DISCOGS_TOKEN or pass --token)")

packages/vault-sync/discogs.py

@@ -55,7 +55,8 @@ def parse_feed(body):
             "url": f"https://letterboxd.com/film/{slug_match.group(1)}/",
             "year": year_el.text if year_el is not None else "",
             "watched": watched_el.text,  # YYYY-MM-DD
-            "liked": item.findtext("letterboxd:memberLike", default="No", namespaces=NS) == "Yes",
+            "liked": item.findtext("letterboxd:memberLike", default="No", namespaces=NS)
+            == "Yes",
             "poster": poster,
         }
 
@@ -67,11 +68,15 @@ def scrape_directors(film_url):
     except Exception as e:  # network hiccup — create the note without directors
         print(f"  war: could not fetch {film_url}: {e}", file=sys.stderr)
         return []
-    m = re.search(r'<script type="application/ld\+json">(.*?)</script>', html, re.DOTALL)
+    m = re.search(
+        r'<script type="application/ld\+json">(.*?)</script>', html, re.DOTALL
+    )
     if not m:
         return []
     blob = m.group(1)
-    blob = re.sub(r"/\*.*?\*/", "", blob, flags=re.DOTALL).strip()  # strip CDATA comments
+    blob = re.sub(
+        r"/\*.*?\*/", "", blob, flags=re.DOTALL
+    ).strip()  # strip CDATA comments
     try:
         data = json.loads(blob)
     except json.JSONDecodeError:
@@ -115,16 +120,23 @@ def main(username, vault):
                 print(f"  + watched {entry['watched']}: {os.path.basename(existing)}")
             continue
 
-        path, base = vaultlib.unique_note_path(references, entry["title"], entry["year"])
+        path, base = vaultlib.unique_note_path(
+            references, entry["title"], entry["year"]
+        )
 
         poster_file = None
         if entry["poster"]:
             ext = os.path.splitext(entry["poster"].split("?")[0])[1] or ".jpg"
             poster_file = f"{base}{ext}"
             try:
-                vaultlib.download(entry["poster"], os.path.join(attachments, poster_file), HEADERS)
+                vaultlib.download(
+                    entry["poster"], os.path.join(attachments, poster_file), HEADERS
+                )
             except Exception as e:
-                print(f"  war: poster download failed for {entry['title']}: {e}", file=sys.stderr)
+                print(
+                    f"  war: poster download failed for {entry['title']}: {e}",
+                    file=sys.stderr,
+                )
                 poster_file = None
 
         directors = scrape_directors(entry["url"])
@@ -133,18 +145,34 @@ def main(username, vault):
 
         vaultlib.write_note(
             path,
-            movie_note(entry["title"], entry["year"], poster_file, directors,
-                       entry["url"], entry["liked"], entry["watched"]),
+            movie_note(
+                entry["title"],
+                entry["year"],
+                poster_file,
+                directors,
+                entry["url"],
+                entry["liked"],
+                entry["watched"],
+            ),
         )
         created += 1
-        print(f"  new movie: {os.path.basename(path)}  (dir: {', '.join(directors) or '?'})")
+        print(
+            f"  new movie: {os.path.basename(path)}  (dir: {', '.join(directors) or '?'})"
+        )
 
     print(f"letterboxd: {created} new, {updated} updated")
 
 
 if __name__ == "__main__":
-    p = argparse.ArgumentParser(description="Sync Letterboxd diary into vault Movie notes.")
-    p.add_argument("-u", "--username", default=os.environ.get("LETTERBOXD_USERNAME", "ngalaiko"))
-    p.add_argument("--vault", default=os.environ.get("OBSIDIAN_VAULT_DIR", "/var/lib/assistant/Vault"))
+    p = argparse.ArgumentParser(
+        description="Sync Letterboxd diary into vault Movie notes."
+    )
+    p.add_argument(
+        "-u", "--username", default=os.environ.get("LETTERBOXD_USERNAME", "ngalaiko")
+    )
+    p.add_argument(
+        "--vault",
+        default=os.environ.get("OBSIDIAN_VAULT_DIR", "/var/lib/assistant/Vault"),
+    )
     args = p.parse_args()
     main(args.username, args.vault)

packages/vault-sync/letterboxd.py

@@ -70,7 +70,7 @@ def index_by_field(references_dir, key):
             continue
         for line in lines:
             if line.startswith(needle):
-                index[line[len(needle):].strip().rstrip("/")] = path
+                index[line[len(needle) :].strip().rstrip("/")] = path
                 break
     return index
 
@@ -99,14 +99,23 @@ def add_list_item(path, key, item):
 
     if not lines or lines[0].rstrip("\n") != "---":
         return False
-    fm_end = next((i for i in range(1, len(lines)) if lines[i].rstrip("\n") == "---"), None)
+    fm_end = next(
+        (i for i in range(1, len(lines)) if lines[i].rstrip("\n") == "---"), None
+    )
     if fm_end is None:
         return False
-    key_idx = next((i for i in range(1, fm_end) if re.match(rf"^{re.escape(key)}:( |$)", lines[i].rstrip("\n"))), None)
+    key_idx = next(
+        (
+            i
+            for i in range(1, fm_end)
+            if re.match(rf"^{re.escape(key)}:( |$)", lines[i].rstrip("\n"))
+        ),
+        None,
+    )
     if key_idx is None:
         return False
 
-    rest = lines[key_idx].rstrip("\n")[len(key) + 1:].strip()
+    rest = lines[key_idx].rstrip("\n")[len(key) + 1 :].strip()
     if rest:
         # scalar form: upgrade to a list, keeping the existing value first
         if rest == quoted_item:
@@ -136,7 +145,9 @@ def set_scalar_if_empty(path, key, value):
         lines = f.read().splitlines(keepends=True)
     if not lines or lines[0].rstrip("\n") != "---":
         return False
-    fm_end = next((i for i in range(1, len(lines)) if lines[i].rstrip("\n") == "---"), None)
+    fm_end = next(
+        (i for i in range(1, len(lines)) if lines[i].rstrip("\n") == "---"), None
+    )
     if fm_end is None:
         return False
     for i in range(1, fm_end):

packages/vault-sync/vaultlib.py

@@ -0,0 +1,23 @@
+{
+  # Whole-tree formatter. `nix fmt` formats; `nix flake check` verifies (see the
+  # `formatting` check in flake.nix). Add a language by enabling its program here.
+  projectRootFile = "flake.nix";
+
+  programs = {
+    nixfmt.enable = true; # nix
+    ruff-format.enable = true; # python (packages/vault-sync)
+    shfmt.enable = true; # shell (modules/exedev/activate.sh)
+    prettier.enable = true; # yaml (.github/workflows), markdown, json
+  };
+
+  # Keep `case` bodies indented (shfmt's `-ci`); its default de-indents them.
+  # List-typed, so this concatenates with the shfmt module's own flags.
+  settings.formatter.shfmt.options = [ "-ci" ];
+
+  settings.global.excludes = [
+    # Generated / externally-managed lock files — never hand-format.
+    "flake.lock"
+    "packages/obsidian-headless/package-lock.json"
+    "packages/pi/npm-shrinkwrap.json"
+  ];
+}