Resync is a multi language comment checker written in rust. It's a CLI tool which uses the git history of your repo to detect out of sync comments.
Resync looks at things such as the commit dates, and commit consistency to tell if a comment is stale or not.
Note: resync may not be 100% accurate at identifying out of sync comments, it tries to only show you places where the function has been updated a lot, but the comment hasn't.
To use resync, simply run resync in the root of any source code directory. This will check all files in the directory for out of sync comments.
You can check a single file by running resync -i relative/file/location from the root of a project
- Rust
- Javscript
- JavaScript React
- Typescript
- Typescript React
- C
- C++
- C#
- Python
- PHP
- Kotlin
- Java
Resync is automatically downloaded and used with Readable. It lets you find and regenerate out of sync comments from within your IDE.
Head over to the releases page to download resync. If there aren't compiled binaries for your system, then you can compile resync in the following way.
git clone git@github.com:ReadableLabs/resync
cd resync
cargo install --path .
If you want to support a new language, view the docs on how to do so.
- Resync outputs "Searching for out of sync comments..." but nothing else
- Resync didn't find any out of sync comments in your project.
- Python support
- Use cursive to make a terminal GUI for resync
- use optional dependencies if you only want to compile for a few languages
- Allow resync to be used on the master branch, without creating resync branch (maybe)
- add tests to mock extension
- add flag which prints all symbol ranges of file to better be used with Readable (probably won't do)