Real‑time guardrails for your TypeScript & JavaScript docs
JSDoc Sentinel instantly flags outdated or inconsistent JSDoc comments whenever you save—no quick fixes, just clear, actionable warnings so your documentation never falls behind your code.
🎬 Live Preview
🚩 Why You’ll Love It
⚠️ Spot Drift Instantly: Yellow squiggles under mismatched @param, @returns, or @throws tags show exactly where your docs and code disagree.
🔎 Comprehensive Audits: Run JSDoc Sentinel: Audit Workspace to generate a Problems list of every doc drift in your project.
🔌 Zero Friction: No configuration, no performance overhead—install and go.
🔧 Built to Last: SOLID/KISS core (1,000 LOC), 100% Jest coverage, modular design for easy extension.
🚀 Key Benefits
Catch Bugs Sooner: Outdated docs lead to wrong assumptions—Sentinel flags divergences before they cause headaches.
Confident Refactoring: Large-scale changes? Audit your public API docs to ensure nothing slips through.
Faster Reviews: Reviewers can trust comments instead of digging through implementation.
Save Mental Bandwidth: Automate the grunt work and focus on what matters—your code.
🛠️ Installation
From the Marketplace
Open Extensions (⇧⌘X / Ctrl+Shift+X).
Search JSDoc Sentinel.
Click Install and reload.
From VSIX
git clone https://github.com/michaelbarley/jsdoc-sentinel.git
cd jsdoc-sentinel
npm ci && npm run build
vsce package
In VS Code, run Extensions: Install from VSIX… and select the .vsix.
🎯 Usage
Edit & Save a .ts, .tsx, .js, or .jsx file—watch Sentinel underline any doc drift.