# Verid
[](https://crates.io/crates/verid)
[](https://crates.io/crates/verid)
[](LICENSE)
[](https://www.rust-lang.org)
**Verid** is a lightweight, modular CLI for code formatting and auditing
--- designed to unify multiple developer workflows into a single, fast,
and extensible tool.
Built with a focus on clarity, performance, and composability, Verid
aims to help developers maintain clean and consistent codebases without
heavy overhead.
------------------------------------------------------------------------
## ✨ Features
- **Formatting Engine**
- Indentation normalization
- Line width wrapping
- Stable, idempotent formatting
- **Audit Engine**
- Static scanning
- Code quality checks
- Actionable reporting
- **Rule Runner**
- Composable formatting rules
- Deterministic execution
- Stable repeated runs
- **CLI First**
- Simple commands
- Script-friendly
- Lightweight execution
------------------------------------------------------------------------
## 📦 Installation
Install from github:
```bash
git install https://github.com/haqqimuazzam1-hue/verid
```
Install from crates.io:
```bash
cargo install verid
```
------------------------------------------------------------------------
## 🚀 Usage
### Format code
``` bash
verid format <path>
```
### Audit code
``` bash
verid audit <path>
```
### Example
``` bash
verid format src/
verid audit src/
```
------------------------------------------------------------------------
## 🧠 Philosophy
Verid is designed with a few core principles:
- **Minimalism** --- do one thing well
- **Determinism** --- same input, same output
- **Composability** --- rules can evolve and expand
- **Performance** --- optimized for speed and low overhead
------------------------------------------------------------------------
## 🛠 Project Structure
src/
├── formatting/
│ ├── indent.rs
│ ├── width.rs
│ ├── runner.rs
│ └── mod.rs
│
├── audit/
│ ├── scanner.rs
│ ├── detector.rs
│ ├── reporter.rs
│ └── mod.rs
│
├── cli.rs
└── main.rs
------------------------------------------------------------------------
## 🧪 Development
Run checks:
``` bash
cargo check
cargo clippy -- -D warnings
cargo test
```
Format code:
``` bash
cargo fmt
```
------------------------------------------------------------------------
## 🗺 Roadmap
- Configuration file support
- Ignore patterns
- Plugin system
- Custom rule definitions
- Performance improvements
------------------------------------------------------------------------
## 🤝 Contributing
Contributions are welcome.
1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Open a pull request
------------------------------------------------------------------------
## 🔐 Security
If you discover a vulnerability or security issue, please report it
responsibly via issues or private communication with the maintainer.
------------------------------------------------------------------------
## 📄 License
This project is licensed under the MIT License.
------------------------------------------------------------------------
## ❤️ Acknowledgements
Inspired by modern developer tooling philosophy and the Rust ecosystem.