Skip to content

tech-debt: prettier cleanup PR for ~625 pre-existing files + remove SKIP=prettier-check #23

@creatornader

Description

@creatornader

Context

During the 2026-05-17 wire-up session (PRs #19 textleaks/oss-twin/oss-security-scan, #20 textleaks rename, #21 atrib-log-pp-cli cross-ref, #22 openinference trailing-newlines), the pre-commit prettier-check hook surfaced ~625 files in this repo that aren't prettier-compliant.

None of those 625 files were touched by the wire-up PRs. They're pre-existing tech debt accumulated over months. To unblock the wire-up, prettier-check got added to the SKIP env-var list in .github/workflows/security-scan.yml's pre-commit job. The wire-up PRs shipped; the debt got parked.

This issue tracks the cleanup. One focused session, please. Don't bundle with feature work.

Plan (do in order)

Step 1: one-shot cleanup PR

cd ~/repos/atrib
git checkout -b chore/prettier-cleanup-backlog
pnpm exec prettier --write . 2>&1 | tee /tmp/prettier-cleanup.log
git diff --stat | tail -1

Before committing, eyeball the diff for surprises in:

  • spec/conformance/ (corpus files with specific structure)
  • packages/directory/wasm/ (WASM source)
  • packages/openinference/test/fixtures/cases/ (canonical span fixtures; PR chore: add trailing newlines to 2 openinference test fixtures #22 already shipped 2, the other 2 still pending)
  • packages/mcp/test/canonical-snapshot.test.ts (snapshot test)
  • packages/log-dev/scripts/ (generators may have intentional shape)

If any file got mangled, git checkout -- <path> and add it to .prettierignore instead.

Step 2: remove prettier-check from the CI SKIP list

After step 1 lands, edit .github/workflows/security-scan.yml and drop ,prettier-check from the SKIP env. The CI gate is back on. Future PRs that introduce non-compliant code fail check before fresh debt can land.

Step 3: flip the local hook to auto-fix

Edit .pre-commit-config.yaml: change entry: pnpm exec prettier --check to --write. The local pre-commit pass now formats on commit instead of just complaining. Contributors don't have to think about prettier compliance because the editor's format-on-save (or the hook itself) fixes it for them.

Effort

30 to 60 minutes including the eyeball review. Atomic.

Why this isn't urgent

Nothing blocks on it. The SKIP keeps PRs unblocked. The only reason to schedule it is to retire the SKIP hack and put the gate back on.

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions