🥮 mooncakes.io
    Sign in

    readdirp

    Directory walking for MoonBit native/LLVM targets.

    dir
    readdir
    readdirp
    Download zip
    Author
    Version
    0.1.3
    License
    Apache-2.0
    Repository
    Last updated
    5 months ago
    Downloads
    66

    No dependencies

    #readdirp

    Directory walking for MoonBit native/LLVM targets.

    This package is a synchronous MoonBit port inspired by readdirp. It returns arrays instead of exposing a stream API, and its filesystem implementation is available on native/LLVM backends.

    #Usage

    Use readdirp when you only need matching entries, or readdirp_report when you also want non-fatal warning details for paths skipped while walking. Start from Options::default() and override the fields you need.

    let options = @readdirp.Options::{
      ..@readdirp.Options::default(),
      type_: @readdirp.FilesAndDirectories,
      depth: 2,
      always_stat: true,
      file_filter: @readdirp.basename_filter_any(["README.mbt.md", "moon.pkg"]),
      directory_filter: entry => entry.basename != "_build",
    }

    let report = @readdirp.readdirp_report(".", options~)
    for entry in report.entries {
      println(entry.path)
    }
    for warning in report.warnings {
      println(warning.path + ": " + warning.message)
    }

    let entries = @readdirp.readdirp(".", options~)

    #API

    readdirp(root, options~) returns Array[EntryInfo].

    readdirp_report(root, options~) returns ReaddirpReport, which contains both entries and recoverable warnings.

    EntryInfo contains:

    • path: path relative to the root
    • full_path: absolute path
    • basename: final path segment
    • kind: File, Directory, Symlink, or Other
    • stats: Some(FileStats) when always_stat is enabled, otherwise None

    Options fields:

    • file_filter: predicate for files, symlinks, and other non-directory entries
    • directory_filter: predicate for directories before emitting or recursing
    • type_: Files, Directories, FilesAndDirectories, or All
    • lstat: preserve symlinks as Symlink instead of following them
    • always_stat: include FileStats in each returned entry
    • depth: maximum recursion depth, where 0 reads only direct children

    basename_filter(name) and basename_filter_any(names) are small helpers for common file_filter or directory_filter checks. Helper inputs are trimmed, so basename_filter(" a.js ") matches a.js.

    #Behavior

    By default, readdirp emits files, traverses directories, includes dotfiles, and omits stats from returned entries. Directory entries are only emitted when type_ includes directories.

    With lstat: false, symlinks are followed: symlinks to files are emitted as File, and symlinks to directories are traversed. Recursive directory symlinks are skipped and reported as RecursiveSymlink warnings.

    With lstat: true, symlinks are preserved as Symlink. Use type_: All if you want symlink entries included in the result.

    Recoverable filesystem errors while walking are collected by readdirp_report. Warning kinds include Missing, PermissionDenied, TooManySymlinks, RecursiveSymlink, and Other. Invalid roots and invalid options raise ReaddirpError.

    #Examples

    The examples/basic/readdirp.mbtx script is a copyable native example. It scans examples by default, or a directory you pass as the final argument.

    moon run --target native examples/basic/readdirp.mbtx -- scan
moon run --target native examples/basic/readdirp.mbtx -- scan .
moon run --target native examples/basic/readdirp.mbtx -- report .

    If the script cannot resolve i5ting/readdirp@0.1.1, refresh the local registry first with moon update.

    The script uses Options::default() with type_: FilesAndDirectories, always_stat: true, and a directory_filter that skips .git, _build, and .mooncakes.

    #Development

    Run the native test suite:

    moon test --target native

    Run all backend checks:

    moon test --target all
moon check --target all --warn-list +73

    Run benchmarks:

    moon bench --target native

    ReaddirpError

    source
    pub(all) suberror ReaddirpError {
      ReaddirpError(String)
    } derive(
    Debug    )

    EntryInfo

    source
    pub(all) struct EntryInfo {
      path : String
      full_path : String
      basename : String
      kind : FileKind
      stats : FileStats?
    } derive(Eq, 
    Debug    )

    EntryType

    source
    pub(all) enum EntryType {
      Files
      Directories
      FilesAndDirectories
      All
    } derive(Eq, 
    Debug    )

    FileKind

    source
    pub(all) enum FileKind {
      File
      Directory
      Symlink
      Other
    } derive(Eq, 
    Debug    )

    FileStats

    source
    pub(all) struct FileStats {
      size : Int64
      mode : Int
    } derive(Eq, 
    Debug    )

    Options

    source
    pub(all) struct Options {
      file_filter : (EntryInfo) -> Bool
      directory_filter : (EntryInfo) -> Bool
      type_ : EntryType
      lstat : Bool
      always_stat : Bool
      depth : Int
    }

    Options::default

    source
    fn Options::default() -> Options

    ReaddirpReport

    source
    pub(all) struct ReaddirpReport {
      entries : Array[EntryInfo]
      warnings : Array[ReaddirpWarning]
    } derive(Eq, 
    Debug    )

    ReaddirpWarning

    source
    pub(all) struct ReaddirpWarning {
      path : String
      kind : WarningKind
      message : String
    } derive(Eq, 
    Debug    )

    WarningKind

    source
    pub(all) enum WarningKind {
      Missing
      PermissionDenied
      TooManySymlinks
      RecursiveSymlink
      Other
    } derive(Eq, 
    Debug    )

    basename_filter

    source
    fn basename_filter(name : String) -> ((EntryInfo) -> Bool)

    basename_filter_any

    source
    fn basename_filter_any(names : Array[String]) -> ((EntryInfo) -> Bool)

    readdirp

    source
    fn readdirp(root : String, options? : Options) -> Array[EntryInfo] raise ReaddirpError

    readdirp_report

    source
    fn readdirp_report(root : String, options? : Options) -> ReaddirpReport raise ReaddirpError

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io