Skip to content

AGENTS.md

Latest commit

 

History

History
32 lines (27 loc) · 1.83 KB

AGENTS.md

File metadata and controls

32 lines (27 loc) · 1.83 KB
Raw

RustJava Agent Guidelines

Build/Test Commands

  • Build: cargo build (workspace), cargo build -p <crate> (single crate)
  • Test all: cargo test
  • Single test: cargo test <test_name> or cargo test -p <crate> <test_name>
  • Format: cargo fmt, Lint: cargo clippy

Code Style

  • Edition: Rust 2024, #![no_std] for core crates (use alloc crate)
  • Line width: 150 chars (rustfmt.toml)
  • Indent: 4 spaces, LF line endings
  • Imports: Group alloc/core first, then external crates, then crate:: local imports
  • Naming: snake_case for functions/files, PascalCase for types/traits
  • Error handling: Use Result<T> (alias for result::Result<T, JavaError>), never panic in library code
  • Async: Use #[async_trait::async_trait] for async trait methods, #[tokio::test] for async tests

Project Structure

  • jvm/ - Core JVM implementation (#![no_std])
  • jvm_rust/ - Rust-based JVM interpreter
  • java_runtime/ - Java standard library implementations
  • classfile/ - Class file parser
  • java_class_proto/ - Java class prototypes
  • test_utils/ - Shared test utilities

Testing Boundaries

  • Keep java_runtime/tests/classes limited to Java standard library class and API behavior.
  • Test JVM and interpreter semantics, including class initialization, bytecode execution, and monitor behavior, with compiled Java fixtures under test_data/src and expected output under test_data, executed by tests/test_class.rs.
  • Do not place JVM core behavior tests in the java_runtime standard library test tree.

Compatibility Sources

  • Implement Java compatibility from public specifications, Javadocs, and observable behavior tests. Do not consult or reproduce OpenJDK or other Java runtime implementation source code; keep the implementation independent to avoid licensing and provenance concerns.