chore: cleanup + readme

README.md

@@ -0,0 +1,12 @@
+# dojo-beta
+
+Dojo is a toolchain for developing onchain games on Starknet. It implements an Entity Component System and 
+
+## Getting Started
+### Prerequisites
+- Install [Rust](https://www.rust-lang.org/tools/install)
+- Setup Rust:
+```
+rustup override set stable && rustup update && cargo test
+```
+

crates/cairo-lang-dojo/README.md

@@ -0,0 +1,15 @@
+# cairo-lang-dojo
+
+Cairo language plugin for compiling the Dojo Entity Component System to Starknet contracts.
+
+## Testing
+
+Expected test outputs are defined in `crates/cairo-lang-dojo/src/plugin_test_data/component`.
+
+To run the tests, run:
+
+```
+cargo test --package cairo-lang-dojo --lib -- plugin::test::expand_contract::component --exact --nocapture
+```
+
+To regenerate, set `CAIRO_FIX_TESTS=1`.

crates/cairo-lang-dojo/src/plugin.rs

@@ -60,16 +60,12 @@ pub struct DojoPlugin {}
 
 impl MacroPlugin for DojoPlugin {
     fn generate_code(&self, db: &dyn SyntaxGroup, item_ast: ast::Item) -> PluginResult {
-        println!("{}\n---", item_ast.as_syntax_node().get_text(db));
         match item_ast {
             ast::Item::Struct(struct_ast) => handle_struct(db, struct_ast),
-            // ast::Item::Module(module_ast) => handle_mod(db, module_ast),
+            ast::Item::Impl(impl_ast) => handle_impl(db, impl_ast),
             // ast::Item::Trait(trait_ast) => handle_trait(db, trait_ast),
             // Nothing to do for other items.
-            _ => PluginResult {
-                remove_original_item: false,
-                ..PluginResult::default()
-            }
+            _ => PluginResult::default(),
         }
     }
 }
@@ -184,3 +180,7 @@ fn handle_component(db: &dyn SyntaxGroup, struct_ast: ast::ItemStruct) -> Plugin
         remove_original_item: false,
     }
 }
+
+fn handle_impl(_db: &dyn SyntaxGroup, _impl_ast: ast::ItemImpl) -> PluginResult {
+    PluginResult { remove_original_item: true, ..PluginResult::default() }
+}

crates/cairo-lang-dojo/src/plugin_test.rs

@@ -32,13 +32,15 @@ pub fn test_expand_contract(
             format_diagnostics(db, &diag.message, location)
         }));
 
+        if !remove_original_item {
+            generated_items.push(item.as_syntax_node().get_text(db));
+        }
+
         let content = match code {
             Some(PluginGeneratedFile { content, .. }) => content,
             None => continue,
         };
-        if !remove_original_item {
-            generated_items.push(item.as_syntax_node().get_text(db));
-        }
+
         generated_items.push(content);
     }
 

crates/cairo-lang-dojo/src/plugin_test_data/component

@@ -1,19 +1,14 @@
-//! > Test expansion of the hello_starknet contract.
+//! > Test expansion of the component contract.
 
 //! > test_function_name
 test_expand_contract
 
 //! > cairo_code
-#[abi]
-trait IPosition {
-    fn is_zero(entity_id: felt) -> bool;
-}
-
 #[derive(Component)]
 struct Position { x: felt, y: felt }
 
 impl IPosition of Position {
-    #[external]
+    #[view]
     fn is_zero(entity_id: felt) -> bool {
         return bool::True(());
     }