feat: create ScriptingDocgenPlugin to allow exporting LAD files +…

… export BMS bindings (#303)
makspll · Feb 22, 2025 · 5b427a7 · 5b427a7
1 parent 9eb3038
commit 5b427a7
Show file tree

Hide file tree

Showing 23 changed files with 269 additions and 294 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,4 +14,7 @@ Cargo.lock
 assets/scripts/tlconfig.lua
 **.log
 **build/
-.html
+.html
+
+/assets/**/*.lad.json
+/docs/src/ladfiles/*.lad.json
diff --git a/Cargo.toml b/Cargo.toml
@@ -77,6 +77,7 @@ rand = "0.8.5"
 bevy_console = "0.13"
 # rhai-rand = "0.1"
 ansi-parser = "0.9"
+ladfile_builder = { path = "crates/ladfile_builder", version = "0.2.0" }
 
 [workspace]
 members = [
@@ -134,6 +135,11 @@ required-features = [
     "bevy/multi_threaded",
 ]
 
+[[example]]
+name = "docgen"
+path = "examples/docgen.rs"
+required-features = []
+
 [workspace.lints.clippy]
 panic = "deny"
 unwrap_used = "deny"

diff --git a/assets/scripts/bevy_api.lua b/assets/scripts/bevy_api.lua
diff --git a/assets/scripts/complex_game_loop.lua b/assets/scripts/complex_game_loop.lua
diff --git a/assets/scripts/console_integration.lua b/assets/scripts/console_integration.lua
diff --git a/assets/scripts/console_integration.rhai b/assets/scripts/console_integration.rhai
diff --git a/assets/scripts/coroutines.lua b/assets/scripts/coroutines.lua
diff --git a/assets/scripts/dynamic_queries.lua b/assets/scripts/dynamic_queries.lua
diff --git a/assets/scripts/dynamic_queries.rhai b/assets/scripts/dynamic_queries.rhai
diff --git a/assets/scripts/event_recipients.lua b/assets/scripts/event_recipients.lua
diff --git a/assets/scripts/event_recipients.rune b/assets/scripts/event_recipients.rune
diff --git a/assets/scripts/minimal.rune b/assets/scripts/minimal.rune
diff --git a/assets/scripts/multiple_events_rhai.rhai b/assets/scripts/multiple_events_rhai.rhai
diff --git a/assets/scripts/runtime_error.lua b/assets/scripts/runtime_error.lua
diff --git a/crates/bevy_mod_scripting_core/Cargo.toml b/crates/bevy_mod_scripting_core/Cargo.toml
@@ -44,7 +44,6 @@ derivative = "2.2"
 profiling = { workspace = true }
 bevy_mod_scripting_derive = { workspace = true }
 
-
 [dev-dependencies]
 test_utils = { workspace = true }
 tokio = { version = "1", features = ["rt", "macros"] }

diff --git a/crates/bevy_mod_scripting_core/src/docgen/mod.rs b/crates/bevy_mod_scripting_core/src/docgen/mod.rs
@@ -1,3 +1,4 @@
 //! Documentation generation for scripting languages.
+
 pub mod info;
 pub mod typed_through;
diff --git a/crates/ladfile_builder/Cargo.toml b/crates/ladfile_builder/Cargo.toml
@@ -15,6 +15,7 @@ readme = "readme.md"
 [dependencies]
 bevy_mod_scripting_core = { workspace = true }
 # I don't think bevy has a top level feature for this :C
+bevy = { workspace = true }
 bevy_reflect = { version = "0.15.2", features = ["documentation"] }
 ladfile = { version = "0.2.0", path = "../ladfile" }
 regex = "1.11"

diff --git a/crates/ladfile_builder/src/lib.rs b/crates/ladfile_builder/src/lib.rs
@@ -1,4 +1,5 @@
 //! Parsing definitions for the LAD (Language Agnostic Decleration) file format.
+pub mod plugin;
 
 use bevy_mod_scripting_core::{
     bindings::{