glob
面向 MoonBit 的可复用通配符路径匹配与文件检索库，支持 Wasm、JS 与 Native 目标。
glob
pattern-matching
wildcard
filepath
path
moon add Lxxbv/glob@0.2.6
Download zipAuthor
Version
0.2.6
License
Apache-2.0
Repository
Last updated
2 days ago
Downloads
29
Dependencies
- moonbitlang/x0.4.46
README#Lxxbv/glob
Lxxbv/glob 是 MoonBit 的跨平台 Glob 路径匹配和文件检索库。
它提供：
- compile_pattern / CompiledPattern：编译一次，循环复用；
- glob_with_options：文件系统搜索、隐藏项、深度和排序控制；
- GlobQuery / GlobPipeline：组合 include/exclude、限制和报告；
- GlobRules：类似 .gitignore 的规则解析；
- PathIndex：内存路径索引；
- explain_pattern、PatternCache 和确定性 benchmark workload。
基础用法：
let pattern = @glob.compile_pattern("src/**/*.mbt")?
let paths = ["src/main.mbt", "src/core/parser.mbt", "README.md"]
let matched = @glob.filter_compiled_patterns([pattern], paths)文件系统用法：
let options = @glob.GlobOptions::default().files_only().sorted()
let files = @glob.glob_with_options(".", "**/*.mbt", options)?CLI 用法：
moon run cmd/main "**/*.mbt"
moon run cmd/main "src/**/*.mbt" "src"完整语义、错误处理、Windows 安装、基准数据、许可证和 CI 验收命令请阅读 README.md。
#AST
Represents the Abstract Syntax Tree (AST) of a Glob pattern.
#CacheError
impl Show for CacheError
#CacheStats
#CachedPattern
pub(all) struct CachedPattern {
source : String
compiled : CompiledPattern
hits : Int
} derive(Eq, Debug)#CharClassElement
Represents a component inside a character class [...].
#CompiledPattern
pub(all) struct CompiledPattern {
source : String
ast : AST
stats : PatternStats
prefix : String
separators : Int
recursive : Bool
segments : Int
} derive(Eq, Debug)A reusable compiled glob pattern with stable structural metadata.
#CompiledPattern::ast
Returns the compiled syntax tree for advanced callers.
#CompiledPattern::estimated_branches
Estimates the number of matching branches exposed by the syntax tree.
#CompiledPattern::has_magic
Returns true when this handle has at least one wildcard construct.
#CompiledPattern::has_recursive_wildcard
Returns whether the pattern contains the recursive \**\\ construct.
#CompiledPattern::is_literal
Returns true when this handle is a literal-only pattern.
#CompiledPattern::literal_prefix
Returns the literal prefix before the first wildcard.
#CompiledPattern::matches
Matches one path without reparsing the source pattern.
#CompiledPattern::pattern
Returns the original source pattern.
#CompiledPattern::segment_count
Returns the number of non-empty source path components.
#CompiledPattern::separator_count
Returns the number of path separators in the source pattern.
#CompiledPattern::stats
Returns structural pattern statistics captured at compile time.
#CompiledPattern::summary
Returns a compact, deterministic metadata summary useful in logs.
#GlobError
#GlobOptions
Controls which filesystem entries are returned by glob_with_options.
#GlobOptions::default
Creates options compatible with the original glob behavior.
#GlobOptions::directories_only
Returns options that include directories but not files.
#GlobOptions::files_only
Returns options that include files but not directories.
#GlobOptions::sorted
Returns options with deterministic lexicographic output ordering.
#GlobOptions::with_max_depth
Limits traversal to entries at or below the given relative depth.
Returns options that skip hidden path components.
#GlobPipeline
pub(all) struct GlobPipeline {
cache : PatternCache
includes : Array[String]
excludes : Array[String]
options : GlobOptions
limit : Int?
} derive(Eq, Debug)#GlobPipeline::exclude_pattern
#GlobPipeline::include_pattern
#GlobPipeline::new
Creates a pipeline with a bounded compiled-pattern cache.
#GlobPipeline::run
fn GlobPipeline::run(self : GlobPipeline, paths : Array[String]) -> Result[PipelineReport, GlobError]Runs a pipeline and returns only the report for one-shot callers.
#GlobPipeline::run_with_cache
fn GlobPipeline::run_with_cache(self : GlobPipeline, paths : Array[String]) -> Result[(GlobPipeline, PipelineReport), GlobError]Runs include/exclude matching once over a candidate path array.
#GlobPipeline::with_limit
fn GlobPipeline::with_limit(self : GlobPipeline, limit : Int) -> Result[GlobPipeline, PipelineError]#GlobPipeline::with_options
#GlobQuery
pub(all) struct GlobQuery {
includes : Array[CompiledPattern]
excludes : Array[CompiledPattern]
options : GlobOptions
min_depth : Int
limit : Int?
} derive(Eq, Debug)A reusable query with include rules, exclude rules, and result policies.
#GlobQuery::directories_only
Restricts results to directories when querying a filesystem.
#GlobQuery::exclude_count
Returns the number of exclude rules.
#GlobQuery::exclude_pattern
Adds an exclude pattern. Exclusions always take precedence.
#GlobQuery::execute_filesystem
Executes the query against all traversable entries under a directory.
#GlobQuery::execute_index
Executes a query against an in-memory index without discarding entry kinds.
This is useful for build tools that refresh a path index once and issue many
queries without repeatedly touching the filesystem.
#GlobQuery::execute_paths
Executes this query against a caller-provided path list.
#GlobQuery::files_only
Restricts results to files when querying a filesystem.
#GlobQuery::include_count
Returns the number of include rules.
#GlobQuery::include_pattern
Adds an include pattern. Multiple includes use OR semantics.
#GlobQuery::matches
Tests a normalized or platform-specific path against this query.
#GlobQuery::sorted
Enables deterministic result ordering.
#GlobQuery::summary
Returns a concise configuration summary for logs and diagnostics.
#GlobQuery::with_limit
Limits the number of returned paths.
#GlobQuery::with_min_depth
Requires paths to have at least the given number of components.
#GlobQuery::with_options
Replaces traversal and result options.
#GlobRule
pub(all) struct GlobRule {
source : String
pattern : CompiledPattern
action : RuleAction
anchored : Bool
directory_only : Bool
has_separator : Bool
} derive(Eq, Debug)One parsed rule with the original source retained for diagnostics.
#GlobRules
An ordered rule set using last-match-wins evaluation.
#GlobRules::allows
Returns whether a path should remain visible after rule evaluation.
#GlobRules::append
Appends another rule set while preserving evaluation order.
#GlobRules::decision
Evaluates a path with last-match-wins semantics.
#GlobRules::exclude_count
Returns the count of exclude rules in this set.
#GlobRules::explain
Describes the last rule that affects a path.
#GlobRules::filter
Filters a path list, treating every entry as a file.
#GlobRules::filter_with_kinds
Filters paths when the caller knows which entries are directories.
#GlobRules::from_lines
Parses lines using common .gitignore-style comments and blank lines.
#GlobRules::from_text
Parses a newline-separated rule document.
#GlobRules::include_count
Returns the count of include rules in this set.
#GlobWorkload
A named collection of patterns and deterministic candidate paths.
#GlobWorkload::name
Returns the workload name.
#GlobWorkload::with_path
Adds a path if it is not already present.
#GlobWorkload::with_pattern
Adds a pattern while preserving input order.
#IndexStats
Summary statistics for an in-memory path index.
#MatchReport
Separates matched and unmatched paths without recompiling the AST.
#PathIndex
An ordered, duplicate-free collection of normalized path records.
#PathIndex::add_directory
Inserts or replaces a directory record.
#PathIndex::add_file
Inserts or replaces a file record.
#PathIndex::add_many
Inserts a batch of records in input order.
#PathIndex::apply_rules
Applies include/exclude rules to the indexed paths.
#PathIndex::children
Returns direct children of a directory, excluding deeper descendants.
#PathIndex::clear
Removes all records while advancing the generation.
#PathIndex::count_extension
Counts records with one extension, without treating directories specially.
#PathIndex::from_entries
Builds an index while removing duplicate normalized paths.
#PathIndex::generation
Returns the current mutation generation, useful for cache invalidation.
#PathIndex::get
Returns the record for a normalized path, if indexed.
#PathIndex::query
Compiles and applies one pattern to the index.
#PathIndex::query_with_rules
Returns records matching a pattern and optional rule set.
#PathIndex::records
Returns records in insertion order.
#PathIndex::remove
Removes one path and returns the resulting index.
#PathIndex::search_compiled
Matches all indexed records with one compiled pattern.
#PathIndex::stats
Computes stable aggregate statistics.
#PathIndex::under
Returns records at or below a normalized directory prefix.
#PathKind
The kind of filesystem entry represented by a path record.
#PathRecord
A normalized path plus metadata used by filtering and reporting tools.
#PathRecord::directory
Creates a directory record.
#PathRecord::matches
Returns true when the record path matches a compiled glob.
#PathRecord::new
Creates a record with an explicit kind.
#PatternCache
pub(all) struct PatternCache {
entries : Array[CachedPattern]
capacity : Int
hits : Int
misses : Int
evictions : Int
} derive(Eq, Debug)#PatternCache::clear
Clears cached entries and counters while retaining the configured bound.
#PatternCache::compile_all
fn PatternCache::compile_all(self : PatternCache, sources : Array[String]) -> Result[(PatternCache, Array[CompiledPattern]), GlobError]Compiles a batch and preserves the first parser error.
#PatternCache::contains
#PatternCache::filter
fn PatternCache::filter(self : PatternCache, source : String, paths : Array[String]) -> Result[(PatternCache, Array[String]), GlobError]Filters paths with a cached pattern.
#PatternCache::get_or_compile
fn PatternCache::get_or_compile(self : PatternCache, source : String) -> Result[(PatternCache, CompiledPattern), GlobError]Returns a compiled pattern and an updated cache.
#PatternCache::match_all
fn PatternCache::match_all(self : PatternCache, sources : Array[String], path : String) -> Result[(PatternCache, Bool), GlobError]Tests whether every pattern matches one path.
#PatternCache::match_any
fn PatternCache::match_any(self : PatternCache, sources : Array[String], paths : Array[String]) -> Result[(PatternCache, Bool), GlobError]Tests whether at least one cached/compiled pattern matches any path.
#PatternCache::sources
Returns all cached source names in oldest-to-newest order.
#PatternExplanation
pub(all) struct PatternExplanation {
source : String
normalized : String
tokens : Array[String]
ast_text : String
stats : PatternStats
risk : PatternRisk
literal_prefix : String
separator_count : Int
} derive(Eq, Debug)A complete, stable explanation of one validated pattern.
#PatternExplanation::branch_count
#PatternExplanation::complexity_score
#PatternExplanation::has_recursive_wildcard
#PatternExplanation::is_literal
#PatternExplanation::recommendation
Recommends a caller-visible execution strategy.
#PatternExplanation::risk_name
Returns a compact machine-readable category name.
#PatternExplanation::signature
Produces a stable identifier suitable for benchmark grouping.
#PatternExplanation::summary
Renders a short one-line diagnostic for logs and CLI output.
#PatternExplanation::token_count
#PatternRisk
A coarse risk category used to choose traversal and caching strategies.
#PatternStats
Counts the syntax features in a compiled glob pattern.
#PatternStats::has_magic
Returns true when the pattern has at least one wildcard construct.
#PatternStats::is_literal
Returns true when the pattern contains no wildcard constructs.
#PatternStats::magic_count
Returns the number of syntax constructs that require matching logic.
#PipelineError
impl Show for PipelineError#PipelineReport
#QueryReport
A report returned by a path query.
#QueryReport::has_results
Returns whether the query produced at least one result.
#QueryReport::is_complete
Returns whether the result set contains every accepted path.
#QueryReport::page
Returns a bounded page of results without changing the original report.
Invalid offsets and page sizes produce an empty page.
#QueryReport::returned_count
Returns the number of results in the current pageable report.
#QueryReport::summary
Returns a compact summary suitable for build logs and diagnostics.
#RuleAction
The action encoded by one ignore-file rule.
#RuleDecision
The result of evaluating all rules for one path.
#Token
Represents a token produced by the Glob lexer.
#TraversalPlan
pub(all) struct TraversalPlan {
pattern : CompiledPattern
root_prefix : String
recursive : Bool
literal : Bool
} derive(Eq, Debug)#TraversalPlan::can_descend
Returns whether a relative directory can contain a matching path.
#TraversalPlan::estimated_skipped_levels
Returns a simple estimate of how many directory levels can be skipped.
#TraversalPlan::from_compiled
#TraversalPlan::from_pattern
Builds a plan and compiles the pattern exactly once.
#TraversalPlan::prefix_depth
Returns the number of static path components used for pruning.
#TraversalPlan::start_prefix
Chooses a safe starting prefix when it exists on the filesystem.
#WorkloadError
impl Show for WorkloadError#WorkloadResult
Aggregate results from evaluating every pattern against every candidate.
#WorkloadResult::coverage_percent
#WorkloadResult::has_invalid_patterns
#analyze
Compiles and analyzes a pattern without performing any path matching.
#build_default_workload
A compact workload suitable for every CI run.
#build_large_workload
A larger workload for local performance checks and release notes.
#build_query
Creates a query from include and exclude source patterns.
#build_workload
Builds a reproducible repository-shaped workload.
#classify_paths
Classifies a path list with one compiled pattern.
#compile
Compiles a glob pattern string into an AST.
#compile_many
Compiles patterns in input order and stops at the first invalid pattern.
#compile_pattern
Compiles one pattern and records metadata without changing matching rules.
#compile_patterns
Compiles a batch while preserving the caller's pattern order.
#dirname
fn dirname(path : String) -> StringReturns the parent path, or . when the path has no parent.
#evaluate_workload
Evaluates a workload with one compilation per pattern and no timing noise.
#explain_pattern
Parses a pattern and returns all information needed for diagnostics.
#extension
fn extension(path : String) -> String?Returns the final extension without the leading dot.
#filter
Filters an array of paths, returning only those that match the glob pattern.
#filter_compiled
Filters paths with a previously compiled pattern.
#filter_compiled_patterns
fn filter_compiled_patterns(patterns : Array[CompiledPattern], paths : Array[String]) -> Array[String]Filters a path list using compiled patterns and removes duplicate results.
#filter_not
Filters an array of paths, returning only those that do NOT match the glob pattern.
#filter_not_compiled
Filters out paths with a previously compiled pattern.
#filter_not_compiled_patterns
fn filter_not_compiled_patterns(patterns : Array[CompiledPattern], paths : Array[String]) -> Array[String]Returns the paths that match none of the compiled patterns.
#glob
Searches the filesystem starting from dir for paths matching the glob pattern.
The returned paths are relative to dir.
#glob_with_options
fn glob_with_options(dir : String, pattern : String, options : GlobOptions) -> Result[Array[String], GlobError]Searches the filesystem using explicit filtering and traversal options.
#has_recursive_wildcard
Returns whether a pattern contains a recursive ** wildcard.
fn is_hidden_path(path : String) -> BoolReturns true when any path component starts with a dot.
#is_path_pattern
Returns whether a valid pattern contains a path separator.
#literal_prefix
Returns the static prefix before the first wildcard construct.
#match_all
Returns true only when every pattern matches the path.
#match_any
Returns true when at least one pattern matches the path.
#match_compiled_all
Matches one path against every previously compiled pattern.
#match_compiled_any
Matches one path against any previously compiled pattern.
#match_path
Matches a path string against a parsed Glob AST.
#match_pattern
Matches a path string against a glob pattern string.
#normalize_path
fn normalize_path(path : String) -> StringConverts Windows separators to /, removes duplicate separators, and
removes a leading ./ from a relative path.
#parse
Converts a flat array of Tokens into a hierarchical AST.
#path_depth
fn path_depth(path : String) -> IntReturns the number of non-empty path components.
#query_paths
fn query_paths(includes : Array[String], excludes : Array[String], paths : Array[String]) -> Result[QueryReport, GlobError]Executes a one-shot include/exclude query over a path list.
#separator_count
Returns the number of / separators in a valid pattern.
#static_segments
Returns the literal path components known before the first wildcard.
面向 MoonBit 的可复用通配符路径匹配与文件检索库，支持 Wasm、JS 与 Native 目标。
globpattern-matchingwildcardfilepathpath
0.2.6
Apache-2.0
Updated 2 days ago
29 downloadsDependencies
- moonbitlang/x0.4.46