← All showcases
diagnostics + check + CIRefactor safety
diagnosticsrefactorclici

Links that break loudly

Rename a file. Editor diagnostic, rewritten refs, then `reqlan check` in CI. Not a wiki.

The editor flags it. `reqlan check` fails the merge.

before - auth.rq

login {
  oauth handshake for the web client
  implemented in ["./src/handlers/auth.ts".login]
  @status done
}

session {
  cookie session after [login]
  implemented in ["./src/middleware/session.ts"]
}

rename

git mv src/handlers/auth.ts src/handlers/oauth.ts

auth.rq

errorFile reference "./src/handlers/auth.ts" could not be resolved

  • Update path to ./src/handlers/oauth.ts
  • Search workspace for auth.ts
  • Create missing file

reqlan check

$ reqlan check
## Issues (1)

./src/handlers/auth.ts
- auth.rq:3 login [file_reference]

exit 1

ci

# .github/workflows/ci.yml
- name: Check requirement references
  run: npx @reqlan/cli check

after - refs rewritten

login {
  oauth handshake for the web client
  implemented in ["./src/handlers/oauth.ts".login]
  @status done
}

session {
  cookie session after [login]
  implemented in ["./src/middleware/session.ts"]
}

after - reqlan check

$ reqlan check
No issues.

exit 0