hawkeye 7.0.0-alpha.1

A license header checker and formatter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

// Copyright 2026 FastLabs Developers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Check, format, and remove source-file license headers.
//!
//! Load a [`Config`], build an [`Engine`], and run the desired operation:
//!
//! ```no_run
//! use hawkeye::Config;
//! use hawkeye::Engine;
//! use hawkeye::Scope;
//!
//! # fn main() -> Result<(), hawkeye::Error> {
//! let config = Config::load("licenserc.toml")?;
//! let report = Engine::new(config)?.check(Scope::All)?;
//! println!("checked {} files", report.files.len());
//! # Ok(())
//! # }
//! ```
//!
//! The default `application` feature builds the `hawkeye` executable. Library-only users can
//! disable default features to omit its command-specific dependencies.

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(missing_docs)]

mod builtin;
mod config;
mod engine;
mod error;
mod report;
mod template;

pub use self::config::Config;
pub use self::config::FeatureMode;
pub use self::config::FilesConfig;
pub use self::config::GitConfig;
pub use self::config::HeaderConfig;
pub use self::config::RuleConfig;
pub use self::config::StyleConfig;
pub use self::engine::Edits;
pub use self::engine::Engine;
pub use self::engine::Scope;
pub use self::error::Error;
pub use self::error::ErrorKind;
pub use self::report::FileOutcome;
pub use self::report::FileReport;
pub use self::report::Report;