Skip to content

ROADMAP.md

Latest commit

 

History

History
63 lines (49 loc) · 3.69 KB

ROADMAP.md

File metadata and controls

63 lines (49 loc) · 3.69 KB
Raw

Roadmap

See GitHub Milestones for detailed issue tracking.

v0.1.0 - MVP

  • Core AST data structures with comprehensive serialization
  • Magic file parser for text format with hierarchical rules
  • Rule evaluation engine with confidence scoring
  • Memory-mapped file I/O with FileBuffer
  • Text and JSON output formatters
  • CLI with multiple file support, stdin, --json, and --magic-file
  • Built-in fallback rules with build-time compilation
  • Strength calculation and !:strength parsing
  • Comprehensive error handling, rustdoc, and mdbook documentation
  • High test coverage across 1,200+ tests

v0.2.0 - Core Primitives

  • Split evaluator module into focused submodules (#59)
  • Disambiguate MatchResult types (#60)
  • Extract CLI tests into integration tests (#61)
  • Pre-create evaluator submodules for new features (#62)
  • Comparison operators: >, <, >=, <= (#34)
  • Bitwise XOR, NOT, and any-value operators (#35)
  • Indirect offset resolution (#37)
  • Relative offset resolution (#38)
  • Quad (64-bit integer) type (#36)

v0.3.0 - Advanced Features

  • Convert evaluator/types.rs to directory module (#63)
  • Regex and search types (#39)
  • Float and double types (#40)
  • Date and timestamp types (#41)
  • Pascal string type (#43)
  • Meta-types: default, clear, name, use, indirect, offset (#42)

v0.4.0 - API and UX Polish

  • Builder pattern for MagicDatabase (#45)
  • JSON output metadata (#46)
  • Parse warnings for skipped rules (#47)
  • Improved error messages (#49)
  • Partial results on timeout (#44)

v1.0.0 - Production Ready

  • 95%+ compatibility with GNU file (#48, #57)
  • Stable API with semver guarantees
  • Migration guide from C libmagic
  • Performance parity validation
  • crates.io publication

Non-Goals

The following are explicitly out of scope for this project:

  • Binary .mgc compilation: We follow the OpenBSD approach of using text magic files directly, not the compiled binary format
  • Drop-in C ABI replacement: This is a Rust-native library, not a C-compatible shared library with libmagic.so ABI
  • MIME database management: We detect file types via magic rules, not by maintaining a MIME type registry
  • File modification or conversion: This is a read-only detection tool
  • Network protocol detection: We identify file contents, not network traffic