* Add script to generate an empty project glossary file in markdown f…

…ormat. * Fixes bug (missing comma in generated script's metadata) in "NewBoopScript.js".
jrodin · Mar 23, 2021 · 1fee5ee · 1fee5ee
1 parent 775e1b9
commit 1fee5ee
Show file tree

Hide file tree

Showing 2 changed files with 133 additions and 1 deletion.
diff --git a/Scripts/CreateProjectGlossaryMarkdown.js b/Scripts/CreateProjectGlossaryMarkdown.js
@@ -0,0 +1,132 @@
+/**
+	{
+		"api":1,
+		"name":"Create Project Glossary Markdown File",
+		"description":"Type 'help' and run this script for instructions.",
+		"author":"Terry L. Lewis",
+		"icon":"colosseum",
+        "tags":"markdown,glossary",
+        "bias":0.0
+	}
+**/
+
+
+///
+/// Generates a Markdown Glossary file for the project specified in the input parameters.
+/// Run the script with no input text to create the input JSON required by the glossary generator.
+/// Fill in the required values, and re-run the Boop Script to generate the glossary.
+///
+function main(state) {
+
+    try {
+        var options = {};
+        if (state.text.trim().toLowerCase() === "help"){
+            state.fullText = getHelpText();
+        } else if (state.fullText.trim() === ""){
+            state.fullText = JSON.stringify(getDefaultParameters());
+        } else {
+            options = JSON.parse(state.text);
+
+            var indexEntries = "0ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+            var header = getHeader();
+            var sectionTemplate = getSectionTemplate();
+            var sampleEntries = getSampleEntries();
+
+            var index = "\r\n";
+            var body = "";
+            for (var x = 0; x < indexEntries.length; x++)
+            {
+                var c = indexEntries.charAt(x);
+
+                // Build Index
+                index = index + "[" + c + "](#" + c.toLowerCase() + ") "
+                if (c === "H" || c === "Q" || c === "Z") index = index + "\r\n";
+
+                // Build Sections
+                var section = sectionTemplate.replace("{idx}", c)
+                if (c === "E" && options.includeSamples){
+                    section = section.replace("{samples}", sampleEntries);
+                } else {
+                    section = section.replace("{samples}", "");
+                }
+                body = body + section
+            }
+
+            // Put it all together
+            var glossary = header + index + body;
+
+            state.fullText = glossary.replace("{projectName}", options.projectName);
+        }
+	}
+	catch(error) {
+        options = getDefaultParameters();
+        options.error = error.toString();
+        state.fullText = JSON.stringify(options);
+        //state.text = error.toString()
+		state.postError(error.toString())
+	}
+
+}
+
+function getDefaultParameters(){
+    return {
+        projectName: "Project Name",
+        includeSamples: false
+    }
+}
+
+function getHeader(){
+    return `
+# {projectName}
+## Glossary Of Terms
+`.trim()
+}
+
+function getSectionTemplate(){
+    return `
+## {idx}
+{samples}
+[Back to Top](#glossary-of-terms) 
+
+---
+`;
+}
+
+function getSampleEntries() {
+    return `
+
+### Example Entry
+This example provides a template for how glossary entries should be formatted.
+
+### Example Entry 2
+Sample definition of Example Entry 2. See also [Example Entry](#example-entry).
+
+`;
+}
+
+function getHelpText(){
+    return `
+Create Project Glossary Markdown File
+=====================================
+
+This script takes a JSON input string and reads its
+properties to produce an empty Glossary file. Use this
+when starting a new project to ensure that everyone on
+the team knows the proper definitions of the jargon used.
+
+Running the script without an input string generates the 
+required JSON structure.
+
+You can delete all but the JSON below and run the script 
+to see example results.
+
+Input structure:
+
+{
+    "projectName" : "--Project Name Here--",
+    "includeSamples" : false
+}
+
+The "includeSamples" parameter is optional and defaults to [false].
+`;
+}
diff --git a/Scripts/NewBoopScript.js b/Scripts/NewBoopScript.js
@@ -26,7 +26,7 @@ var script = `
 		"description":"What does your script do?",
 		"author":"Whooooooo are you?",
 		"icon":"broom",
-        "tags":"place,tags,here"
+        "tags":"place,tags,here",
         "bias":0.0
 	}
 **/