Module prelude

Module prelude 

Source
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 types

Commonly 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§

CentralityCalculator
Main centrality calculator with heuristics integration
CodeSelector
Config
Main configuration structure for Scribe
FileInfo
Comprehensive file metadata structure
FileScanner
High-level scanner facade providing convenient access to all scanning functionality
HeuristicScorer
Main heuristic scorer that coordinates all scoring components
HeuristicSystem
Main entry point for the heuristic scoring system
HeuristicWeights
Configurable weights for different scoring components
PageRankAnalysis
Main entry point for PageRank centrality analysis
PatternMatcher
Combined pattern matcher that integrates glob and gitignore patterns
PatternMatcherBuilder
Builder for creating pattern matchers with a fluent API
QuickMatcher
Quick pattern matching utility for simple use cases
ScanOptions
Configuration options for scanning operations
Scanner
High-performance file system scanner with parallel processing
ScoreComponents
Individual components of the heuristic scoring system
SelectionEngine
Main entry point for intelligent code selection

Enums§

FileType
File type classification for analysis purposes
Language
Programming language classification
ScribeError
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