nginx-lint-common 0.11.0

Common types and parser for nginx-lint
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

//! Core types shared between the nginx-lint CLI and WASM plugins.
//!
//! This crate provides the foundational types used throughout the nginx-lint
//! ecosystem: lint rule definitions, error reporting, configuration management,
//! and ignore comment support.
//!
//! # Modules
//!
//! - [`linter`] — Core lint types: [`LintRule`] trait, [`LintError`], [`Severity`], [`Fix`]
//! - [`config`] — Configuration loaded from `.nginx-lint.toml` ([`LintConfig`], [`ValidationError`])
//! - [`ignore`] — `# nginx-lint-ignore` comment parsing and error filtering
//! - [`docs`] — Rule documentation extraction ([`RuleDoc`])
//!
//! # Quick reference
//!
//! | Type | Purpose |
//! |------|---------|
//! | [`LintRule`] | Trait that every lint rule (native or WASM) implements |
//! | [`LintError`] | A single lint diagnostic with location, severity, and optional fixes |
//! | [`Severity`] | `Error` or `Warning` |
//! | [`Fix`] | An auto-fix action (replace, delete, insert) |
//! | [`LintConfig`] | Settings loaded from `.nginx-lint.toml` |
//! | [`Linter`] | Container that holds rules and runs them against a parsed config |
//!
//! # Re-exports
//!
//! The [`parser`] module re-exports the entire [`nginx_lint_parser`] crate,
//! giving access to [`parse_config`], [`parse_string`], and the AST types.

pub mod config;
pub mod docs;
pub mod ignore;
pub mod linter;

// Re-export parser crate
pub use nginx_lint_parser as parser;

// Re-export commonly used types
pub use config::{
    Color, ColorConfig, ColorMode, IncludeConfig, LintConfig, PathMapping, ValidationError,
};
pub use docs::{RuleDoc, RuleDocOwned};
pub use ignore::{
    FilterResult, IgnoreTracker, IgnoreWarning, filter_errors, parse_context_comment,
};
pub use linter::{
    Fix, LintError, LintRule, Linter, RULE_CATEGORIES, Severity, apply_fixes_to_content,
    compute_line_starts, normalize_line_fix,
};
pub use nginx_lint_parser::{parse_config, parse_string, parse_string_with_errors};