quackage 1.0.42 → 1.0.43

package/.quackage-templates.json

@@ -196,5 +196,29 @@
                 "Content": "#!/usr/bin/env node\n\nlet libCLIProgram = require('./CLI-Program.js');\n\nlibCLIProgram.run();"
             }
         ]
+    },
+    "fableservice": {
+        "Hash": "fableservice",
+        "Name": "Fableservice",
+        "Description": "A template set for fableservice ...",
+        "Files": [
+            {
+                "Hash": "FableServicejs",
+                "Path": "Fable-Service.js",
+                "Content": "const FableServiceProviderBase = require('fable-serviceproviderbase');\n\nconst _DefaultOptions = (\n\t{\n\t});\n\nclass FableService extends FableServiceProviderBase\n{\n\t/**\n\t * @param {import('fable')} pFable - The fable instance.\n\t * @param {Object<String, any>} [pOptions] - The options for the client.\n\t * @param {String} [pServiceHash] - A service hash for the fable service.\n\t */\n\tconstructor(pFable, pOptions, pServiceHash)\n\t{\n\t\tlet tmpOptions = Object.assign({}, _DefaultOptions, pOptions);\n\t\tsuper(pFable, tmpOptions, pServiceHash);\n\t}\n\n\tdoSomething()\n\t{\n\t\treturn true;\n\t}\n}\n\nmodule.exports = FableService;\n\nmodule.exports.default_configuration = _DefaultOptions;\n"
+            }
+        ]
+    },
+    "pictwebapp": {
+        "Hash": "pictwebapp",
+        "Name": "Pictwebapp",
+        "Description": "A template set for pictwebapp ...",
+        "Files": [
+            {
+                "Hash": "packagejson",
+                "Path": "package.json",
+                "Content": "{\n  \"name\": \"pictwebapp\",\n  \"version\": \"1.0.0\",\n  \"main\": \"source/Pict-Web-Application.js\",\n  \"scripts\": {\n    \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n  },\n  \"author\": \"\",\n  \"license\": \"MIT\",\n  \"description\": \"\"\n}\n"
+            }
+        ]
     }
 }

package/debug/Harness.js

@@ -3,10 +3,10 @@ console.log('Fancy debug harness here.  Shame if it would get quacked.');
 let libQuackage = require('../source/Quackage-CLIProgram.js');
 
 //libQuackage.run(['node', 'Harness.js', 'bp', 'pictunittest']);
-//libQuackage.run(['node', 'Harness.js', 'lint']);
+libQuackage.run(['node', 'Harness.js', 'lint']);
 
 //libQuackage.run(['node', 'Harness.js', 'csvcheck', 'testdata/airports.csv', '-c']);
-libQuackage.run(['node', 'Harness.js', 'csvtransform', 'testdata/airports.csv', '-x', '-g', 'HDSS-BI-{~D:Record.iata~}-{~D:Record.name~}']);
+//libQuackage.run(['node', 'Harness.js', 'csvtransform', 'testdata/airports.csv', '-x', '-g', 'HDSS-BI-{~D:Record.iata~}-{~D:Record.name~}']);
 //libQuackage.run(['node', 'Harness.js', 'csvtransform', 'testdata/airports.csv', '-x']);
 //libQuackage.run(['node', 'Harness.js', 'csvtransform', 'testdata/airports.csv', '-x', '-m', 'testdata/Airport-Entity-Mapping.json']);
 //libQuackage.run(['node', 'Harness.js', 'csvtransform', 'testdata/airports.csv']);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quackage",
-    "version": "1.0.42",
+    "version": "1.0.43",
     "description": "Building.  Testing.  Quacking.  Reloading.",
     "main": "source/Quackage-CLIProgram.js",
     "scripts": {
@@ -55,21 +55,22 @@
         "browserify": "^17.0.0",
         "chai": "4.3.10",
         "copy-files-from-to": "^3.11.0",
-        "devextreme-showdown": "^1.0.1",
         "docsify-cli": "^4.4.4",
         "gulp": "^4.0.2",
         "gulp-babel": "^8.0.0",
         "gulp-env": "^0.4.0",
         "gulp-sourcemaps": "^3.0.0",
         "gulp-terser": "^2.1.0",
-        "marked": "~15.0.7",
-        "marked-tex-renderer": "^1.1.1",
         "mocha": "10.4.0",
         "npm-check-updates": "^18.0.1",
         "nyc": "^15.1.0",
         "pict-service-commandlineutility": "^1.0.15",
         "vinyl-buffer": "^1.0.1",
-        "vinyl-source-stream": "^2.0.0",
-        "watchify": "^4.0.0"
+        "vinyl-source-stream": "^2.0.0"
+    },
+    "overrides": {
+        "copy-files-from-to": {
+            "yargs": "^16"
+        }
     }
 }

package/source/Quackage-CLIProgram.js

