linecheck 1.1.0

A fast, configurable tool that warns or errors when files exceed a set line count
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

//! Core file-checking logic: resolves limits and returns a [`FileResult`].
mod build;
mod options;
mod resolve;
use crate::config::Config;
use crate::lines::{content_info, file_info};
use crate::result::FileResult;
use anyhow::Result;
use build::build_result;
pub use options::CheckOptions;
use std::path::Path;

/// Check a single file; pass `None` for `config` to fall back to the thresholds in `opts`.
pub fn check_file(path: &Path, config: Option<&Config>, opts: &CheckOptions) -> Result<FileResult> {
    let (lines, ignored) = file_info(path)?;
    Ok(build_result(path, lines, ignored, config, opts))
}

/// Check in-memory content against the rule matching `path`, with no filesystem access.
///
/// `path` is used only for glob-pattern matching — it does not need to exist on disk.
/// This is the entry point for hosts that supply content directly rather than a
/// readable file, such as the WASM bindings (and any future non-Rust bindings).
#[must_use]
pub fn check_content(
    path: &Path,
    content: &[u8],
    config: Option<&Config>,
    opts: &CheckOptions,
) -> FileResult {
    let (lines, ignored) = content_info(content);
    build_result(path, lines, ignored, config, opts)
}

#[cfg(test)]
#[path = "../checker_tests.rs"]
mod tests;