Expand description
Check, format, and remove source-file license headers.
Load a Config, build an Engine, and run the desired operation:
use hawkeye::Config;
use hawkeye::Engine;
use hawkeye::Scope;
let config = Config::load("licenserc.toml")?;
let report = Engine::new(config)?.check(Scope::All)?;
println!("checked {} files", report.files.len());The default application feature builds the hawkeye executable. Library-only users can
disable default features to omit its command-specific dependencies.
Structs§
- Config
- Configuration for a HawkEye engine.
- Edits
- Pending file edits prepared by an
Engine. - Engine
- A license-header processor built from one
Config. - Error
- An error returned by a HawkEye operation.
- File
Report - The outcome for one selected file.
- Files
Config - File discovery settings.
- GitConfig
- Git integration settings.
- Header
Config - Header template and recognition settings.
- Report
- The outcomes of an
Engineoperation. - Rule
Config - File selectors and the comment styles used for matching and output.
Enums§
- Error
Kind - A category of HawkEye errors.
- Feature
Mode - Availability policy for a Git-backed feature.
- File
Outcome - The outcome of an operation for one selected file.
- Scope
- The files and directories processed by an
Engineoperation. - Style
Config - A custom comment style.