finished docs generator. added rust to action.

Author: cameronpcampbell

.github/workflows/build-docs.yml

@@ -33,6 +33,11 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup Rust
+        run: rustup override set 1.28.1
+      - name: Output rust version for educational purposes
+        run: rustup --version
+
       - name: Setup Bun
         uses: oven-sh/setup-bun@v1
         with:

docs/generation/Cargo.lock

@@ -7,7 +7,4 @@ edition = "2024"
 full_moon = { version = "2.0.0", features = [ "luau" ] }
 logos = "0.15.0"
 guarded = "0.0.2"
-unindent = "0.2.4"
-convert_case = "0.8.0"
-phf = "0.11.3"
-phf_macros = "0.11.3"
+unindent = "0.2.4"

docs/generation/Cargo.toml

@@ -1,21 +1,23 @@
-use std::{fs, path::Path};
+use std::{collections::HashMap, fs, path::Path};
 
 use full_moon::{ast::{luau::ExportedTypeFunction, Stmt}, node::Node, parse, tokenizer::{TokenKind, TokenType}};
 use guarded::guarded_unwrap;
 
-use convert_case::{Case, Casing};
-
 mod lex_doc_comment;
 use lex_doc_comment::DocCommentLexer;
 
 mod parse_doc_comment;
 use parse_doc_comment::parse_doc_comment;
+use unindent::Unindent;
 
 const INIT_CONTENT: &str = include_str!("../../../src/init.luau");
 
 const OUTPUT_PATH_STR: &str = "../../docs/site/docs";
 
-fn parse_exported_type_func(output_path: &Path, type_func: &ExportedTypeFunction) {
+fn parse_exported_type_func(
+    files: &mut HashMap<String, String>,
+    type_func: &ExportedTypeFunction
+) {
     let first_token = type_func.export_token();
 
     let doc_comment = guarded_unwrap!(
@@ -37,13 +39,14 @@ fn parse_exported_type_func(output_path: &Path, type_func: &ExportedTypeFunction
     let mut lexer = DocCommentLexer::new(&doc_comment_string);
     let (parsed, category) = parse_doc_comment(&mut lexer, &type_func_name, type_func.range().unwrap());
 
-    let output_path_for_category = output_path.join(category);
-    let _ = fs::create_dir_all(&output_path_for_category);
-
-    let _ = fs::write(output_path_for_category.join(format!("{}.md", type_func_name.to_case(Case::Snake))), parsed);
+    files.entry(category)
+        .and_modify(|f| f.push_str(&format!("\n\n- - -\n\n{}", parsed)))
+        .or_insert(parsed);
 }
 
 fn main() {
+    let mut files: HashMap<String, String> = HashMap::new();
+
     let output_path = Path::new(OUTPUT_PATH_STR);
 
     if output_path.is_dir() {
@@ -56,8 +59,28 @@ fn main() {
 
     for statement in ast.nodes().stmts() {
         match statement {
-            Stmt::ExportedTypeFunction(type_func) => parse_exported_type_func(output_path, type_func),
+            Stmt::ExportedTypeFunction(type_func) => {
+                parse_exported_type_func(&mut files, type_func)
+            }
             _ => continue
         };
     }
+
+    for (category, file_content) in files {
+        let _ = fs::write(output_path.join(format!("{}.md", category)), file_content);
+    }
+
+    let _ = fs::write(output_path.join("index.md"), 
+    "---
+        title: Redirecting...
+        ---
+
+        <script setup>
+        if (typeof window !== 'undefined') {
+            window.location.replace('/docs/core/')
+        }
+        </script>
+
+        <p>Redirecting you to the core docs...</p>".unindent()
+    );
 }

docs/generation/src/main.rs

@@ -6,6 +6,8 @@ use crate::lex_doc_comment::{DocCommentLexer, DocCommentTagToken};
 
 const GITHUB_URL_PREFIX: &str = "https://github.com/typeforge-luau/typeforge/blob/main/src/init.luau";
 
+const GITHUB_IMAGE: &str = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"1024\" height=\"1024\" viewBox=\"0 0 1024 1024\"><path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z\" transform=\"scale(64)\"/></svg>";
+
 fn github_url_for_range(range: (Position, Position)) -> String {
     format!("{}#L{}-L{}", GITHUB_URL_PREFIX, range.0.line(), range.1.line())
 }
@@ -26,7 +28,7 @@ pub fn parse_doc_comment(
     let item_tag_token = item.tag_token;
     match item_tag_token {
         None => if let Some(body) = item.body.take() {
-            description = body.unindent() + &format!(" [View On Github]({})", github_url_for_range(type_func_range))
+            description = body.unindent()
         } else {
             description = String::new()
         },
@@ -39,8 +41,13 @@ pub fn parse_doc_comment(
                     DocCommentTagToken::ParamTag => {
                         let (param_name, body) = body.split_once(" ").unwrap();
                         let (param_type, param_description) = body.split_once("--").unwrap();
-    
-                        params += &format!("| {} | {} | {} |\n", param_name, param_type.trim(), param_description.trim());
+
+                        params += &format!(
+                            "| {} | {} | {} |\n",
+                            param_name,
+                            &format!("`{}`{{luau-type}}",param_type.trim()),
+                            param_description.trim()
+                        );
                     },
 
                     DocCommentTagToken::ExampleTag => {
@@ -67,7 +74,12 @@ pub fn parse_doc_comment(
                         let (param_name, body) = body.split_once(" ").unwrap();
                         let (param_type, param_description) = body.split_once("--").unwrap();
 
-                        params += &format!("| {} | {} | {} |\n", param_name, param_type.trim(), param_description.trim());
+                        params += &format!(
+                            "| {} | {} | {} |\n",
+                            param_name,
+                            &format!("`{}`{{luau-type}}",param_type.trim()),
+                            param_description.trim()
+                        );
                     },
 
                     DocCommentTagToken::ExampleTag => {
@@ -99,5 +111,14 @@ pub fn parse_doc_comment(
         parsed += &format!("\n\n## Examples\n{}", examples.trim_end())
     }
 
-    (format!("# {}\n{}", type_func_name, parsed), category.to_lowercase())
+    (format!(
+        "# {}{}\n{}",
+        type_func_name,
+        &format!(
+            "<a href=\"{}\" target=\"_blank\" rel=\"noreferrer noopener\"><Badge type=\"info\">{}</Badge></a>",
+            github_url_for_range(type_func_range),
+            GITHUB_IMAGE
+        ),
+        parsed
+    ), category.to_lowercase())
 }