| Crates.io | assumls |
| lib.rs | assumls |
| version | 0.0.3 |
| created_at | 2026-01-01 04:54:46.732342+00 |
| updated_at | 2026-01-06 03:20:13.191514+00 |
| description | Language server and CLI checker for enforcing documented assumptions across a codebase |
| homepage | |
| repository | https://github.com/SichangHe/assumls |
| max_upload_size | |
| id | 2015759 |
| size | 155,095 |
Language server + CLI checker for enforcing documented assumptions across a codebase.
Define assumptions in ASSUM.md:
# network_available
Services assume stable network connectivity (this text displays on hover).
Reference in any code under the same directory:
// @ASSUME:network_available
async fn fetch_data() { ... }
Check for violations:
assumls check .
# assumption_name in any ASSUM.md@ASSUME:assumption_name in any language (in comments)ASSUM.mdfd and rg on PATHlocal function register_assumls()
vim.lsp.config("assumls", {
cmd = { "assumls", "lsp" },
})
vim.lsp.enable("assumls", true)
end
assumls check <path> # Exit 0 if clean, 1 if errors
assumls lsp # Start LSP server
cargo install assumls
# Or, if you have cargo-binstall:
cargo binstall assumls
Or, grab one from Releases.
[!NOTE]
This project is currently largely generated by coding agents and the author has yet to manually inspect all code.
pre-commit and run pre-commit installSee src/ (this project itself) and test directories under test_data/.
MIT or Apache-2.0, per Cargo.toml.