Add editor structure outline to the developer guide on the website

Author: Keavon

.github/workflows/website.yml

@@ -44,6 +44,34 @@ jobs:
           # Remove the INDEX_HTML_HEAD_INCLUSION environment variable for build links (not master deploys)
           git rev-parse --abbrev-ref HEAD | grep master > /dev/null || export INDEX_HTML_HEAD_INCLUSION=""
 
+      - name: 💿 Obtain cache of auto-generated code docs artifacts
+        id: cache-website-code-docs
+        uses: actions/cache/restore@v3
+        with:
+          path: artifacts
+          key: website-code-docs
+
+      - name: 📁 Fallback in case auto-generated code docs artifacts weren't cached
+        if: steps.cache-website-code-docs.outputs.cache-hit != 'true'
+        run: |
+          echo "🦀 Initial system version of Rust:"
+          rustc --version
+          rustup update stable
+          echo "🦀 Latest updated version of Rust:"
+          rustc --version
+          cargo test --package graphite-editor --lib -- messages::message::test::generate_message_tree
+          mkdir artifacts
+          mv hierarchical_message_system_tree.txt artifacts/hierarchical_message_system_tree.txt
+
+      - name: 🚚 Move `artifacts` contents to `website/other/editor-structure`
+        run: |
+          mv artifacts/* website/other/editor-structure
+
+      - name: 🔧 Build auto-generated code docs artifacts into HTML
+        run: |
+          cd website/other/editor-structure
+          node generate.js hierarchical_message_system_tree.txt replacement.html
+
       - name: 🌐 Build Graphite website with Zola
         env:
           MODE: prod
@@ -84,29 +112,6 @@ jobs:
           mkdir -p website/public
           mv website/other/dist/* website/public
 
-      - name: 💿 Obtain cache of auto-generated code docs artifacts
-        id: cache-website-code-docs
-        uses: actions/cache/restore@v3
-        with:
-          path: artifacts
-          key: website-code-docs
-
-      - name: 📁 Fallback in case auto-generated code docs artifacts weren't cached
-        if: steps.cache-website-code-docs.outputs.cache-hit != 'true'
-        run: |
-          echo "🦀 Initial system version of Rust:"
-          rustc --version
-          rustup update stable
-          echo "🦀 Latest updated version of Rust:"
-          rustc --version
-          cargo test --package graphite-editor --lib -- messages::message::test::generate_message_tree
-          mkdir artifacts
-          mv hierarchical_message_system_tree.txt artifacts/hierarchical_message_system_tree.txt
-
-      - name: 🚚 Move `artifacts` contents to `website/public`
-        run: |
-          mv artifacts/* website/public
-
       - name: 📤 Publish to Cloudflare Pages
         id: cloudflare
         uses: cloudflare/pages-action@1

proc-macros/src/helpers.rs

@@ -72,6 +72,20 @@ pub fn clean_rust_type_syntax(input: String) -> String {
 					chars.next();
 				}
 			}
+			'-' => {
+				if let Some('>') = chars.peek() {
+					while let Some(' ') = result.chars().rev().next() {
+						result.pop();
+					}
+					result.push_str(" -> ");
+					chars.next();
+					while let Some(' ') = chars.peek() {
+						chars.next();
+					}
+				} else {
+					result.push(c);
+				}
+			}
 			':' => {
 				if let Some(':') = chars.peek() {
 					while let Some(' ') = result.chars().rev().next() {

proc-macros/src/message_handler_data_attr.rs

@@ -33,42 +33,24 @@ pub fn message_handler_data_attr_impl(attr: TokenStream, input_item: TokenStream
 				let message_type = &args.args[0];
 				let data_type = &args.args[1];
 
-				// Check if the attribute is "CustomData"
-				let is_custom_data = attr.to_string().contains("CustomData");
-
 				let impl_item = match data_type {
 					syn::GenericArgument::Type(t) => {
 						match t {
 							syn::Type::Path(type_path) if !type_path.path.segments.is_empty() => {
 								// Get just the base identifier (ToolMessageData) without generics
 								let type_name = &type_path.path.segments.first().unwrap().ident;
 
-								if is_custom_data {
-									quote! {
-										#input_item
-										impl #message_type {
-											pub fn message_handler_data_str() -> MessageData {
-												custom_data()
-											}
-											pub fn message_handler_str() -> MessageData {
-												MessageData::new(format!("{}",stringify!(#input_type)), #input_type::field_types(), #input_type::path())
+								quote! {
+									#input_item
+									impl #message_type {
+										pub fn message_handler_data_str() -> MessageData
+											{
+											MessageData::new(format!("{}", stringify!(#type_name)), #type_name::field_types(), #type_name::path())
 
-											}
 										}
-									}
-								} else {
-									quote! {
-										#input_item
-										impl #message_type {
-											pub fn message_handler_data_str() -> MessageData
-											 {
-												MessageData::new(format!("{}",stringify!(#type_name)), #type_name::field_types(), #type_name::path())
-
-											}
-											pub fn message_handler_str() -> MessageData {
-												MessageData::new(format!("{}",stringify!(#input_type)), #input_type::field_types(), #input_type::path())
+										pub fn message_handler_str() -> MessageData {
+											MessageData::new(format!("{}", stringify!(#input_type)), #input_type::field_types(), #input_type::path())
 
-											}
 										}
 									}
 								}
@@ -77,7 +59,7 @@ pub fn message_handler_data_attr_impl(attr: TokenStream, input_item: TokenStream
 								#input_item
 								impl #message_type {
 										pub fn message_handler_str() -> MessageData {
-											MessageData::new(format!("{}",stringify!(#input_type)), #input_type::field_types(), #input_type::path())
+											MessageData::new(format!("{}", stringify!(#input_type)), #input_type::field_types(), #input_type::path())
 										}
 									}
 							},
@@ -92,11 +74,11 @@ pub fn message_handler_data_attr_impl(attr: TokenStream, input_item: TokenStream
 									#input_item
 									impl #message_type {
 										pub fn message_handler_data_str() -> MessageData {
-											MessageData::new(format!("{}", #tr),#type_ident::field_types(), #type_ident::path())
+											MessageData::new(format!("{}", #tr), #type_ident::field_types(), #type_ident::path())
 										}
 
 										pub fn message_handler_str() -> MessageData {
-											MessageData::new(format!("{}",stringify!(#input_type)), #input_type::field_types(), #input_type::path())
+											MessageData::new(format!("{}", stringify!(#input_type)), #input_type::field_types(), #input_type::path())
 
 										}
 									}

website/.gitignore

@@ -3,3 +3,4 @@ public/
 static/fonts/
 static/syntax-highlighting.css
 static/text-balancer.js
+other/editor-structure/replacement.html