Skip to content

feat(vfox): add stat function to lua file module#9497

Merged
jdx merged 1 commit intojdx:mainfrom
esteve:stat-lua
Apr 30, 2026
Merged

feat(vfox): add stat function to lua file module#9497
jdx merged 1 commit intojdx:mainfrom
esteve:stat-lua

Conversation

@esteve
Copy link
Copy Markdown
Contributor

@esteve esteve commented Apr 30, 2026

This PR adds a stat function so that custom plugins written in Lua can obtain metadata about files (e.g. in the case of the Pixi env plugin for checking against the cache whether to run pixi shell-hook --json or not, which is an expensive operation)

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 30, 2026

Greptile Summary

This PR adds a file.stat() function to the vfox Lua file module, returning a table with size, is_file, is_dir, is_symlink, timestamp fields, and a Unix-only mode string (masked to 12 permission bits with & 0o7777). It also ships matching LuaLS type annotations and a test that is correctly platform-guarded for the Unix-only mode assertion.

Confidence Score: 5/5

Safe to merge — all previously-flagged issues are resolved and the implementation is correct.

No P0 or P1 findings. The stat function uses a typed path: String argument (no index panic), masks mode to 12 bits with & 0o7777, properly propagates non-NotFound errors, and the Windows-incompatible mode test assertion is correctly guarded with #[cfg(unix)].

No files require special attention.

Important Files Changed

Filename Overview
crates/vfox/src/lua_mod/file.rs Adds stat async function that returns file metadata as a Lua table; all previously-flagged issues (mode masking, error propagation, compile error, Windows test guard) are resolved in this version.
crates/vfox/types/mise-plugin.lua Adds FileStat LuaLS type definition and annotates the stat function on the file module; accurate and consistent with the Rust implementation.

Sequence Diagram

sequenceDiagram
    participant LP as Lua Plugin
    participant FM as file module
    participant SR as stat() Rust
    participant FS as std::fs

    LP->>FM: file.stat(path)
    FM->>SR: path String
    SR->>FS: symlink_metadata(path)
    alt file not found
        FS-->>SR: Err NotFound
        SR-->>LP: nil
    else other IO error
        FS-->>SR: Err other
        SR-->>LP: Lua error propagated
    else success
        FS-->>SR: Ok Metadata
        SR->>SR: build table size is_file is_dir modified mode
        SR-->>LP: FileStat table
    end
Loading

Reviews (4): Last reviewed commit: "feat(vfox): add stat function to lua fil..." | Re-trigger Greptile

Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a stat function to the Lua file module, enabling the retrieval of file metadata such as size, type, and timestamps. The review feedback identifies a potential panic when accessing arguments in the stat function and suggests using typed arguments in the Lua registration for better safety and validation. Additionally, it is recommended to mask the Unix file mode with 0o777 to ensure only permission bits are returned, maintaining consistency with the documentation.

Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Comment thread crates/vfox/src/lua_mod/file.rs Outdated
Comment thread crates/vfox/src/lua_mod/file.rs Outdated
@jdx jdx merged commit 0fc9645 into jdx:main Apr 30, 2026
35 checks passed
@esteve esteve deleted the stat-lua branch May 1, 2026 08:28
mise-en-dev added a commit that referenced this pull request May 3, 2026
### 🚀 Features