@@ -26,20 +26,14 @@ let _Pict = new libCLIProgram(
 
 		// Gulp build execution (for multiple build targets)
 		require('./commands/Quackage-Command-Build.js'),
-		require('./commands/Quackage-Command-Watch.js'),
 		require('./commands/Quackage-Command-CopyFilesFromTo.js'),
 
-		// Build documentation from a folder, with configuration magic if you want
-		require('./commands/Quackage-Command-BuildDocumentation.js'),
+		// Generate documentation from a folder of code
+		require('./commands/Quackage-Command-GenerateDocumentation.js'),
 
 		// Template handling
 		require('./commands/Quackage-Command-AssembleJSONViews.js'),
 
-		// CSV file handling
-		require('./commands/Quackage-Command-CSVCheck.js'),
-		require('./commands/Quackage-Command-CSVTransform.js'),
-		require('./commands/Quackage-Command-CSVIntersect.js'),
-
 		// Boilerplate file management
 		require('./commands/Quackage-Command-Boilerplate.js'),
 		require('./commands/Quackage-Command-ListTemplates.js'),

package/source/commands/Quackage-Command-GenerateDocumentation.js

@@ -0,0 +1,52 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandGenerateDocumentation extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'generate-documentation';
+		this.options.Description = 'Generate documentation from source files and markdown files';
+
+		this.options.CommandArguments.push({ Name: '<output_folder>', Description: 'The folder in which to generate content' });
+
+		this.options.CommandOptions.push({ Name: '-m, --markdown [markdown_documentation_folder]', Description: 'Folder with markdwon documentation; subfolders are okay.', Default: '' });
+		this.options.CommandOptions.push({ Name: '-s, --source [source_code_folder]', Description: 'Folder with javascript source to parse jsdoc from.', Default: false });
+
+		this.options.Aliases.push('dgen');
+
+		this.addCommand();
+	}
+
+	onRunAsync(fCallback)
+	{
+		const libFilePersistence = this.services.FilePersistence;
+
+		this.log.info(`Generating documentation...`);
+
+		let tmpAnticipate = this.fable.newAnticipate();
+
+		this.log.info(`Documentation Phase 0: Preparing configurations...`);
+		this.log.info(`Documentation Phase 1: Gathering documentation metadata...`);
+		this.log.info(`Documentation Phase 2: Gathering code metadata...`);
+		this.log.info(`Documentation Phase 3: Generating structured description...`);
+
+		return tmpAnticipate.wait(
+			function (pError)
+			{
+				if (pError)
+				{
+					return fCallback(pError);
+				}
+
+				this.log.info(`Documentation generation complete.`);
+
+				return fCallback();
+			}.bind(this));
+	};
+}
+
+module.exports = QuackageCommandGenerateDocumentation;

package/debug/Platform.md

@@ -1,3 +0,0 @@
-## The platform is large and capable of holding up
-
-An entire sideshow!

package/debug/documentation-definition.json

@@ -1,53 +0,0 @@
-{
-	"Title": "ACME Documentation",
-
-	"Parts": [
-		{
-			"Title": "Introduction",
-			"GeneratedContentFormatter": "BasicContent",
-			"SourceContentType": "RawMarkdown",
-			"RawMarkdownContent": "# The Introduction\n\n## Things are new?\n\nIt is a multi-line string, markdown. \n\n### Three are new?\n\nanything goes."
-		},
-		{
-			"Title": "Abstract Entities",
-			"GeneratedContentFormatter": "MeadowAbstractEntities",
-			"SourceContentType": "MeadowSchema",
-			"Filters": [
-				{
-					"ForwardLabelMatch": ["model", "entity"]
-				}]
-		},
-		{
-			"Title": "Tables",
-			"GeneratedContentFormatter": "MeadowTableGroups",
-			"SourceContentType": "MeadowSchema",
-			"Filters": [
-				{
-					"ForwardLabelMatch": ["model", "entity"]
-				}]
-		},
-		{
-			"Title": "Example Queries",
-			"GeneratedContentFormatter": "BasicContent",
-			"SourceContentType": "MarkdownContent",
-			"Filters": [
-				{
-					"ForwardLabelMatch": ["model", "example_queries"]
-				}]
-		},
-		{
-			"Title": "All Model Documentation",
-			"GeneratedContentFormatter": "BasicContent",
-			"SourceContentType": "MarkdownContent",
-			"Filters": [
-				{
-					"ForwardLabelMatch": ["model"]
-				}]
-		}],
-	"MeadowEntityCategories":
-	{
-		"Book": { "Group": "Paper"},
-		"BookAuthorJoin": { "Group": "Paper"},
-		"Author": { "Group": "People"}
-	}
-}

package/debug/html/About.html

