Stdlib module path/globbing.vitl

This page is a wiki-style reference for one concrete stdlib file. It explains what the file owns, where it fits in the family, and how to decide whether this is the right surface to depend on.

Visual portrait of path/globbing.vitl
Wiki-style portrait for path/globbing.vitl.

Family: path

Kind: public stdlib surface

Page style: this reference follows the same “encyclopedic card + portrait + usage contract” logic as the keyword pages, but for stdlib modules.

Summary

Overview

FieldValue
Pathpath/globbing.vitl
Familypath
Kindpublic stdlib surface
Line count84
Declared procedures11
Declared forms/picks3

`path/globbing.vitl` is a public stdlib surface inside the `path` family. It should be read as one focused slice of the broader family responsibility: Path manipulation, special locations, walkers, and globbing.

Purpose

This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the path family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.

  • A project root can be normalized before any file is read.
  • A walker can enumerate source files while parsing and diagnostics remain elsewhere.

Taxonomy

Think of this page as a generated encyclopedia entry rather than a hand-written tutorial. The goal is to show what kind of module this is, how dense it is, and what reading strategy makes sense before depending on it.

  • Medium procedure surface: this file groups several related operations behind one namespace.
  • Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
  • Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.
  • Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.

Implementation profile

This profile is inferred directly from the source text. It does not replace reading the file, but it tells you quickly whether the module is mostly declarative, loop-heavy, branch-heavy, or organized around many small exits.

SignalCountWhat it suggests
if0Branching density and local decision-making.
while0Loop-heavy or iterative implementation style.
for0Collection-style traversal at source level.
match0Variant-driven branching or grammar-style decoding.
let1Local state and intermediate value density.
give11Number of explicit exit points and result shaping.

Top-level API inventory

SurfaceItems
Procedurespath_glob, path_glob_recursive, path_matches, path_is_absolute, globbing_version, globbing_ready, globbing_manifest, globbing_health, globbing_summary, path_glob_report, globbing_selftest
FormsPathGlobbingManifest, PathGlobbingHealth, PathGlobbingSummary
Picksnone declared at top level
Constantsnone declared at top level
Exports*

Imported surfaces

This file does not advertise a top-level `use` surface in its opening declarations. That often means it is either self-contained or an aggregation layer.

Position in family

This file is module 2 of 5 in the path family when ordered by path. By procedure count it ranks 4, and by line count it ranks 5. Those ranks are useful as rough signals of breadth, not as quality judgments.

Declaration map

The declaration map turns raw source into a scan-friendly catalog. It is useful when the file is large enough that a reader wants to orient by kinds of surfaces first.

LineNameKindRole
1vitte/path/globbingspaceDeclares the namespace that anchors this file in the stdlib tree.
8PathGlobbingManifestformIntroduces a structured data shape that other procedures can exchange.
14PathGlobbingHealthformIntroduces a structured data shape that other procedures can exchange.
20PathGlobbingSummaryformIntroduces a structured data shape that other procedures can exchange.
25path_globprocOwns path semantics, traversal, or normalization.
29path_glob_recursiveprocOwns path semantics, traversal, or normalization.
33path_matchesprocOwns path semantics, traversal, or normalization.
37path_is_absoluteprocOwns path semantics, traversal, or normalization.
41globbing_versionprocOwns path semantics, traversal, or normalization.
45globbing_readyprocOwns path semantics, traversal, or normalization.
49globbing_manifestprocOwns path semantics, traversal, or normalization.
57globbing_healthprocOwns path semantics, traversal, or normalization.
65globbing_summaryprocOwns path semantics, traversal, or normalization.
72path_glob_reportprocOwns path semantics, traversal, or normalization.
76globbing_selftestprocOwns path semantics, traversal, or normalization.

The table is exhaustive for top-level declarations of the selected kinds. This file declares 15 matching surfaces.

Representative signatures

