quackage 1.0.21 → 1.0.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quackage",
-  "version": "1.0.21",
+  "version": "1.0.24",
   "description": "Building.  Testing.  Quacking.",
   "main": "source/Quackage.js",
   "scripts": {
@@ -50,22 +50,19 @@
   },
   "homepage": "https://github.com/stevenvelozo/quackage",
   "dependencies": {
-    "@babel/core": "^7.23.0",
-    "@babel/preset-env": "^7.22.20",
+    "@babel/core": "^7.23.2",
+    "@babel/preset-env": "^7.23.2",
     "browserify": "^17.0.0",
     "chai": "4.3.10",
-    "commander": "^11.0.0",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-env": "^0.4.0",
     "gulp-sourcemaps": "^3.0.0",
     "gulp-terser": "^2.1.0",
     "mocha": "10.2.0",
-    "npm-check-updates": "^16.14.5",
+    "npm-check-updates": "^16.14.6",
     "nyc": "^15.1.0",
-    "pict-service-commandlineutility": "^1.0.8",
-    "resolve-package-path": "^4.0.3",
-    "resolve-pkg": "^2.0.0",
+    "pict-service-commandlineutility": "^1.0.9",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0"
   },

package/source/Quackage-CLIProgram.js

@@ -16,19 +16,27 @@ let _Pict = new libCLIProgram(
 		AutoAddConfigurationExplanationCommand: true
 	},
 	[
+		// Management for package.json
 		require('./commands/Quackage-Command-UpdatePackage.js'),
 		require('./commands/Quackage-Command-Lint.js'),
+
+		// Mocha test execution
+		require('./commands/Quackage-Command-RunMochaTests.js'),
+
+		// Gulp build execution (for multiple build targets)
 		require('./commands/Quackage-Command-Build.js'),
+
+		// Template handling
 		require('./commands/Quackage-Command-Boilerplate.js'),
-		require('./commands/Quackage-Command-BuildTemplates.js'),
-		require('./commands/Quackage-Command-ListTemplates.js')
+		require('./commands/Quackage-Command-ListTemplates.js'),
+		require('./commands/Quackage-Command-BuildTemplates.js')
 	]);
 
 // Instantiate the file persistence service
-_Pict.serviceManager.instantiateServiceProvider('FilePersistence');
-_Pict.serviceManager.instantiateServiceProvider('DataGeneration');
+_Pict.instantiateServiceProvider('FilePersistence');
+_Pict.instantiateServiceProvider('DataGeneration');
 // Add the Quackage Process Management service
-_Pict.serviceManager.addAndInstantiateServiceType('QuackageProcess', require('./services/Quackage-Execute-Process.js'));
+_Pict.addAndInstantiateServiceType('QuackageProcess', require('./services/Quackage-Execute-Process.js'));
 
 // Grab the current working directory for the quackage
 _Pict.AppData.CWD = _Pict.QuackageProcess.cwd();

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

@@ -77,23 +77,36 @@ class QuackageCommandBuild extends libCommandLineCommand
 				//libFS.writeFileSync(`${this.fable.AppData.CWD}/gulpfile.js`, this.fable.parseTemplateByHash('Gulpfile-QuackageBase', { AppData: this.fable.AppData, Record: pAction }));
 
 				// Now execute the gulpfile using our custom service provider!
