A typechecker for your comments.
A simple VS Code extension which checks that your code and comments are in sync. Think of it as a typechecker for your comments.
Code Couplet itself is a Node program which reads a stored description of code-comment relationships and verifies the codebase against these relationships.
These are stored in a .code-couplet folder in the root of your repository.
Commit this folder into version control.
Currently Code Couplet is a VS Code extension.
The VS Code extension for Code Couplet provides a quick way to link comments with code.
Hovering over a linked comment will show the code it is linked to, and vice versa.
It also shows diagnostic errors when the code and comments are out of sync.
These errors can include quick fixes to update the saved link automatically.
Schema is defined in Typescript and encoded/decoded using io-ts with JSON serialization.
See src/types.ts.
- Command line interface
- Git pre-commit hook
- Continuous integration job
Read more details at my blog post: https://pelmers.com/typechecked-comments/