Contributors style and formatting upgrade (security-alliance#136)

* Updated the overall style and display of contributors

* Minor modifications to the previous commit, improving styling on featured contribs

* Updated wordlist

Author: mattaereal

plugin/mdbook-metadata/src/main.rs

@@ -681,10 +681,44 @@ fn generate_contributors_js(
     js.push_str("// This file is auto-generated by the tags preprocessor\n");
     js.push_str("const contributorsIndex = {\n");
 
+    // Load the contributors database once
+    let contributors_db = load_contributors_db()?;
+    
+    // Create a lookup from displayName/name to ID to help match contributors
+    let mut name_to_id: HashMap<String, String> = HashMap::new();
+    let mut id_to_display_name: HashMap<String, String> = HashMap::new();
+    
+    for (id, data) in &contributors_db {
+        // Map the ID directly
+        name_to_id.insert(id.clone(), id.clone());
+        
+        // Get display name for later use
+        let display_name = data.get("displayName")
+            .and_then(|v| v.as_str())
+            .or_else(|| data.get("name").and_then(|v| v.as_str()))
+            .unwrap_or(id);
+            
+        id_to_display_name.insert(id.clone(), display_name.to_string());
+        
+        // Map displayName to ID if available
+        if let Some(display_name) = data.get("displayName").and_then(|v| v.as_str()) {
+            name_to_id.insert(display_name.to_string(), id.clone());
+        }
+        
+        // Map name to ID if available
+        if let Some(name) = data.get("name").and_then(|v| v.as_str()) {
+            name_to_id.insert(name.to_string(), id.clone());
+        }
+    }
+
+    // Keep track of which contributors we've already processed
+    let mut processed_contributors = std::collections::HashSet::new();
+
     // Sort contributors alphabetically for consistency
     let mut sorted_contributors: Vec<_> = contributors_map.iter().collect();
     sorted_contributors.sort_by(|a, b| a.0.cmp(&b.0));
 
+    // First add all contributors who have contributed to chapters
     for (i, (contributor, chapters)) in sorted_contributors.iter().enumerate() {
         js.push_str(&format!("  \"{}\": {{\n", contributor));
         js.push_str(&format!("    \"chapters\": [\n"));
@@ -731,10 +765,139 @@ fn generate_contributors_js(
             }
         }
 
+        // Try to find the contributor in the database by mapped ID
+        let contributor_id = name_to_id.get(*contributor).cloned();
+        
+        if let Some(db_id) = &contributor_id {
+            if let Some(contributor_data) = contributors_db.get(db_id) {
+                // Add company if available
+                if let Some(company) = contributor_data.get("company").and_then(|v| v.as_str()) {
+                    if !company.is_empty() {
+                        js.push_str(&format!(",\n    \"company\": \"{}\"", company));
+                    }
+                }
+                
+                // Add role if available
+                if let Some(role) = contributor_data.get("role").and_then(|v| v.as_str()) {
+                    if !role.is_empty() {
+                        js.push_str(&format!(",\n    \"role\": \"{}\"", role));
+                    }
+                }
+                
+                // Add description if available
+                if let Some(description) = contributor_data.get("description").and_then(|v| v.as_str()) {
+                    if !description.is_empty() {
+                        js.push_str(&format!(",\n    \"description\": \"{}\"", description));
+                    }
+                }
+                
+                // Add features if available
+                if let Some(features) = contributor_data.get("features").and_then(|v| v.as_array()) {
+                    let features_str: Vec<String> = features.iter().filter_map(|v| v.as_str().map(String::from)).collect();
+                    if !features_str.is_empty() {
+                        js.push_str(&format!(",\n    \"features\": [{}]", features_str.iter().map(|f| format!("\"{}\"", f)).collect::<Vec<_>>().join(", ")));
+                    }
+                }
+            }
+        }
+        
         js.push_str("\n  }");
 
         if i < sorted_contributors.len() - 1 {
             js.push_str(",\n");
+        } else {
+            // If we're the last one and there will be more contributors after this,
+            // add a comma
+            if processed_contributors.len() < contributors_db.len() {
+                js.push_str(",\n");
+            } else {
+                js.push_str("\n");
+            }
+        }
+        
+        // Mark this contributor as processed
+        if let Some(db_id) = contributor_id {
+            processed_contributors.insert(db_id);
+        }
+    }
+
+    // Now add contributors from the database who haven't been processed yet
+    // These are contributors who haven't contributed to any chapters yet
+    let mut additional_contributors: Vec<_> = contributors_db.iter()
+        .filter(|(id, _)| !processed_contributors.contains(*id))
+        .collect();
+    additional_contributors.sort_by(|a, b| a.0.cmp(&b.0));
+    
+    for (i, (id, data)) in additional_contributors.iter().enumerate() {
+        // Get display name
+        let display_name = id_to_display_name.get(*id).unwrap_or(id);
+        
+        js.push_str(&format!("  \"{}\": {{\n", display_name));
+        
+        // Add empty chapters array
+        js.push_str("    \"chapters\": []");
+        
+        // Add github profile if available
+        if let Some(github) = data.get("github").and_then(|v| v.as_str()) {
+            if !github.is_empty() {
+                js.push_str(&format!(",\n    \"github\": \"{}\"", github));
+            }
+        }
+        
+        // Add avatar URL if available
+        if let Some(avatar) = data.get("avatar").and_then(|v| v.as_str()) {
+            if !avatar.is_empty() {
+                js.push_str(&format!(",\n    \"avatar\": \"{}\"", avatar));
+            }
+        }
+        
+        // Add Twitter profile if available
+        if let Some(twitter) = data.get("twitter").and_then(|v| v.as_str()) {
+            if !twitter.is_empty() {
+                js.push_str(&format!(",\n    \"twitter\": \"{}\"", twitter));
+            }
+        }
+        
+        // Add website if available
+        if let Some(website) = data.get("website").and_then(|v| v.as_str()) {
+            if !website.is_empty() {
+                js.push_str(&format!(",\n    \"website\": \"{}\"", website));
+            }
+        }
+        
+        // Add company if available
+        if let Some(company) = data.get("company").and_then(|v| v.as_str()) {
+            if !company.is_empty() {
+                js.push_str(&format!(",\n    \"company\": \"{}\"", company));
+            }
+        }
+        
+        // Add role if available
+        if let Some(role) = data.get("role").and_then(|v| v.as_str()) {
+            if !role.is_empty() {
+                js.push_str(&format!(",\n    \"role\": \"{}\"", role));
+            }
+        }
+        
+        // Add description if available
+        if let Some(description) = data.get("description").and_then(|v| v.as_str()) {
+            if !description.is_empty() {
+                js.push_str(&format!(",\n    \"description\": \"{}\"", description));
+            }
+        }
+        
+        // Add features if available
+        if let Some(features) = data.get("features").and_then(|v| v.as_array()) {
+            let features_str: Vec<String> = features.iter().filter_map(|v| v.as_str().map(String::from)).collect();
+            if !features_str.is_empty() {
+                js.push_str(&format!(",\n    \"features\": [{}]", features_str.iter().map(|f| format!("\"{}\"", f)).collect::<Vec<_>>().join(", ")));
+            }
+        }
+        
+        js.push_str("\n  }");
+        
+        if i < additional_contributors.len() - 1 {
+            js.push_str(",\n");
         } else {
             js.push_str("\n");
         }

src/community-management/discord.md

@@ -4,7 +4,7 @@ tags:
   - Security Specialist
 contributors:
   - mattaereal
-  - nft_dreww
+  - nftdreww
 ---
 
 # Discord Security

src/config/contributors.json

@@ -6,15 +6,44 @@
     "github": "https://github.com/mattaereal",
     "twitter": "https://twitter.com/mattaereal",
     "website": "https://theredguild.org",
-    "bio": "The Red Guild | SEAL"
+    "features": ["lead"],
+    "role": "Security Frameworks Lead",
+    "description": "Initiative lead and maintainer of the Security Frameworks",
+    "company": "The Red Guild | SEAL"
   },
-  "nft_dreww": {
-    "name": "NFT_Dreww.eth",
-    "displayName": "NFT_Dreww.eth",
+  "fredriksvantes": {
+    "name": "Fredrik Svantes",
+    "displayName": "Fredrik Svantes",
+    "avatar": "https://github.com/fredriksvantes.png",
+    "github": "https://github.com/fredriksvantes",
+    "twitter": "https://twitter.com/fredriksvantes",
+    "website": "https://fredriksvantes.com",
+    "features": ["core"],
+    "role": "Security Frameworks core",
+    "description": "Initial contributor to the Security Frameworks",
+    "company": "Ethereum Foundation"
+  },
+  "zedt3ster": {
+    "name": "zedt3ster",
+    "displayName": "zedt3ster",
+    "avatar": "https://github.com/zedt3ster.png",
+    "github": "https://github.com/zedt3ster",
+    "twitter": "https://twitter.com/zedt3ster",
+    "features": ["core"],
+    "role": "Security Frameworks core",
+    "description": "Initial contributor to the Security Frameworks",
+    "company": "Sigma Prime"
+  },
+  "nftdreww": {
+    "name": "NFTDreww",
+    "displayName": "NFTDreww",
     "avatar": "https://pbs.twimg.com/profile_images/1589726471249174536/pEqaw6FO_400x400.png",
-    "github": null,
+    "github": "https://github.com/NFTDreww",
     "twitter": "https://twitter.com/nft_dreww",
-    "bio": "Community manager and security enthusiast"
+    "features": ["steward"],
+    "role": "Community Management",
+    "description": "Managing and curating the Community Management framework",
+    "company": "Community DAO"
   },
   "robert": {
     "name": "Robert MacWha",
@@ -23,6 +52,28 @@
     "github": "https://github.com/Robert-MacWha",
     "twitter": null,
     "website": "https://robertmacwha.com",
-    "bio": "Full-stack developer and security enthusiast"
+    "features": ["core"],
+    "role": "Security Frameworks webs collaborator",
+    "description": "Full-stack developer and security enthusiast",
+    "company": "Skylock"
+  },
+  "tebayoso": {
+    "name": "tebayoso",
+    "displayName": "tebayoso",
+    "avatar": "https://github.com/tebayoso.png",
+    "github": "https://github.com/tebayoso",
+    "twitter": "https://twitter.com/tebayoso",
+    "features": ["featured"],
+    "description": "Initial implementation of tag filtering",
+    "company": "The Red Guild"
+  },
+  "engn33r": {
+    "name": "engn33r",
+    "displayName": "engn33r",
+    "avatar": "https://github.com/engn33r.png",
+    "github": "https://github.com/engn33r",
+    "twitter": "https://twitter.com/engn33r",
+    "features": ["featured"],
+    "description": "Signing scheme content"
   }
 }

theme/contributors/contributorsindex.js

@@ -1,19 +1,28 @@
 // This file is auto-generated by the tags preprocessor
 const contributorsIndex = {
-  "NFT_Dreww.eth": {
+  "NFTDreww": {
     "chapters": [
       "community-management/discord.html"
     ],
+    "github": "https://github.com/NFTDreww",
     "avatar": "https://pbs.twimg.com/profile_images/1589726471249174536/pEqaw6FO_400x400.png",
-    "twitter": "https://twitter.com/nft_dreww"
+    "twitter": "https://twitter.com/nft_dreww",
+    "company": "Community DAO",
+    "role": "Community Management",
+    "description": "Managing and curating the Community Management framework",
+    "features": ["steward"]
   },
   "Robert": {
     "chapters": [
       "community-management/index.html"
     ],
     "github": "https://github.com/Robert-MacWha",
     "avatar": "https://github.com/Robert-MacWha.png",
-    "website": "https://robertmacwha.com"
+    "website": "https://robertmacwha.com",
+    "company": "Skylock",
+    "role": "Security Frameworks webs collaborator",
+    "description": "Full-stack developer and security enthusiast",
+    "features": ["core"]
   },
   "matta": {
     "chapters": [
@@ -27,6 +36,48 @@ const contributorsIndex = {
     "github": "https://github.com/mattaereal",
     "avatar": "https://github.com/mattaereal.png",
     "twitter": "https://twitter.com/mattaereal",
-    "website": "https://theredguild.org"
+    "website": "https://theredguild.org",
+    "company": "The Red Guild | SEAL",
+    "role": "Security Frameworks Lead",
+    "description": "Initiative lead and maintainer of the Security Frameworks",
+    "features": ["lead"]
+  },
+  "engn33r": {
+    "chapters": [],
+    "github": "https://github.com/engn33r",
+    "avatar": "https://github.com/engn33r.png",
+    "twitter": "https://twitter.com/engn33r",
+    "description": "Signing scheme content",
+    "features": ["featured"]
+  },
+  "Fredrik Svantes": {
+    "chapters": [],
+    "github": "https://github.com/fredriksvantes",
+    "avatar": "https://github.com/fredriksvantes.png",
+    "twitter": "https://twitter.com/fredriksvantes",
+    "website": "https://fredriksvantes.com",
+    "company": "Ethereum Foundation",
+    "role": "Security Frameworks core",
+    "description": "Initial contributor to the Security Frameworks",
+    "features": ["core"]
+  },
+  "tebayoso": {
+    "chapters": [],
+    "github": "https://github.com/tebayoso",
+    "avatar": "https://github.com/tebayoso.png",
+    "twitter": "https://twitter.com/tebayoso",
+    "company": "The Red Guild",
+    "description": "Initial implementation of tag filtering",
+    "features": ["featured"]
+  },
+  "zedt3ster": {
+    "chapters": [],
+    "github": "https://github.com/zedt3ster",
+    "avatar": "https://github.com/zedt3ster.png",
+    "twitter": "https://twitter.com/zedt3ster",
+    "company": "Sigma Prime",
+    "role": "Security Frameworks core",
+    "description": "Initial contributor to the Security Frameworks",
+    "features": ["core"]
   }
 };