quackage 1.0.45 → 1.0.47

package/.quackage-templates.json

@@ -203,9 +203,9 @@
         "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"
+                "Hash": "FableServiceQUACKAGESCOPEjs",
+                "Path": "Fable-Service-QUACKAGESCOPE.js",
+                "Content": "const libFableServiceProviderBase = require('fable-serviceproviderbase');\n\nconst _DefaultOptions = (\n\t{\n\t});\n\nclass FableService{~PascalCaseIdentifier:Record.Scope~} extends libFableServiceProviderBase\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\tconst 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{~PascalCaseIdentifier:Record.Scope~};\nmodule.exports.default_configuration = _DefaultOptions;\n"
             }
         ]
     },

package/README.md

@@ -9,6 +9,12 @@ This standardizes:
 1. Building an app for a browser
 2. Transpiling an app for ... older browsers
 3. Running unit tests
+4. Copying files around
+5. Managing package.json files in a standad way
+6. Assembling folders of JSON views into v7iew classes
+7. Boilerplate files and file structures
+8. Pulling documentation from codebases
+9. Compiling data description language files into their downstream parts (manifests, sql generation, documentation, etc.)
 
 ## Usage
 

package/debug/Harness.js

@@ -5,4 +5,4 @@ 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', 'dgen', 'output_docs', '--source', '/Users/stevenvelozo/Code/retold/modules/pict/pict/source/']);
+libQuackage.run(['node', 'Harness.js', 'dgen', 'output_docs', '--source', `${__dirname}/../source/`]);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quackage",
-    "version": "1.0.45",
+    "version": "1.0.47",
     "description": "Building.  Testing.  Quacking.  Reloading.",
     "main": "source/Quackage-CLIProgram.js",
     "scripts": {
@@ -55,17 +55,18 @@
         "browserify": "^17.0.0",
         "chai": "4.3.10",
         "copy-files-from-to": "^3.11.0",
-        "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",
+        "indoctrinate": "^1.0.4",
         "jsdoc": "^4.0.5",
         "mocha": "10.4.0",
         "npm-check-updates": "^18.0.1",
         "nyc": "^15.1.0",
-        "pict-service-commandlineutility": "^1.0.16",
+        "pict-docuserve": "^0.0.4",
+        "pict-service-commandlineutility": "^1.0.17",
         "vinyl-buffer": "^1.0.1",
         "vinyl-source-stream": "^2.0.0"
     },

package/source/Default-Quackage-Configuration.json

@@ -59,7 +59,10 @@
 
 		"coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec",
 
-		"build": "npx quack build"
+		"build": "npx quack build",
+
+		"docs": "npx quack prepare-docs ./docs -d ./modules",
+		"docs-serve": "npx quack docs-serve ./docs"
 	},
 	"LuxuryPackageScripts":
 	{

package/source/Quackage-CLIProgram.js

@@ -37,7 +37,18 @@ let _Pict = new libCLIProgram(
 		// Boilerplate file management
 		require('./commands/Quackage-Command-Boilerplate.js'),
 		require('./commands/Quackage-Command-ListTemplates.js'),
-		require('./commands/Quackage-Command-BuildTemplates.js')
+		require('./commands/Quackage-Command-BuildTemplates.js'),
+
+		// Stricture
+		require('./commands/stricture//Quackage-Command-Stricture-Compile.js'),
+		require('./commands/stricture/Quackage-Command-StrictureLegacy.js'),
+
+		// Documentation preparation (indoctrinate + pict-docuserve)
+		require('./commands/Quackage-Command-Indoctrinate.js'),
+		require('./commands/Quackage-Command-IndoctrinateIndex.js'),
+		require('./commands/Quackage-Command-DocuserveInject.js'),
+		require('./commands/Quackage-Command-PrepareDocs.js'),
+		require('./commands/Quackage-Command-DocuserveServe.js')
 	]);
 
 // Instantiate the file persistence service

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

