Skip to main content

Crate agnix_core

Crate agnix_core 

Source
Expand description

§agnix-core

Core validation engine for agent configurations.

Validates:

  • Agent Skills (SKILL.md)
  • Agent definitions (.md files with frontmatter)
  • MCP tool configurations
  • Claude Code hooks
  • CLAUDE.md memory files
  • Plugin manifests

This crate requires std. The filesystem Cargo feature (enabled by default) adds file I/O dependencies; disabling it does not enable no_std.

§Stability Tiers

Public modules are classified into stability tiers:

  • Stableconfig, diagnostics, fixes, fs. These modules follow semver: breaking changes require a major version bump.
  • Unstableauthoring, eval, i18n, validation. Interfaces may change on minor releases. Use with care in downstream crates.
  • Internalparsers (pub(crate)). Not part of the public API. Some types are re-exported at the crate root with #[doc(hidden)] for fuzz/bench/test use only.

Re-exports§

pub use config::ConfigWarning;
pub use config::FilesConfig;
pub use config::LintConfig;
pub use config::generate_schema;
pub use diagnostics::ConfigError;
pub use diagnostics::CoreError;
pub use diagnostics::Diagnostic;
pub use diagnostics::DiagnosticLevel;
pub use diagnostics::FileError;
pub use diagnostics::Fix;
pub use diagnostics::FixConfidenceTier;
pub use diagnostics::LintError;
pub use diagnostics::LintResult;
pub use diagnostics::RuleMetadata;
pub use diagnostics::ValidationError;
pub use diagnostics::ValidationOutcome;
pub use file_types::FileType;
pub use file_types::detect_file_type;
pub use file_types::FileTypeDetector;
pub use file_types::FileTypeDetectorChain;
pub use fixes::FixApplyMode;
pub use fixes::FixApplyOptions;
pub use fixes::FixResult;
pub use fixes::apply_fixes;
pub use fixes::apply_fixes_with_fs;
pub use fixes::apply_fixes_with_fs_options;
pub use fixes::apply_fixes_with_options;
pub use fs::FileSystem;
pub use fs::MockFileSystem;
pub use fs::RealFileSystem;

Modules§

authoring
Skill authoring and scaffolding utilities.
config
Lint configuration types and schema generation.
diagnostics
Diagnostic, severity, fix, and error types.
eval
Rule efficacy evaluation (precision/recall/F1).
file_types
File type detection and extensible detector chain.
fixes
Auto-fix application engine.
fs
Filesystem abstraction (real and mock).
i18n
Internationalization helpers.
validation
Validation registry and file-type detection.

Structs§

ValidationResult
Result of validating a project, including diagnostics and metadata.
ValidatorMetadata
Metadata for a validator, providing introspection capabilities.
ValidatorRegistry
Registry that maps FileType values to cached validator instances.
ValidatorRegistryBuilder
Builder for constructing a ValidatorRegistry with fine-grained control.

Traits§

Validator
Trait for file validators.
ValidatorProvider
A provider of validator factories.

Functions§

normalize_line_endings
Normalize CRLF (\r\n) and lone CR (\r) line endings to LF (\n).
resolve_file_type
Resolve file type with config-based overrides.
validate_content
Validate in-memory content for a given path.
validate_file
Validate a single file.
validate_file_with_registry
Validate a single file with a custom validator registry.
validate_project
Main entry point for validating a project
validate_project_rules
Run only project-level validation checks without per-file validation.
validate_project_with_registry
Main entry point for validating a project with a custom validator registry

Type Aliases§

ValidatorFactory
Factory function type that creates validator instances.