-				// We are forcing the gulp to run from the node_modules folder of the package -- this allows you to run quackage globally
-				let tmpGulpLocation = `${this.fable.AppData.CWD}/node_modules/.bin/gulp`;
+				// We are forcing the gulp to run from the node_modules folder of the package -- this allows you to run quackage globally or from the root of a monorepo
+				let tmpCWDGulpLocation = `${this.fable.AppData.CWD}/node_modules/.bin/gulp`;
+				let tmpRelativePackageGulpLocation = `${__dirname}/../../../.bin/gulp`;
+				let tmpGitRepositoryGulpLocation = `${__dirname}/../../node_modules/.bin/gulp`;
+				let tmpGulpLocation = tmpCWDGulpLocation;
+				// Check that gulp exists here
+				if (!libFS.existsSync(tmpGulpLocation))
+				{
+					this.log.info(`CWD Location does not contain an installation of gulp at [${tmpCWDGulpLocation}]; checking relative to the quackage package...`);
+					// Try the folder relative to quackage (wherever this packages' node modules are)
+					tmpGulpLocation = tmpRelativePackageGulpLocation;
+				}
+				if (!libFS.existsSync(tmpGulpLocation))
+				{
+					this.log.info(`Relative Quackage Package Location does not contain an installation of gulp at [${tmpRelativePackageGulpLocation}]; checking if you're running from the direct git repository...`);
+					// Try the folder relative to quackage (wherever this packages' node modules are)
+					tmpGulpLocation = tmpGitRepositoryGulpLocation;
+				}
+				if (!libFS.existsSync(tmpGulpLocation))
+				{
+					let tmpErrorMessage = `Not even the git checkout location has an installation of gulp at [${tmpGulpLocation}]... building cannot commence.  We also tried CWD [${tmpCWDGulpLocation}] and relative node_modules [${tmpRelativePackageGulpLocation}].  Sorry!  Maybe you need to run "npm install" somewhere??`;
+					this.log.info(tmpErrorMessage)
+					return fActionCallback(new Error(tmpErrorMessage));
+				}
+				this.log.info(`Quackage found gulp at [${tmpGulpLocation}] ... executing build from there.`);
+
 				this.fable.QuackageProcess.execute(`${tmpGulpLocation}`, [`--gulpfile`, `${this.fable.AppData.CWD}/.gulpfile-quackage.js`], { cwd: this.fable.AppData.CWD }, fActionCallback);
 			},
 			(pError) =>
 			{
-				// Now process the CopyAfterBuild directives
-				if (this.pict.ProgramConfiguration.CopyAfterBuild.length > 0)
-				{
-					//this.log.info(`Copying the following files to :`, { Files: this.pict.ProgramConfiguration.CopyAfterBuild });
-					for (let i = 0; i < this.pict.ProgramConfiguration.CopyAfterBuild.length; i++)
-					{
-						// TODO: FilePersistence needs a copy recursive with globbing.
-						//libFS.copyFileSync(`${this.fable.AppData.CWD}/${this.pict.ProgramConfiguration.CopyAfterBuild[i]}`, `${this.fable.AppData.CWD}/dist/${this.pict.ProgramConfiguration.CopyAfterBuild[i]}`);
-					}
-				}
-
 				return fCallback(pError);
 			});
 	};

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

