Expand description
Prelude module for convenient imports
This module re-exports the most commonly used types and functions to provide a convenient single import for typical usage.
§Example
use scribe_analyzer::prelude::*;
// Now you have access to:
// - Result, ScribeError
// - Config, FileInfo
// - analyze_repository function
// - Scanner, PatternMatcher
// - And other commonly used typesCommonly used imports for Scribe applications
Re-exports§
pub use crate::analyze_repository;pub use crate::RepositoryAnalysis;pub use crate::scan_repository;pub use crate::VERSION;
Modules§
- presets
- Pre-configured pattern matchers for common use cases
Structs§
- Centrality
Calculator - Main centrality calculator with heuristics integration
- Code
Selector - Config
- Main configuration structure for Scribe
- File
Info - Comprehensive file metadata structure
- File
Scanner - High-level scanner facade providing convenient access to all scanning functionality
- Heuristic
Scorer - Main heuristic scorer that coordinates all scoring components
- Heuristic
System - Main entry point for the heuristic scoring system
- Heuristic
Weights - Configurable weights for different scoring components
- Page
Rank Analysis - Main entry point for PageRank centrality analysis
- Pattern
Matcher - Combined pattern matcher that integrates glob and gitignore patterns
- Pattern
Matcher Builder - Builder for creating pattern matchers with a fluent API
- Quick
Matcher - Quick pattern matching utility for simple use cases
- Scan
Options - Configuration options for scanning operations
- Scanner
- High-performance file system scanner with parallel processing
- Score
Components - Individual components of the heuristic scoring system
- Selection
Engine - Main entry point for intelligent code selection
Enums§
- File
Type - File type classification for analysis purposes
- Language
- Programming language classification
- Scribe
Error - Comprehensive error type for all Scribe operations
Constants§
- CORE_
VERSION - Current version of the Scribe library
Type Aliases§
- Result
- Type alias for Results using ScribeError