iris-context/docs/dev/filegen.md

Dynamic file suggestion generator (spec/filegen.go)

The FileGenerator is a dynamic suggestion engine bridging static command specs with your live filesystem.

How it works

The generator is assigned to commands or options expecting file path arguments (e.g. cat, go run).

Path resolution

Handles both local and nested paths:

• cat m -> Scans ./ for entries starting with m.
• cat src/ -> Scans src/ for all entries.
• cat src/main -> Scans src/ for entries starting with main.

Intelligence features

1. Extension filtering: Restricts the generator to specific file extensions (e.g. FileGenerator(".go") for go build).
2. Directory suffixing: When a directory is suggested, Iris appends / without an extra trailing space, allowing continuous folder traversal.
3. Descriptions: Converts file extensions into human-readable labels (e.g. .mp4 -> video, .zip -> archive).
4. Directory-only mode: Commands like cd filter out files to display directories only.

Code example

// registration for 'go run'
Generator: spec.FileGenerator(".go")

When typing go run , Iris scans the target directory, filters for .go extensions, and ignores unrelated binaries or assets.