{
 "schema_version": 1,
 "generated": "2026-10-20",
 "id": "mizchi-jev-lint--catch-comments-that-lie-in-typescript",
 "repo": "mizchi/jev-lint",
 "repo_url": "https://github.com/mizchi/jev-lint",
 "repo_slug": "mizchi-jev-lint",
 "title": "Find doc comments that contradict their TypeScript code",
 "page_title": "How to find doc comments that contradict their TypeScript code with Jev Lint",
 "summary": "Flag functions whose comments promise behaviour the body does not deliver.",
 "who": "A TypeScript developer whose doc comments and return types have drifted from the implementation after refactors, and whom the compiler and ESLint do not warn about.",
 "problem": "Comments such as 'returns null when not found' stay in place while the body throws, and nothing in the toolchain reports the mismatch.",
 "outcome": "A list of findings with a probability score and cutoff for each suspect block, which you review and fix by hand.",
 "steps": [
  "`export TYPESAFE_API_KEY=...`",
  "`npx -y jev-lint check examples`",
  "`npx jev-lint check src --dry-run`",
  "`npx jev-lint check src`"
 ],
 "agent_prompt": "In the repository <repo-path>, set TYPESAFE_API_KEY, run `npx jev-lint check src --dry-run` to see the planned requests and price, then run `npx jev-lint check src`. Report each finding with file, line, rule id and score, and do not edit code until a human confirms the finding is real.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "30 minutes",
 "basis": "readme",
 "caveat": "Findings are candidates, not verdicts: the README reports about one in five was wrong on this repository, so each one needs a human check.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "typescript",
 "requirements": [
  "Node 24 or newer with npx",
  "A TYPESAFE_API_KEY from https://typesafe.ai, set in the environment (the code being judged is sent to the API)",
  "A repository with code to lint, such as a TypeScript src folder"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": true,
 "score": 1.0,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/mizchi-jev-lint/catch-comments-that-lie-in-typescript/",
 "md": "https://dedupedai.com/use-cases/mizchi-jev-lint/catch-comments-that-lie-in-typescript/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/mizchi-jev-lint--catch-comments-that-lie-in-typescript.json",
 "api_version": "v1"
}