@@ -1,39 +0,0 @@
-<div class="header">
-	<h1>About Grademaster</h1>
-	<h2>Where understanding and mastery are a weighed on a graduated scale.</h2>
-</div>
-<div class="content">
-	<p>Welcome to GradeMaster, your straightforward solution for managing and tracking student grades. Our web application is designed with simplicity and efficiency in mind, making it the perfect tool for teachers, students, and parents who want to stay informed and organized.</p>
-
-	<h3>Our Mission</h3>
-
-	<p>At GradeMaster, our mission is to streamline the grading process and provide an intuitive platform that fosters transparency and communication between educators, students, and parents. We believe that managing grades should be hassle-free, so you can focus on what truly matters: education.</p>
-
-	<h4>Key Features</h4>
-
-	<ul>
-		<li>Easy Grade Entry: Inputting grades is quick and straightforward, saving teachers valuable time.</li>
-		<li>Real-Time Updates: Students and parents can access up-to-date grades and performance summaries anytime, anywhere.</li>
-		<li>Customizable Reports: Generate detailed reports to monitor progress and identify areas for improvement.</li>
-		<li>Secure and Private: We prioritize your data privacy and security, ensuring that all information is protected.</li>
-	</ul>
-
-	<h3>Who Can Benefit?</h3>
-	<ul>
-		<li>Teachers: Simplify the grading process, save time, and maintain organized records.</li>
-		<li>Students: Stay informed about your academic performance and track your progress.</li>
-		<li>Parents: Keep up-to-date with your child's grades and support their educational journey.</li>
-	</ul>
-
-	<h3>Why Choose GradeMaster?</h3>
-	</ul>
-		<li>User-Friendly Interface: Our clean and intuitive design ensures that you can navigate the application with ease, regardless of your tech-savviness.</li>
-		<li>Reliable Performance: Built with robust technology, GradeMaster is reliable and fast, ensuring a seamless experience.</li>
-		<li>Dedicated Support: Our support team is here to help with any questions or issues you might encounter, ensuring you get the most out of GradeMaster.</li>
-	</ul>
-
-	<h3>Get Started</h3>
-	<p>Ready to simplify your grading process? Sign up today and discover how GradeMaster can make managing grades easier and more efficient than ever.</p>
-	<p>For more information, feel free to contact us or explore our FAQs.</p>
-	<p>Thank you for choosing GradeMaster – where simplicity meets efficiency in grade management.</p>
-</div>

package/debug/html/Legal.html

@@ -1,34 +0,0 @@
-<h1>Legal Stuff (The Fun Version)</h1>
-
-<p>Welcome to the GradeMaster Pro Legal Page! This is where we sprinkle a bit of humor on the otherwise dry and dusty legal stuff. Grab a cup of coffee, sit back, and enjoy our attempt to make legal jargon slightly less snooze-inducing.</p>
-
-<h2>Terms of Use</h2>
-<p>By using GradeMaster Pro, you agree to these terms. If you don’t agree, well, you probably shouldn’t be here. Seriously, we’ve put a lot of thought into this, so trust us, it’s worth agreeing to.</p>
-<ol>
-	<li><strong>Don’t Be Evil</strong>: Stealing grades, hacking into accounts, or impersonating a teacher’s pet is strictly prohibited. Play nice!</li>
-	<li><strong>No Robots Allowed</strong>: Unless you’re a cool, teaching robot from the future, no automated systems or scripts here, folks. We like our users human.</li>
-	<li><strong>Use Responsibly</strong>: GradeMaster Pro is here to make your life easier, not to be used as a tool to procrastinate from actual grading. Use it wisely!</li>
-</ol>
-
-<h2>Privacy Policy</h2>
-<p>We take your privacy very seriously. Like, top-secret, James Bond seriously. Here’s how we handle your info:</p>
-<ul>
-	<li><strong>Data Collection</strong>: We collect only what we need to make your experience awesome. No more, no less.</li>
-	<li><strong>Cookies</strong>: Yes, we use cookies. Not the chocolate chip kind (sadly), but the digital kind to keep things running smoothly.</li>
-	<li><strong>Sharing Information</strong>: We don’t sell your data to third parties. We wouldn’t even know how to price it. Your secrets are safe with us.</li>
-</ul>
-
-<h2>Limitation of Liability</h2>
-<p>Let’s keep this simple: if something goes wrong (like the internet breaking, your computer spontaneously combusting, or an alien invasion), GradeMaster Pro is not liable. We’re here to help, but some things are just out of our control.</p>
-<ol>
-	<li><strong>No Guarantees</strong>: We strive for perfection, but we’re not perfect. If things go awry, we’ll do our best to fix them. No guarantees, but plenty of effort.</li>
-	<li><strong>Damages</strong>: In the rare event that GradeMaster Pro causes you any damages (physical, emotional, or psychological), our liability is limited to making funny jokes and sending good vibes your way.</li>
-</ol>
-
-<h2>Changes to This Agreement</h2>
-<p>We might update these terms occasionally. When we do, we promise to give you a heads-up. No sneaky stuff. Check back here from time to time, or just trust that we’ll keep things reasonable.</p>
-
-<h2>Contact Us</h2>
-<p>Still awake? Impressive! If you have any questions, comments, or jokes to share, feel free to reach out to us at <a href="mailto:legal@grademasterpro.com">legal@grademasterpro.com</a>. We promise to respond faster than you can say “legal mumbo jumbo.”</p>
-
-<p>Thanks for choosing GradeMaster Pro! Remember, with great grading power comes great responsibility. Use it wisely and keep on grading like a pro!</p>