software-mansion__argent/.github/workflows/knip.yml

name: Dead Code

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  knip:
    name: Knip
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Set up Node.js
        uses: actions/setup-node@v6
        with:
          # Matches what lint, lockfile and repo-hygiene pin.
          node-version: "24"

      # Knip reads manifests and source only, so install scripts are pure cost
      # here — and skipping them keeps the job immune to a bump that ships no
      # prebuild for the runner, the case dependabot.yml holds tree-sitter back
      # from, where the compile breaks `npm ci` outright.
      - name: Install dependencies
        run: npm ci --ignore-scripts

      # Knip reads source directly (mapping each package's dist entry back to
      # src), so there is no build step here. That mapping resolves each
      # workspace's OWN entry, though - it does not form the edge from one
      # workspace to another, which needs a dist that this job never creates. So
      # a symbol another workspace calls can still be reported unused; that is
      # the case the annotation below and knip.jsonc's @public section are about,
      # and it is why a local run has to skip the build too. The two passes
      # partition the issue types between them (see knip.jsonc); both must come
      # back empty.
      - name: Knip
        id: knip
        run: npm run knip

      # The report names the file and symbol but not what to do about it, and
      # the answer differs per section. Give all three remedies, for class
      # members as well as exports and types: a finding whose only caller is out
      # of knip's reach reads exactly like a dead one. Say
      # which wrong delete goes unnoticed, too — deleting another workspace's
      # caller fails `tsc --build` and that workspace's tests, but argent-private
      # `require()`s a built `dist/*.js` no job here checks out.
      - name: Explain the failure
        if: failure() && steps.knip.outcome == 'failure'
        run: |
          echo "::error::Dead Code failed. There is no allowance to fall back on — the gate runs at --max-issues 0, so every section above is a real finding introduced by this change. For an unused export, type or class member, there are three remedies. Drop the export keyword if the symbol is still used inside its own file; a class member has none, so for that section it is the two below. Delete it if nothing uses it. Add a /** @public */ tag if the only caller is somewhere knip cannot see — another workspace, because CI analyses an unbuilt tree and cross-workspace edges do not form, or the argent-private submodule, which is in ignoreWorkspaces and is not checked out in this job. Unused exported class members is almost always that third case here. Look for that caller before you delete. This gate stays green either way, but the two cases differ after that: deleting a symbol another workspace calls turns the build and that workspace's unit tests red in the same check run, while deleting one only argent-private requires breaks nothing CI runs at all. For anything else, the section header names the class. Reproduce it locally with npm run knip against a tree with no build output, which is how CI runs it — knip.jsonc explains why that matters."