Description
This PR integrates the typos tool into nuclei to automatically detect and prevent typos in the codebase.
Changes
Added
.typos.toml - Configuration file for typos checker
- Excludes template files and integration tests
- Adds nuclei-specific terms to ignore list (pd, httpx, nuclei, interactsh, etc.)
- Configures common false positives
Proposed (to be added by maintainers)
.github/workflows/typos.yaml - GitHub Actions workflow
- Runs on push and PR to main/dev branches
- Uses official crate-ci/typos action
- Fast execution (~1-2 minutes)
Why typos?
- Fast: Written in Rust, checks entire codebase in seconds
- Accurate: Low false positive rate with proper configuration
- Community standard: Used by many major Rust/Go projects
- Prevents regressions: Catches typos before they enter the codebase
References
Checklist
- Configuration file added
- Workflow file (can be added by maintainers due to token permissions)
- Tested locally
- Documentation updated
/claim #6532 for Algora bounty
Summary by CodeRabbit
- Chores
- Added spell-checking configuration to exclude build artifacts, dependencies, and generated files from validation checks, reducing false positives in the codebase.