- **(conda)** graduate conda backend out of experimental by @jdx in
[#9544](#9544)
- **(deps)** Add dart and flutter providers by @tjarvstrand in
[#9505](#9505)
- **(registry)** add neo4j by @mnm364 in
[#9525](#9525)
- **(registry)** add rustfs by @mnm364 in
[#9530](#9530)
- **(task)** support exclusion patterns in task sources by
@jlarmstrongiv in [#9496](#9496)
- **(vfox)** add stat function to lua file module by @esteve in
[#9497](#9497)

### 🐛 Bug Fixes

- **(backend)** flag regex prerelease versions by @jdx in
[#9500](#9500)
- **(backend)** mark -nightly/-canary/-experimental as prereleases by
@jdx in [#9523](#9523)
- **(backend)** suppress no-versions warning for unresolved-latest
backends by @jdx in [#9548](#9548)
- **(backend)** include dotnet prereleases from package flags by @jdx in
[#9551](#9551)
- **(backend)** scope PEP 440 prerelease detection to Python backends by
@jdx in [#9558](#9558)
- **(cargo)** Apply install_env during cargo install by @c22 in
[#9502](#9502)
- **(copr)** drop epel-9 chroots since rust >= 1.91 is unavailable by
@jdx in [#9484](#9484)
- **(github)** skip attestations on non-default api_url by @jdx in
[#9486](#9486)
- **(github)** retry ip allow list errors without auth by @risu729 in
[#9506](#9506)
- **(http)** update versions host tracking endpoint by @jdx in
[#9527](#9527)
- **(install)** don't warn for configured tools when version is passed
via CLI by @jdx in [#9522](#9522)
- **(install)** refresh latest before installing missing tools by @jdx
in [#9545](#9545)
- **(install)** don't cache nonexistent install paths by @jdx in
[#9553](#9553)
- **(lockfile)** don't propagate ad-hoc CLI overrides into the project
lockfile by @jdx in [#9562](#9562)
- **(plugin)** detect plugin types after cloning by @risu729 in
[#9540](#9540)
- **(release)** pass --no-git-checks to aube publish by @jdx in
[#9483](#9483)
- **(task)** convert PATH to MSYS Unix form when spawning POSIX shells
on Windows by @JamBalaya56562 in
[#9547](#9547)

### 📚 Documentation

- **(contributing)** require popularity check for registry PRs by @jdx
in
[7bbeebe](7bbeebe)
- **(watch)** update pitchfork domain to en.dev by @risu729 in
[#9536](#9536)
- document ghtkn GitHub token setup by @jdx in
[#9546](#9546)
- clarify registry backend acceptance policy by @jdx in
[#9543](#9543)
- Change exec command to use bash for variable echo by @kuboon in
[#9567](#9567)

### 🧪 Testing

- **(e2e)** run test-tool targets in parallel by @jdx in
[#9564](#9564)
- **(e2e)** run tests in parallel by @jdx in
[#9563](#9563)
- **(e2e)** bind-mount /tmp on disk and surface failed tests in CI
summary by @jdx in [#9570](#9570)
- **(tasks)** migrate test_task_help atask to usage field by @jdx in
[#9549](#9549)

### 📦️ Dependency Updates

- update fedora:45 docker digest to 8b838b3 by @renovate[bot] in
[#9507](#9507)
- update ghcr.io/jdx/mise:deb docker digest to f02194c by @renovate[bot]
in [#9509](#9509)
- update taiki-e/install-action digest to 7769b73 by @renovate[bot] in
[#9512](#9512)
- update ghcr.io/jdx/mise:alpine docker digest to 581f8a8 by
@renovate[bot] in [#9508](#9508)
- update rust crate ctor to v0.10.1 by @renovate[bot] in
[#9515](#9515)
- update ghcr.io/jdx/mise:rpm docker digest to a5c9655 by @renovate[bot]
in [#9510](#9510)
- update rust docker digest to a9cfb75 by @renovate[bot] in
[#9511](#9511)
- update rust crate age to v0.11.3 by @renovate[bot] in
[#9514](#9514)
- update rust crate jiff to v0.2.24 by @renovate[bot] in
[#9516](#9516)
- update dependency vitepress-plugin-tabs to ^0.9.0 by @renovate[bot] in
[#9518](#9518)
- update autofix-ci/action action to v1.3.4 by @renovate[bot] in
[#9513](#9513)
- update rust crate usage-lib to v3.2.1 by @renovate[bot] in
[#9517](#9517)
- update apple-actions/import-codesign-certs action to v7 by
@renovate[bot] in [#9519](#9519)
- update taiki-e/install-action digest to 51cd0b8 by @renovate[bot] in
[#9531](#9531)
- exclude taiki-e/install-action from renovate by @jdx in
[#9532](#9532)
- update rust crate blake3 to v1.8.5 by @renovate[bot] in
[#9533](#9533)

### 📦 Registry

- enable shellcheck on windows by @zeitlinger in
[#9487](#9487)
- add google-java-format by @zeitlinger in
[#9488](#9488)
- add expert
([aqua:expert-lsp/expert](https://github.com/expert-lsp/expert)) by
@AlternateRT in [#9498](#9498)
- update entry for checkmake by @eread in
[#9504](#9504)
- add systemctl-tui
([aqua:rgwood/systemctl-tui](https://github.com/rgwood/systemctl-tui))
by @2xdevv in [#9521](#9521)
- add codon by @3w36zj6 in
[#9538](#9538)
- add tool yr (backend:github:VirusTotal/yara-x) by @adam-moss in
[#9542](#9542)
- add tool betterleaks (backend:aqua/betterleaks/betterleaks) by
@adam-moss in [#9541](#9541)
- add `git-filter-repo` by @garysassano in
[#9550](#9550)
- add umoci
([aqua:opencontainers/umoci](https://github.com/opencontainers/umoci))
by @2xdevv in [#9555](#9555)
- add aqua backend for elixir-ls by @AlternateRT in
[#9557](#9557)
- deny inline backend options by @risu729 in
[#9565](#9565)

### Chore

- **(ci)** fail registry tests without summary by @jdx in
[#9559](#9559)
- **(ci)** use !cancelled() instead of always() for test-ci aggregator
by @jdx in [#9569](#9569)
- **(ci)** use namespace runners for ci jobs by @jdx in
[#9561](#9561)
- **(config)** deprecate shorthands_file setting by @risu729 in
[#9534](#9534)
- **(docs)** remove shrill.en.dev analytics script by @jdx in
[#9539](#9539)
- **(release)** replace bc with awk in release-plz star formatting by
@jdx in
[d7f177f](d7f177f)
- bump hk to 1.44.3 by @jdx in
[#9493](#9493)
- invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical by @jdx in
[#9560](#9560)
- set dev profile debug to 1 by @jdx in
[#9572](#9572)

### New Contributors

- @kuboon made their first contribution in
[#9567](#9567)
- @AlternateRT made their first contribution in
[#9557](#9557)
- @2xdevv made their first contribution in
[#9555](#9555)
- @adam-moss made their first contribution in
[#9541](#9541)
- @jlarmstrongiv made their first contribution in
[#9496](#9496)
- @tjarvstrand made their first contribution in
[#9505](#9505)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants