Atlas Rust

Atlas Rust is a Visual Studio Code extension designed to simplify and standardise the creation of Rust modules. It automates folder creation, mod.rs management, and module declarations, fully respecting Rust’s module system, including nested modules.

The goal of this project is to provide a Java-like project experience for Rust, without breaking idiomatic Rust practices.

✨ Features

✅ Current Features

• Create Rust modules using a simple path syntax:

  infra
  infra/sql
  infra/sql/auth
  

• Automatically:

  • Create the required folder structure
  • Create mod.rs files where needed
  • Update the correct parent module (mod.rs, lib.rs, or main.rs)

• Fully supports nested modules

• Prevents duplicate pub mod declarations

• Works with both:

  • src/main.rs
  • src/lib.rs

🧠 How It Works

Rust modules must be declared in their parent module, not always in the crate root.

For example, creating:

infra/sql

Produces:

src/
├── main.rs        → pub mod infra;
├── infra/
│   ├── mod.rs     → pub mod sql;
│   └── sql/
│       └── mod.rs

This extension follows that rule strictly, ensuring correctness and compatibility with the Rust compiler and tooling.

🚀 Usage

1. Open a Rust project in VS Code

2. Ensure it contains src/main.rs or src/lib.rs

3. Open the Command Palette:

   Ctrl + Shift + P
   

4. Run:

   Rust: Create Module
   

5. Enter a module path, for example:

   infra/sql/auth
   

🛠 Development & Testing

This extension can be tested without installing it:

1. Open the extension project in VS Code

2. Run:

   npm install
   npm run compile
   

3. Press F5

4. A new window will open: Extension Development Host

5. Open a Rust project in that window and use the command

📦 Project Structure

src/
├── extension.ts        # Extension entry point
├── commands/
│   └── createModule.ts # VS Code command
└── rust/
    └── modules.ts      # Rust module logic (core)

The Rust-specific logic is intentionally isolated to make future extensions easier and safer.

🗺 Roadmap

🔹 Short Term

• Add Context Menu integration

  • Right-click on a folder in src/
  • Create a module directly from the file explorer

• Improve error handling and UX

• Validate module names against Rust keywords

🔹 Mid Term

• Support both module styles:

  • module/mod.rs
  • module.rs

• Detect existing modules and suggest actions

• Add Code Actions (Quick Fixes)

🔹 Long Term Vision 🚀

• Create a Rust Project View (similar to Java Projects in VS Code)

  • Visual module tree
  • Crate-aware navigation
  • Clear distinction between modules, files, and crates

• Deep integration with:

  • cargo metadata
  • rust-analyzer

• Enable refactoring operations:

  • Move modules
  • Rename modules
  • Reorganise imports

🎯 Philosophy

This project aims to:

• Respect Rust’s module system
• Avoid fragile regex-based parsing
• Build tooling that scales from small projects to large codebases
• Provide a first-class project structure experience for Rust developers

🤝 Contributions

Contributions, ideas, and feedback are welcome. This extension is intentionally designed with a clean internal architecture to support future growth.

📄 License

MIT License

Atlas Rust Making Rust project structure explicit, correct, and easy to manage. 🦀