quackage 1.0.64 → 1.0.66

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quackage",
-    "version": "1.0.64",
+    "version": "1.0.66",
     "description": "Building.  Testing.  Quacking.  Reloading.",
     "main": "source/Quackage-CLIProgram.js",
     "scripts": {
@@ -60,14 +60,14 @@
         "gulp-env": "^0.4.0",
         "gulp-sourcemaps": "^3.0.0",
         "gulp-terser": "^2.1.0",
-        "indoctrinate": "^1.0.8",
+        "indoctrinate": "^1.0.9",
         "jsdoc": "^4.0.5",
         "mocha": "10.4.0",
         "npm-check-updates": "^18.0.1",
         "nyc": "^15.1.0",
         "pict-docuserve": "^0.0.32",
         "pict-service-commandlineutility": "^1.0.19",
-        "retold-harness": "^1.1.2",
+        "retold-harness": "^1.1.6",
         "vinyl-buffer": "^1.0.1",
         "vinyl-source-stream": "^2.0.0"
     },

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

@@ -16,6 +16,7 @@ class QuackageCommandPrepareDocs extends libCommandLineCommand
 		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.CommandOptions.push({ Name: '-x, --excluded_modules [excluded_modules]', Description: 'Comma-separated list of module names to exclude from the catalog and keyword index.  Merged with any ExcludedModules list in indoctrinate\'s loaded config file (e.g. .indoctrinate.config.json).', Default: '' });
 
 		this.options.Aliases.push('docs');
 		this.options.Aliases.push('prep-docs');
@@ -30,6 +31,15 @@ class QuackageCommandPrepareDocs extends libCommandLineCommand
 		let tmpBranch = this.CommandOptions.branch || 'master';
 		let tmpGitHubOrg = this.CommandOptions.github_org || 'stevenvelozo';
 
+		// Exclusion list passthrough. When set, both indoctrinate sub-commands
+		// get -x <list>.  Comma-separated; indoctrinate will merge this with
+		// any ExcludedModules entries in its loaded config file.
+		let tmpExcludedModulesArgs = [];
+		if (this.CommandOptions.excluded_modules && this.CommandOptions.excluded_modules.length > 0)
+		{
+			tmpExcludedModulesArgs = ['-x', this.CommandOptions.excluded_modules];
+		}
+
 		this.log.info(`Preparing documentation in [${tmpDocsFolder}]...`);
 
 		// Ensure the output folder exists
@@ -81,7 +91,7 @@ class QuackageCommandPrepareDocs extends libCommandLineCommand
 						'-o', tmpCatalogFile,
 						'-b', tmpBranch,
 						'-g', tmpGitHubOrg
-					],
+					].concat(tmpExcludedModulesArgs),
 					{ cwd: this.fable.AppData.CWD },
 					fNext
 				);
@@ -98,7 +108,7 @@ class QuackageCommandPrepareDocs extends libCommandLineCommand
 						'generate_keyword_index',
 						'-d', tmpDirectoryRoot,
 						'-o', tmpKeywordIndexFile
-					].concat(tmpExtraScanArgs),
+					].concat(tmpExtraScanArgs).concat(tmpExcludedModulesArgs),
 					{ cwd: this.fable.AppData.CWD },
 					fNext
 				);

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

@@ -19,7 +19,7 @@ class QuackageCommandBuild extends libCommandLineCommand
 	onRunAsync(fCallback)
 	{
 		// See if the user passed in a filter for tests
-		let tmpTestGrepExpression = (typeof(this.CommandOptions.search_expression) === 'undefined') ? false : this.CommandOptions.search_expression;
+		let tmpTestGrepExpression = (typeof(this.CommandOptions.grep) === 'undefined') ? false : this.CommandOptions.grep;
 
 		let tmpCWDMochaLocation = `${this.fable.AppData.CWD}/node_modules/.bin/mocha`;
 		let tmpRelativePackageMochaLocation = `${__dirname}/../../../.bin/mocha`;

package/test/Quackage_tests.js

@@ -210,6 +210,38 @@ suite
 						Expect(tmpClass.prototype.onRunAsync).to.be.a('function');
 					}
 				);
+
+				test
+				(
+					'RunMochaTests command should have a --grep option registered.',
+					function()
+					{
+						let tmpCommand = getCommand('run-mocha-tests');
+						Expect(tmpCommand).to.be.an('object');
+
+						// Verify the --grep option is registered on the commander command
+						let tmpGrepOption = tmpCommand.options.find((pOpt) => pOpt.long === '--grep');
+						Expect(tmpGrepOption).to.be.an('object', 'Expected --grep option to be registered on run-mocha-tests command');
+						Expect(tmpGrepOption.short).to.equal('-g');
+						Expect(tmpGrepOption.optional).to.equal(true, 'grep should accept an optional value');
+					}
+				);
+
+				test
+				(
+					'RunMochaTests --grep option property name should match what onRunAsync reads.',
+					function()
+					{
+						let tmpCommand = getCommand('run-mocha-tests');
+						let tmpGrepOption = tmpCommand.options.find((pOpt) => pOpt.long === '--grep');
+
+						// Commander derives the property name from the long flag (--grep => "grep").
+						// onRunAsync reads this.CommandOptions.grep to get the expression.
+						// This test ensures the two stay in sync — the bug was that onRunAsync
+						// previously read "search_expression" (the placeholder name) instead of "grep".
+						Expect(tmpGrepOption.attributeName()).to.equal('grep');
+					}
+				);
 			}
 		);