These signatures are shown in source order so the page keeps the feel of a reference manual, not just a keyword cloud.

  • form PathGlobbingManifest { (line 8)
  • form PathGlobbingHealth { (line 14)
  • form PathGlobbingSummary { (line 20)
  • proc path_glob(pattern: string) -> [string] { (line 25)
  • proc path_glob_recursive(pattern: string) -> [string] { (line 29)
  • proc path_matches(p: string, pattern: string) -> int { (line 33)
  • proc path_is_absolute(p: string) -> int { (line 37)
  • proc globbing_version() -> string { (line 41)
  • proc globbing_ready() -> bool { (line 45)
  • proc globbing_manifest() -> PathGlobbingManifest { (line 49)
  • proc globbing_health() -> PathGlobbingHealth { (line 57)
  • proc globbing_summary() -> PathGlobbingSummary { (line 65)
  • proc path_glob_report(pattern: string) -> [string] { (line 72)
  • proc globbing_selftest() -> bool { (line 76)

How to use this module

Start by reading the file as an ownership boundary. Ask three questions: what enters this module, what stable types or procedures it exports, and what adjacent module should stay outside of it.

  1. Read space and top-level imports first so the ownership boundary of path/globbing.vitl is explicit.
  2. Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
  3. Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
  4. Use the source landmarks section below as a table of contents when the file is large.
  5. Only after that compare neighbor modules, because the right boundary choice matters more than memorizing one helper name.

User example

This example is generated from the actual stdlib module surface. Its job is not to be the smallest snippet possible; its job is to show a realistic consumer-shaped file that exercises the module and mirrors the language keywords the module itself relies on.

space demo/path_globbing
form PathRun {
  pattern: string,
  ready: bool
}
proc run_example() -> PathRun {
  let entries = path_glob_report("src/**/*.vitl")
  let ready: bool = globbing_ready()
  let stable: bool = ready and entries.len >= 0
  give PathRun { pattern: "src/**/*.vitl", ready: true }
}
export run_example

Keyword coverage

This table makes the “all keywords of the module” requirement auditable. It compares the detected Vitte keywords in the source file with the generated consumer example above.

KeywordPresent in module sourceUsed in generated user example
spaceyesyes
formyesyes
procyesyes
letyesyes
giveyesyes
exportyesyes
trueyesyes
andyesyes

The generated snippet exercises every detected Vitte keyword used by this module.

Source shape

space vitte/path/globbing
// Globbing patterns
form PathGlobbingManifest {
  name: string,
  version: string,
  ready: bool
}
form PathGlobbingHealth {
  ready: bool,
  matcher_ready: bool,

The excerpt is not meant to replace the file. It exists to make the module recognizable at first glance, the same way a Wikipedia infobox helps the reader orient before reading the whole article.

Source landmarks

Large files are easier to retain when they have visible landmarks. When the source contains explicit section banners, they are surfaced here; otherwise the first major declarations are used as anchors.

  • Path Globbing Module

Source organization

When a file carries its own internal chaptering, those chapters usually reveal the intended reading order better than a flat symbol list. This section reconstructs that organization from the source itself.

Opening declarations

Top-level items: 1. Procedures: 0. Data surfaces: 0. Constants: 0.

First visible names: vitte/path/globbing

Path Globbing Module

Top-level items: 15. Procedures: 11. Data surfaces: 3. Constants: 0.

First visible names: PathGlobbingManifest, PathGlobbingHealth, PathGlobbingSummary, path_glob, path_glob_recursive, path_matches, path_is_absolute, globbing_version, globbing_ready, globbing_manifest

Complete API catalog

This catalog is the exhaustive file-level index for the module. It is intentionally closer to a generated encyclopedia appendix than to a tutorial summary.

Data surfaces

LineNameSignatureRole
8PathGlobbingManifestform PathGlobbingManifest {Introduces a structured data shape that other procedures can exchange.
14PathGlobbingHealthform PathGlobbingHealth {Introduces a structured data shape that other procedures can exchange.
20PathGlobbingSummaryform PathGlobbingSummary {Introduces a structured data shape that other procedures can exchange.

Procedures

LineNameSignatureRole
25path_globproc path_glob(pattern: string) -> [string] {Owns path semantics, traversal, or normalization.
29path_glob_recursiveproc path_glob_recursive(pattern: string) -> [string] {Owns path semantics, traversal, or normalization.
33path_matchesproc path_matches(p: string, pattern: string) -> int {Owns path semantics, traversal, or normalization.
37path_is_absoluteproc path_is_absolute(p: string) -> int {Owns path semantics, traversal, or normalization.
41globbing_versionproc globbing_version() -> string {Owns path semantics, traversal, or normalization.
45globbing_readyproc globbing_ready() -> bool {Owns path semantics, traversal, or normalization.
49globbing_manifestproc globbing_manifest() -> PathGlobbingManifest {Owns path semantics, traversal, or normalization.
57globbing_healthproc globbing_health() -> PathGlobbingHealth {Owns path semantics, traversal, or normalization.
65globbing_summaryproc globbing_summary() -> PathGlobbingSummary {Owns path semantics, traversal, or normalization.
72path_glob_reportproc path_glob_report(pattern: string) -> [string] {Owns path semantics, traversal, or normalization.
76globbing_selftestproc globbing_selftest() -> bool {Owns path semantics, traversal, or normalization.

Exports

LineNameSignatureRole
84*export *Re-exports surfaces that the module wants to expose as part of its public boundary.

Integration boundaries

Within path, this file should remain focused. If a future helper changes the host boundary, scheduling boundary, or data-shape boundary, it probably belongs in a neighbor module instead of being added here by convenience.

  • Family responsibility: Path manipulation, special locations, walkers, and globbing.
  • Family architecture role: Use `path` when the program needs path semantics, traversal, or normalization. Keep it distinct from file contents and from business validation.

Composition guidance

Choose this module when

  • Choose path/globbing.vitl when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
  • A project root can be normalized before any file is read.
  • A walker can enumerate source files while parsing and diagnostics remain elsewhere.

Pause before extending it when

  • Avoid extending this file when the new helper mostly changes the boundary to host I/O, runtime coordination, or foreign integration instead of staying inside path.
  • Check nearby modules such as path/manipulation.vitl, path/special.vitl, path/walker.vitl before adding convenience wrappers here.

Relationship table

This table keeps the page closer to a real encyclopedia entry: a module is easier to understand when compared with its nearest alternatives in the same family.

NeighborProceduresData surfacesWhy compare it
path/manipulation.vitl404Shares the same family boundary but carries a distinct slice of responsibility.
path/special.vitl193Shares the same family boundary but carries a distinct slice of responsibility.
path/walker.vitl114Shares the same family boundary but carries a distinct slice of responsibility.
path.vitl796Shares the same family boundary but carries a distinct slice of responsibility.

Neighbor modules