quackage 1.0.47 → 1.0.48

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quackage",
-    "version": "1.0.47",
+    "version": "1.0.48",
     "description": "Building.  Testing.  Quacking.  Reloading.",
     "main": "source/Quackage-CLIProgram.js",
     "scripts": {
@@ -65,8 +65,8 @@
         "mocha": "10.4.0",
         "npm-check-updates": "^18.0.1",
         "nyc": "^15.1.0",
-        "pict-docuserve": "^0.0.4",
-        "pict-service-commandlineutility": "^1.0.17",
+        "pict-docuserve": "^0.0.8",
+        "pict-service-commandlineutility": "^1.0.18",
         "vinyl-buffer": "^1.0.1",
         "vinyl-source-stream": "^2.0.0"
     },

package/source/Quackage-CLIProgram.js

@@ -47,6 +47,7 @@ let _Pict = new libCLIProgram(
 		require('./commands/Quackage-Command-Indoctrinate.js'),
 		require('./commands/Quackage-Command-IndoctrinateIndex.js'),
 		require('./commands/Quackage-Command-DocuserveInject.js'),
+		require('./commands/Quackage-Command-DocuservePrepareLocal.js'),
 		require('./commands/Quackage-Command-PrepareDocs.js'),
 		require('./commands/Quackage-Command-DocuserveServe.js')
 	]);

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

@@ -0,0 +1,75 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandDocuservePrepareLocal extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'prepare-local';
+		this.options.Description = 'Copy local pict and pict-docuserve JS bundles into a docs folder for offline use.';
+
+		this.options.CommandArguments.push({ Name: '[docs_folder]', Description: 'The documentation folder to stage local JS bundles into.' });
+
+		this.options.Aliases.push('local-docs');
+		this.options.Aliases.push('stage-local');
+
+		this.addCommand();
+	}
+
+	onRunAsync(fCallback)
+	{
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || './docs');
+
+		this.log.info(`Staging local JS bundles into documentation folder...`);
+		this.log.info(`  Target: ${tmpDocsFolder}`);
+
+		if (!libFS.existsSync(tmpDocsFolder))
+		{
+			return fCallback(new Error(`Documentation folder not found at [${tmpDocsFolder}].`));
+		}
+
+		// Find the pict-docuserve binary
+		let tmpDocuserveLocation = this.resolveExecutable('pict-docuserve');
+		if (!tmpDocuserveLocation)
+		{
+			return fCallback(new Error(`Could not find pict-docuserve.  Make sure it is installed (npm install pict-docuserve).`));
+		}
+
+		this.log.info(`Found pict-docuserve at [${tmpDocuserveLocation}]`);
+
+		this.fable.QuackageProcess.execute(
+			tmpDocuserveLocation,
+			[
+				'prepare-local',
+				tmpDocsFolder
+			],
+			{ cwd: this.fable.AppData.CWD },
+			fCallback
+		);
+	}
+
+	resolveExecutable(pName)
+	{
+		let tmpLocations =
+			[
+				`${this.fable.AppData.CWD}/node_modules/.bin/${pName}`,
+				`${__dirname}/../../../.bin/${pName}`,
+				`${__dirname}/../../node_modules/.bin/${pName}`
+			];
+
+		for (let i = 0; i < tmpLocations.length; i++)
+		{
+			if (libFS.existsSync(tmpLocations[i]))
+			{
+				return tmpLocations[i];
+			}
+		}
+
+		return false;
+	}
+}
+
+module.exports = QuackageCommandDocuservePrepareLocal;

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

@@ -11,7 +11,7 @@ class QuackageCommandDocuserveServe extends libCommandLineCommand
 		this.options.CommandKeyword = 'docs-serve';
 		this.options.Description = 'Serve a documentation folder locally using pict-docuserve.';
 
-		this.options.CommandArguments.push({ Name: '<docs_folder>', Description: 'The documentation folder to serve.' });
+		this.options.CommandArguments.push({ Name: '[docs_folder]', Description: 'The documentation folder to serve.' });
 
 		this.options.CommandOptions.push({ Name: '-p, --port [port]', Description: 'Port to serve on.', Default: '3333' });
 
@@ -22,7 +22,7 @@ class QuackageCommandDocuserveServe extends libCommandLineCommand
 
 	onRunAsync(fCallback)
 	{
-		let tmpDocsFolder = libPath.resolve(this.ArgumentString || '.');
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || './docs');
 		let tmpPort = this.CommandOptions.port || '3333';
 
 		this.log.info(`Serving documentation with pict-docuserve...`);

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

@@ -11,7 +11,7 @@ class QuackageCommandPrepareDocs extends libCommandLineCommand
 		this.options.CommandKeyword = 'prepare-docs';
 		this.options.Description = 'Prepare documentation: generate catalog, build keyword index and inject pict-docuserve assets.';
 
-		this.options.CommandArguments.push({ Name: '<docs_folder>', Description: 'The documentation folder to prepare.' });
+		this.options.CommandArguments.push({ Name: '[docs_folder]', Description: 'The documentation folder to prepare.' });
 
 		this.options.CommandOptions.push({ Name: '-d, --directory_root [directory_root]', Description: 'Root directory to scan for modules (defaults to CWD).', Default: '' });
 		this.options.CommandOptions.push({ Name: '-b, --branch [branch]', Description: 'Git branch for GitHub raw URLs (defaults to master).', Default: 'master' });
@@ -25,7 +25,7 @@ class QuackageCommandPrepareDocs extends libCommandLineCommand
 
 	onRunAsync(fCallback)
 	{
-		let tmpDocsFolder = libPath.resolve(this.ArgumentString || '.');
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || './docs');
 		let tmpDirectoryRoot = this.CommandOptions.directory_root || this.fable.AppData.CWD;
 		let tmpBranch = this.CommandOptions.branch || 'master';
 		let tmpGitHubOrg = this.CommandOptions.github_org || 'stevenvelozo';