@@ -0,0 +1,69 @@
+const libCommandLineCommand = require('pict-service-commandlineutility').ServiceCommandLineCommand;
+const libFS = require('fs');
+
+class QuackageCommandBuild extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'run-mocha-tests';
+		this.options.Description = 'Run mocha tests in your tests/ folder.';
+
+		this.options.CommandOptions.push({ Name: '-g, --grep [search_expression]', Description: 'A grep search expression for the subset of tests you want to run.' });
+
+		this.options.Aliases.push('test');
+
+		// Auto add the command on initialization
+		this.addCommand();
+	}
+
+	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 tmpCWDMochaLocation = `${this.fable.AppData.CWD}/node_modules/.bin/mocha`;
+		let tmpRelativePackageMochaLocation = `${__dirname}/../../../.bin/mocha`;
+		let tmpGitRepositoryMochaLocation = `${__dirname}/../../node_modules/.bin/mocha`;
+
+		let tmpMochaLocation = tmpCWDMochaLocation;
+
+		// Check that mocha exists here
+		if (!libFS.existsSync(tmpMochaLocation))
+		{
+			this.log.info(`CWD Location does not contain an installation of mocha at [${tmpCWDMochaLocation}]; checking relative to the quackage package...`);
+			// Try the folder relative to quackage (wherever this packages' node modules are)
+			tmpMochaLocation = tmpRelativePackageMochaLocation;
+		}
+		if (!libFS.existsSync(tmpMochaLocation))
+		{
+			this.log.info(`Relative Quackage Package Location does not contain an installation of mocha at [${tmpRelativePackageMochaLocation}]; checking if you're running from the direct git repository...`);
+			// Try the folder relative to quackage (wherever this packages' node modules are)
+			tmpMochaLocation = tmpGitRepositoryMochaLocation;
+		}
+		if (!libFS.existsSync(tmpMochaLocation))
+		{
+			let tmpErrorMessage = `Not even the git checkout location has an installation of mocha at [${tmpMochaLocation}]... building cannot commence.  We also tried CWD [${tmpCWDMochaLocation}] and relative node_modules [${tmpRelativePackageMochaLocation}].  Sorry!  Maybe you need to run "npm install" somewhere??`;
+			this.log.info(tmpErrorMessage)
+			return fActionCallback(new Error(tmpErrorMessage));
+		}
+		this.log.info(`Quackage found mocha at [${tmpMochaLocation}] ... executing build from there.`);
+
+		if (tmpTestGrepExpression)
+		{
+			this.log.info(`Running mocha tests filtered to grep expression [${tmpTestGrepExpression}]`);
+			// The standard mocha command we've been using for grep:
+			// npx mocha -u tdd --exit -R spec --grep
+			this.fable.QuackageProcess.execute(`${tmpMochaLocation}`, [`-u`, `tdd`, '--exit', '-R', 'spec', '--grep', tmpTestGrepExpression], { cwd: this.fable.AppData.CWD }, fCallback);
+		}
+		else
+		{
+			// The standard mocha command we've been using:
+			// npx mocha -u tdd -R spec
+			this.fable.QuackageProcess.execute(`${tmpMochaLocation}`, [`-u`, `tdd`, '-R', 'spec'], { cwd: this.fable.AppData.CWD }, fCallback);
+		}
+	};
+}
+
+module.exports = QuackageCommandBuild;

package/source/services/Quackage-Execute-Process.js

@@ -9,6 +9,9 @@ class BaseQuackageProcessExecutionService extends libQuackageExecuteProcessBase
 		super(pFable, pManifest, pServiceHash);
 
 		this.serviceType = 'QuackageProcess';
+
+		this.LogToDirectConsole = true;
+		this.LogToFableLog = false;
 	}
 
 	cwd()
@@ -38,12 +41,26 @@ class BaseQuackageProcessExecutionService extends libQuackageExecuteProcessBase
 		tmpProcess.stdout.on('data',
 			(pConsoleOutput) =>
 			{
-				this.log.trace(pConsoleOutput);
+				if (this.LogToDirectConsole)
+				{
+					console.log(pConsoleOutput.toString());
+				}
+				if (this.LogToFableLog)
+				{
+					this.log.info(pConsoleOutput);
+				}
 			});
 		tmpProcess.stderr.on('data',
 			(pConsoleOutput) =>
 			{
-				this.log.error(pConsoleOutput);
+				if (this.LogToDirectConsole)
+				{
+					console.log(pConsoleOutput.toString());
+				}
+				if (this.LogToFableLog)
+				{
+					this.log.error(pConsoleOutput);
+				}
 			});
 
 		tmpProcess.stderr.on('error',
@@ -56,7 +73,7 @@ class BaseQuackageProcessExecutionService extends libQuackageExecuteProcessBase
 		tmpProcess.stderr.on('close',
 			(pError) =>
 			{
-				this.log.info(`Process completed successfully, with a quack!`);
+				this.log.info(`Process completed successfully with a quack!`);
 				return fCallback(pError);
 			});
 	}