@@ -10,7 +10,6 @@ class QuackageCommandBuild extends libCommandLineCommand
 		this.options.CommandKeyword = 'build';
 		this.options.Description = 'Build your npm module into a dist folder';
 
-		// Auto add the command on initialization
 		this.addCommand();
 	}
 

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

@@ -17,7 +17,6 @@ class QuackageCommandBuildTemplates extends libCommandLineCommand
 
 		this.templateSets = {};
 
-		// Auto add the command on initialization
 		this.addCommand();
 	}
 

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

@@ -11,6 +11,7 @@ class QuackageCommandCopyFilesFromTo extends libCommandLineCommand
 		this.options.Description = 'Copy files to a stage location.';
 
 		this.options.Aliases.push('copy');
+		this.options.Aliases.push('cp');
 
 		// Auto add the command on initialization
 		this.addCommand();

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

@@ -0,0 +1,90 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandDocuserveInject extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'docuserve-inject';
+		this.options.Description = 'Inject pict-docuserve application assets into a documentation folder for static hosting.';
+
+		this.options.CommandArguments.push({ Name: '<docs_folder>', Description: 'Target documentation folder to inject docuserve assets into.' });
+
+		this.options.Aliases.push('docuserve');
+		this.options.Aliases.push('inject-docs');
+
+		this.addCommand();
+	}
+
+	onRunAsync(fCallback)
+	{
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || '.');
+
+		this.log.info(`Injecting pict-docuserve assets into documentation folder...`);
+		this.log.info(`  Target: ${tmpDocsFolder}`);
+
+		// Ensure the output folder exists
+		if (!libFS.existsSync(tmpDocsFolder))
+		{
+			this.log.info(`Creating documentation folder [${tmpDocsFolder}]...`);
+			libFS.mkdirSync(tmpDocsFolder, { recursive: true });
+		}
+
+		// 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,
+			[
+				'inject',
+				tmpDocsFolder
+			],
+			{ cwd: this.fable.AppData.CWD },
+			(pError) =>
+			{
+				if (pError)
+				{
+					return fCallback(pError);
+				}
+
+				// Ensure .nojekyll exists for GitHub Pages compatibility
+				let tmpNoJekyllPath = libPath.join(tmpDocsFolder, '.nojekyll');
+				libFS.writeFileSync(tmpNoJekyllPath, '');
+				this.log.info(`Wrote .nojekyll to [${tmpNoJekyllPath}]`);
+
+				return 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 = QuackageCommandDocuserveInject;

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

@@ -0,0 +1,79 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandDocuserveServe extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		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.CommandOptions.push({ Name: '-p, --port [port]', Description: 'Port to serve on.', Default: '3333' });
+
+		this.options.Aliases.push('serve-docs');
+
+		this.addCommand();
+	}
+
+	onRunAsync(fCallback)
+	{
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || '.');
+		let tmpPort = this.CommandOptions.port || '3333';
+
+		this.log.info(`Serving documentation with pict-docuserve...`);
+		this.log.info(`  Docs folder: ${tmpDocsFolder}`);
+		this.log.info(`  Port: ${tmpPort}`);
+
+		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,
+			[
+				'serve',
+				tmpDocsFolder,
+				'--port', tmpPort
+			],
+			{ 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 = QuackageCommandDocuserveServe;

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

@@ -4,7 +4,9 @@ const libOS = require('os');
 const libFS = require('fs');
 const libPath = require('path');
 
-const libJSDocWrapper = require('./Quackage-JSDoc-Wrapper.js');
+const { spawn } = require('node:child_process');
+const { createWriteStream } = require('node:fs');
+const { once } = require('node:events');
 
 class QuackageCommandGenerateDocumentation extends libCommandLineCommand
 {
@@ -28,6 +30,138 @@ class QuackageCommandGenerateDocumentation extends libCommandLineCommand
 		this.addCommand();
 	}
 
+	/**
+	 * Run the real JSDoc CLI with -X and return parsed JSON (like `jsdoc -X`).
+	 *
+	 * @param {string[]|string} pFilesArray     Files/dirs/globs to parse. (e.g., ['src'] or 'src')
+	 * @param {string|null}     pJSDocConfig    Path to jsdoc config file (e.g., 'jsdoc.conf.json') or null.
+	 * @param {boolean}         pSuppressOutput     Suppress non-essential CLI output (defaults true).
+	 * @param {string}          pProcessCWD       Working directory (defaults process.cwd()).
+	 * @param {number}          pTimoutMs Kill the process after N ms (0 = no timeout).
+	 * @param {string[]}        pCLIExtraArguments Extra CLI args (e.g., ['--recurse']).
+	 * @param {string|null}     pOutputFile   If set, also write raw JSON to this file.
+	 * @returns {Promise<any>}            Parsed JSON doclets.
+	 */
+	runJSDocCLI(pFilesArray, pJSDocConfig, pSuppressOutput, pProcessCWD, pTimoutMs, pCLIExtraArguments, pOutputFile, fCallback)
+	{
+		if (!pFilesArray || (Array.isArray(pFilesArray) && pFilesArray.length === 0)) pFilesArray = ['.'];
+		if (typeof pFilesArray === 'string') pFilesArray = [pFilesArray];
+		if (typeof pJSDocConfig === 'undefined') pJSDocConfig = null;
+		if (typeof pSuppressOutput === 'undefined') pSuppressOutput = true;
+		if (!pProcessCWD) pProcessCWD = process.cwd();
+		if (!pTimoutMs) pTimoutMs = 0;
+		if (!Array.isArray(pCLIExtraArguments)) pCLIExtraArguments = [];
+		if (typeof pOutputFile === 'undefined') pOutputFile = null;
+
+		return new Promise((resolve, reject) =>
+		{
+			// Resolve local CLI in the node_modules folder and try that; fallback to `npx jsdoc` if this fails
+			let tmpCommandPath, tmpCommandArguments;
+			let tmpExecuteUsingNode = true;
+			try
+			{
+				const jsdocBin = require.resolve('jsdoc/jsdoc.js', { paths: [pProcessCWD] });
+				tmpCommandPath = process.execPath;
+				tmpCommandArguments = [
+					jsdocBin,
+					'-X',
+					...(pSuppressOutput ? ['--quiet'] : []),
+					...(pJSDocConfig ? ['-c', pJSDocConfig] : []),
+					...pCLIExtraArguments,
+					...pFilesArray,
+				];
+			}
+			catch
+			{
+				tmpExecuteUsingNode = false;
+				tmpCommandPath = process.platform === 'win32' ? 'npx.cmd' : 'npx';
+				tmpCommandArguments = [
+					'-y',
+					'jsdoc',
+					'-X',
+					...(pSuppressOutput ? ['--quiet'] : []),
+					...(pJSDocConfig ? ['-c', pJSDocConfig] : []),
+					...pCLIExtraArguments,
+					...pFilesArray,
+				];
+			}
+
+			const tmpChild = spawn(tmpCommandPath, tmpCommandArguments, { cwd: pProcessCWD, stdio: ['ignore', 'pipe', 'pipe'] });
+
+			let tmpStdOut = '';
+			let tmpStdErr = '';
+
+			const tmpTimeoutSignal = pTimoutMs > 0 ? setTimeout(() => tmpChild.kill('SIGKILL'), pTimoutMs) : null;
+
+			let tmpOutputStream = null;
+			if (pOutputFile)
+			{
+				tmpOutputStream = createWriteStream(pOutputFile, { encoding: 'utf8' });
+			}
+
+			tmpChild.stdout.setEncoding('utf8');
+			tmpChild.stderr.setEncoding('utf8');
+
+			tmpChild.stdout.on('data',
+				(pChunk) =>
+				{
+					tmpStdOut += pChunk;
+					if (tmpOutputStream) tmpOutputStream.write(pChunk);
+				});
+			tmpChild.stderr.on('data',
+				(pChunk) =>
+				{
+					tmpStdErr += pChunk;
+				});
+
+			const finalize = async (pProcessReturnCode) =>
+			{
+				if (tmpTimeoutSignal)
+				{
+					clearTimeout(tmpTimeoutSignal);
+				}
+
+				if (tmpOutputStream)
+				{
+					await new Promise(
+						(pResult) =>
+						{
+							tmpOutputStream.end(pResult)
+						});
+				}
+				if (pProcessReturnCode !== 0)
+				{
+					const tmpExecutionMethod = tmpExecuteUsingNode ? 'node jsdoc/jsdoc.js' : 'npx jsdoc';
+					const tmpError = new Error(`JSDoc exited with code ${pProcessReturnCode} (${tmpExecutionMethod}).\n${tmpStdErr || ''}`);
+					tmpError.code = pProcessReturnCode;
+					tmpError.stderr = tmpStdErr;
+					tmpError.stdout = tmpStdOut;
+					reject(tmpError);
+					return fCallback(tmpError);
+				}
+				try
+				{
+					resolve(JSON.parse(tmpStdOut));
+				}
+				catch (pError)
+				{
+					const tmpStdOutHead = tmpStdOut.slice(0, 3000);
+					const tmpError = new Error(
+						`Failed to parse JSDoc JSON. Ensure --quiet and plugins don't write to stdout.\n` +
+						`Parse error: ${pError.message}\n--- stdout (head) ---\n${tmpStdOutHead}`
+					);
+					tmpError.stderr = tmpStdErr;
+					tmpError.stdout = tmpStdOut;
+					reject(tmpError);
+				}
+				return fCallback();
+			};
+
+			tmpChild.on('close', finalize);
+			tmpChild.on('error', reject);
+		});
+	}
+
 	onRunAsync(fCallback)
 	{
 		const libFilePersistence = this.services.FilePersistence;
@@ -89,7 +223,7 @@ class QuackageCommandGenerateDocumentation extends libCommandLineCommand
 			function (fNext)
 			{
 				this.log.info(`Documentation Phase 1: Gathering documentation metadata...`);
-				libJSDocWrapper(tmpOperationState.SourceCodeFolderJSDocParameter, null, false, './', 60000, [], tmpOperationState.JSDocOutputPath, fNext);
+				this.runJSDocCLI(tmpOperationState.SourceCodeFolderJSDocParameter, null, false, './', 60000, [], tmpOperationState.JSDocOutputPath, fNext);
 			}.bind(this));
 
 		tmpAnticipate.anticipate(

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

@@ -0,0 +1,88 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandIndoctrinate extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'indoctrinate';
+		this.options.Description = 'Generate a documentation catalog from module documentation folders using indoctrinate.';
+
+		this.options.CommandArguments.push({ Name: '<docs_folder>', Description: 'The documentation output folder for the generated catalog.' });
+
+		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' });
+		this.options.CommandOptions.push({ Name: '-g, --github_org [github_org]', Description: 'GitHub organization for raw URLs (defaults to stevenvelozo).', Default: 'stevenvelozo' });
+
+		this.options.Aliases.push('indoc');
+
+		this.addCommand();
+	}
+
+	onRunAsync(fCallback)
+	{
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || '.');
+		let tmpDirectoryRoot = this.CommandOptions.directory_root || this.fable.AppData.CWD;
+		let tmpBranch = this.CommandOptions.branch || 'master';
+		let tmpGitHubOrg = this.CommandOptions.github_org || 'stevenvelozo';
+		let tmpOutputFile = libPath.join(tmpDocsFolder, 'retold-catalog.json');
+
+		this.log.info(`Generating documentation catalog with indoctrinate...`);
+		this.log.info(`  Module root: ${tmpDirectoryRoot}`);
+		this.log.info(`  Output: ${tmpOutputFile}`);
+
+		// Ensure the output folder exists
+		if (!libFS.existsSync(tmpDocsFolder))
+		{
+			this.log.info(`Creating documentation folder [${tmpDocsFolder}]...`);
+			libFS.mkdirSync(tmpDocsFolder, { recursive: true });
+		}
+
+		// Find the indoctrinate binary
+		let tmpIndoctrinateLocation = this.resolveExecutable('indoctrinate');
+		if (!tmpIndoctrinateLocation)
+		{
+			return fCallback(new Error(`Could not find indoctrinate.  Make sure it is installed (npm install indoctrinate).`));
+		}
+
+		this.log.info(`Found indoctrinate at [${tmpIndoctrinateLocation}]`);
+
+		this.fable.QuackageProcess.execute(
+			tmpIndoctrinateLocation,
+			[
+				'generate_catalog',
+				'-d', tmpDirectoryRoot,
+				'-o', tmpOutputFile,
+				'-b', tmpBranch,
+				'-g', tmpGitHubOrg
+			],
+			{ 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 = QuackageCommandIndoctrinate;

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

@@ -0,0 +1,83 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandIndoctrinateIndex extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'indoctrinate-index';
+		this.options.Description = 'Generate a lunr keyword search index from module documentation using indoctrinate.';
+
+		this.options.CommandArguments.push({ Name: '<docs_folder>', Description: 'The documentation output folder for the generated keyword index.' });
+
+		this.options.CommandOptions.push({ Name: '-d, --directory_root [directory_root]', Description: 'Root directory to scan for modules (defaults to CWD).', Default: '' });
+
+		this.options.Aliases.push('indoc-index');
+		this.options.Aliases.push('keyword-index');
+
+		this.addCommand();
+	}
+
+	onRunAsync(fCallback)
+	{
+		let tmpDocsFolder = libPath.resolve(this.ArgumentString || '.');
+		let tmpDirectoryRoot = this.CommandOptions.directory_root || this.fable.AppData.CWD;
+		let tmpOutputFile = libPath.join(tmpDocsFolder, 'retold-keyword-index.json');
+
+		this.log.info(`Generating keyword search index with indoctrinate...`);
+		this.log.info(`  Module root: ${tmpDirectoryRoot}`);
+		this.log.info(`  Output: ${tmpOutputFile}`);
+
+		// Ensure the output folder exists
+		if (!libFS.existsSync(tmpDocsFolder))
+		{
+			this.log.info(`Creating documentation folder [${tmpDocsFolder}]...`);
+			libFS.mkdirSync(tmpDocsFolder, { recursive: true });
+		}
+
+		// Find the indoctrinate binary
+		let tmpIndoctrinateLocation = this.resolveExecutable('indoctrinate');
+		if (!tmpIndoctrinateLocation)
+		{
+			return fCallback(new Error(`Could not find indoctrinate.  Make sure it is installed (npm install indoctrinate).`));
+		}
+
+		this.log.info(`Found indoctrinate at [${tmpIndoctrinateLocation}]`);
+
+		this.fable.QuackageProcess.execute(
+			tmpIndoctrinateLocation,
+			[
+				'generate_keyword_index',
+				'-d', tmpDirectoryRoot,
+				'-o', tmpOutputFile
+			],
+			{ 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 = QuackageCommandIndoctrinateIndex;

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

@@ -12,6 +12,7 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 		this.options.Description = 'List the available boilerplate template filesets in your user, local and the built-in .quackage-templates.json file(s).';
 
 		this.options.Aliases.push('list');
+		this.options.Aliases.push('ls');
 		this.options.Aliases.push('lt');
 
 		this.fable.TemplateProvider.addTemplate('PrototypePackage', JSON.stringify(this.pict.ProgramConfiguration, null, 4));