particle-commands 0.5.2 → 1.0.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+### 1.0.0 - 2024-03-13
+- Remove yeoman and use own template engine with particle-library-manager new version
+
+### 0.5.3 - 2023-10-18
+- Fix template
+
 ### 0.5.2 - 2023-10-17
 - Fix asset ota key in project properties file
 

package/dist/cmd/command.js

@@ -3,16 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
 	value: true
 });
-exports.CommandSite = exports.AbstractStatefulCommand = exports.Command = undefined;
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 
-var _when = require('when');
-
-var _when2 = _interopRequireDefault(_when);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 /**
@@ -45,18 +38,15 @@ var CommandSite = function () {
 		value: function end(state, cmd) {}
 	}, {
 		key: 'run',
-		value: function run(cmd) {
-			var _this = this;
-
+		value: async function run(cmd) {
 			var state = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
 
-			return (0, _when2.default)().then(function () {
-				return _this.begin(state, _this);
-			}).then(function () {
-				return cmd.run(state, _this);
-			}).finally(function () {
-				return _this.end(state, _this);
-			});
+			try {
+				await this.begin(state, this);
+				await cmd.run(state, this);
+			} finally {
+				await this.end(state, this);
+			}
 		}
 	}]);
 

package/dist/cmd/library_add.js

@@ -7,18 +7,12 @@ exports.LibraryAddCommand = exports.LibraryAddCommandSite = undefined;
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 
-var _pipeline = require('when/pipeline');
-
-var _pipeline2 = _interopRequireDefault(_pipeline);
-
 var _api = require('./api');
 
 var _command = require('./command');
 
 var _library = require('./library');
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
@@ -80,8 +74,6 @@ var LibraryAddCommand = exports.LibraryAddCommand = function () {
    * @returns {Promise} Library add process
    */
 		value: function run(state, site) {
-			var _this2 = this;
-
 			this.site = site;
 
 			var lib = site.libraryIdent();
@@ -89,25 +81,24 @@ var LibraryAddCommand = exports.LibraryAddCommand = function () {
 				lib.version = 'latest';
 			}
 			var directory = this.site.projectDir();
-			return (0, _pipeline2.default)([function () {
-				return _this2.ensureProjectExists(directory);
-			}, function () {
-				return _this2.loadProject();
-			}, function () {
-				return _this2.fetchLibrary(lib.name, lib.version);
-			}, function (library) {
-				return _this2.addLibraryToProject(library);
-			}, function () {
-				return _this2.saveProject();
-			}]);
+			return this._loadLibrary(directory, lib);
+		}
+	}, {
+		key: '_loadLibrary',
+		value: async function _loadLibrary(directory, lib) {
+			await this.ensureProjectExists(directory);
+			await this.loadProject();
+			var library = await this.fetchLibrary(lib.name, lib.version);
+			await this.addLibraryToProject(library);
+			await this.saveProject();
 		}
 	}, {
 		key: 'ensureProjectExists',
 		value: function ensureProjectExists(directory) {
-			var _this3 = this;
+			var _this2 = this;
 
 			return (0, _library.findProject)(directory, true).then(function (project) {
-				_this3.properties = project;
+				_this2.properties = project;
 				return project;
 			});
 		}
@@ -125,12 +116,12 @@ var LibraryAddCommand = exports.LibraryAddCommand = function () {
 	}, {
 		key: 'fetchLibrary',
 		value: function fetchLibrary(name, version) {
-			var _this4 = this;
+			var _this3 = this;
 
 			return Promise.resolve(this.site.apiClient()).then(function (apiClient) {
-				return Promise.resolve(_this4.site.fetchingLibrary(apiClient.library(name, { version: version }), name, version));
+				return Promise.resolve(_this3.site.fetchingLibrary(apiClient.library(name, { version: version }), name, version));
 			}).catch(function (err) {
-				throw _this4.apiError(err);
+				throw _this3.apiError(err);
 			});
 		}
 	}, {
@@ -140,14 +131,9 @@ var LibraryAddCommand = exports.LibraryAddCommand = function () {
 		}
 	}, {
 		key: 'addLibraryToProject',
-		value: function addLibraryToProject(library) {
-			var _this5 = this;
-
-			return (0, _pipeline2.default)([function () {
-				return _this5.site.addedLibrary(library.name, library.version);
-			}, function () {
-				return _this5.properties.addDependency(library.name, library.version);
-			}]);
+		value: async function addLibraryToProject(library) {
+			await this.site.addedLibrary(library.name, library.version);
+			await this.properties.addDependency(library.name, library.version);
 		}
 	}, {
 		key: 'saveProject',

package/dist/cmd/library_init.js

@@ -17,13 +17,10 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
-var promisify = require('es6-promisify');
-
 /**
  * Specification and base implementation for the site instance expected by
  * the LibraryInitCommand.
  */
-
 var LibraryInitCommandSite = exports.LibraryInitCommandSite = function (_CommandSite) {
 	_inherits(LibraryInitCommandSite, _CommandSite);
 
@@ -34,16 +31,6 @@ var LibraryInitCommandSite = exports.LibraryInitCommandSite = function (_Command
 	}
 
 	_createClass(LibraryInitCommandSite, [{
-		key: 'yeomanAdapter',
-		value: function yeomanAdapter() {
-			throw new Error('not implemented');
-		}
-	}, {
-		key: 'yeomanEnvironment',
-		value: function yeomanEnvironment() {
-			throw new Error('not implemented');
-		}
-	}, {
 		key: 'options',
 		value: function options() {
 			return {};
@@ -53,6 +40,16 @@ var LibraryInitCommandSite = exports.LibraryInitCommandSite = function (_Command
 		value: function args() {
 			return [];
 		}
+	}, {
+		key: 'prompter',
+		value: function prompter() {
+			throw new Error('not implemented');
+		}
+	}, {
+		key: 'outputStreamer',
+		value: function outputStreamer() {
+			throw new Error('not implemented');
+		}
 	}]);
 
 	return LibraryInitCommandSite;
@@ -73,10 +70,8 @@ var LibraryInitCommand = exports.LibraryInitCommand = function (_Command) {
 	}
 
 	_createClass(LibraryInitCommand, [{
-		key: 'generatorClass',
-		value: function generatorClass() {
-			return (0, _particleLibraryManager.buildLibraryInitGeneratorClass)();
-		}
+		key: 'run',
+
 
 		/**
    *
@@ -84,29 +79,11 @@ var LibraryInitCommand = exports.LibraryInitCommand = function (_Command) {
    * @param {LibraryInitCommandSite} site external services.
    * @returns {Promise} To run the library initialization command.
    */
-
-	}, {
-		key: 'run',
 		value: function run(state, site) {
-			var yeoman = site.yeomanEnvironment();
-			var args = site.args();
 			var opts = site.options();
-			var env = yeoman.createEnv(args, opts, site.yeomanAdapter());
-			env.registerStub(this.generatorClass(), 'library:init');
-			var run = promisify(function () {
-				return env.run.apply(env, arguments);
-			});
-			return run(['library:init'], opts);
-
-			// we ideally want the instance so that we can hook the 'end' event
-			// yeoman-evironment doesn't provide the instance with the registration method above
-			// so we dive below the covers and do it ourselves...
-			// const generator = env.instantiate(LibraryInitGenerator, opts);
-			// return new Promise((fulfill, reject) => {
-			// 	generator.on('end', fulfill);
-			// 	generator.on('error', reject);
-			// 	generator.run();
-			// });
+
+			var generator = new _particleLibraryManager.LibraryInitGenerator({ prompt: site.prompter(), stdout: site.outputStreamer() });
+			return generator.run({ options: opts });
 		}
 	}]);
 

package/dist/cmd/library_migrate.js

@@ -17,14 +17,6 @@ var _path = require('path');
 
 var _path2 = _interopRequireDefault(_path);
 
-var _when = require('when');
-
-var _when2 = _interopRequireDefault(_when);
-
-var _pipeline = require('when/pipeline');
-
-var _pipeline2 = _interopRequireDefault(_pipeline);
-
 var _library_install = require('./library_install');
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -105,25 +97,29 @@ var AbstractLibraryMigrateCommand = function (_Command) {
    *  - result: result of running `processLibrary()` if no errors were produced.
    *  - err: any error that was produced.
    */
-		value: function run(state, site) {
+		value: async function run(state, site) {
 			var _this3 = this;
 
-			var libsPromise = Promise.resolve(site.getLibraries());
-			return _when2.default.map(libsPromise, function (libdir) {
-				return Promise.resolve(site.notifyStart(libdir)).then(function () {
-					var dir = _path2.default.resolve(libdir);
-					var repo = new _particleLibraryManager.FileSystemLibraryRepository(dir, _particleLibraryManager.FileSystemNamingStrategy.DIRECT);
-					return _this3.processLibrary(repo, '', state, site, libdir).then(function (_ref) {
-						var _ref2 = _slicedToArray(_ref, 2),
-						    res = _ref2[0],
-						    err = _ref2[1];
-
-						return Promise.resolve(site.notifyEnd(libdir, res, err)).then(function () {
-							return { libdir: libdir, res: res, err: err };
-						});
-					});
-				});
+			var libraries = await site.getLibraries();
+			var promises = libraries.map(function (libdir) {
+				return _this3._executeLibrary(libdir, state, site);
 			});
+			return Promise.all(promises);
+		}
+	}, {
+		key: '_executeLibrary',
+		value: async function _executeLibrary(libdir, state, site) {
+			await site.notifyStart(libdir);
+			var dir = _path2.default.resolve(libdir);
+			var repo = new _particleLibraryManager.FileSystemLibraryRepository(dir, _particleLibraryManager.FileSystemNamingStrategy.DIRECT);
+
+			var _ref = await this.processLibrary(repo, '', state, site, libdir),
+			    _ref2 = _slicedToArray(_ref, 2),
+			    res = _ref2[0],
+			    err = _ref2[1];
+
+			await site.notifyEnd(libdir, res, err);
+			return { libdir: libdir, res: res, err: err };
 		}
 
 		/**
@@ -180,22 +176,21 @@ var LibraryMigrateCommand = exports.LibraryMigrateCommand = function (_AbstractL
 
 	_createClass(LibraryMigrateCommand, [{
 		key: 'processLibrary',
-		value: function processLibrary(repo, libname, state, site, libdir) {
-			return resultError((0, _pipeline2.default)([function () {
-				return repo.getLibraryLayout(libname);
-			}, function (layout) {
-				if (layout === 2) {
-					return false;
-				} else {
-					return repo.setLibraryLayout(libname, 2).then(function () {
-						if (site.isAdaptersRequired()) {
-							return (0, _library_install.buildAdapters)(libdir, libname);
-						}
-					}).then(function () {
-						return true;
-					});
-				}
-			}]));
+		value: async function processLibrary(repo, libname, state, site, libdir) {
+			return resultError(this._processLibrary(repo, libname, state, site, libdir));
+		}
+	}, {
+		key: '_processLibrary',
+		value: async function _processLibrary(repo, libname, state, site, libdir) {
+			var layout = await repo.getLibraryLayout(libname);
+			if (layout === 2) {
+				return false;
+			}
+			await repo.setLibraryLayout(libname, 2);
+			if (site.isAdaptersRequired()) {
+				await (0, _library_install.buildAdapters)(libdir, libname);
+			}
+			return true;
 		}
 	}]);
 

package/dist/cmd/templates/project/src/project.cpp

@@ -29,7 +29,7 @@ void loop() {
   // The core of your code will likely live here.
 
   // Example: Publish event to cloud every 10 seconds. Uncomment the next 3 lines to try it!
-  // Logging.info("Sending Hello World to the cloud!");
+  // Log.info("Sending Hello World to the cloud!");
   // Particle.publish("Hello world!");
   // delay( 10 * 1000 ); // milliseconds and blocking - see docs for more info!
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "particle-commands",
   "description": "Library of UX-neutral commands that provide key functionality for developer tools",
-  "version": "0.5.2",
+  "version": "1.0.0",
   "author": "Matthew McGowan",
   "bugs": {
     "url": "https://github.com/particle-iot/particle-commands/issues"
@@ -17,13 +17,10 @@
     "es6-promisify": "^4.1.0",
     "mkdirp": "^0.5.1",
     "particle-api-js": "^6.5.0",
-    "particle-library-manager": "^0.1.13",
+    "particle-library-manager": "^1.0.0",
     "semver": "^5.1.0",
     "underscore": "^1.8.3",
-    "when": "^3.7.2",
-    "winreg": "^1.2.2",
-    "yeoman-environment": "^1.6.6",
-    "yeoman-generator": "^1.1.1"
+    "winreg": "^1.2.2"
   },
   "devDependencies": {
     "babel-cli": "^6.10.1",

package/src/cmd/command.js

@@ -1,5 +1,3 @@
-import when from 'when';
-
 /**
  * Describes the interface expected of objects passed as the command site to a command.
  */
@@ -22,11 +20,13 @@ class CommandSite {
 	end(state, cmd) {}
 
 
-	run(cmd, state = {}) {
-		return when()
-		.then(() => this.begin(state, this))
-		.then(() => cmd.run(state, this))
-		.finally(() => this.end(state, this));
+	async run(cmd, state = {}) {
+		try {
+			await this.begin(state, this);
+			await cmd.run(state, this);
+		} finally {
+			await this.end(state, this);
+		}
 	}
 }
 

package/src/cmd/library_add.js

@@ -1,5 +1,3 @@
-
-import pipeline from 'when/pipeline';
 import { convertApiError } from './api';
 import { CommandSite } from './command';
 import { findProject } from './library';
@@ -45,13 +43,15 @@ export class LibraryAddCommand {
 			lib.version = 'latest';
 		}
 		const directory = this.site.projectDir();
-		return pipeline([
-			() => this.ensureProjectExists(directory),
-			() => this.loadProject(),
-			() => this.fetchLibrary(lib.name, lib.version),
-			(library) => this.addLibraryToProject(library),
-			() => this.saveProject()
-		]);
+		return this._loadLibrary(directory, lib);
+	}
+
+	async _loadLibrary(directory, lib) {
+		await this.ensureProjectExists(directory);
+		await this.loadProject();
+		const library = await this.fetchLibrary(lib.name, lib.version);
+		await this.addLibraryToProject(library);
+		await this.saveProject();
 	}
 
 	ensureProjectExists(directory) {
@@ -86,11 +86,9 @@ export class LibraryAddCommand {
 		return convertApiError(err);
 	}
 
-	addLibraryToProject(library) {
-		return pipeline([
-			() => this.site.addedLibrary(library.name, library.version),
-			() => this.properties.addDependency(library.name, library.version)
-		]);
+	async addLibraryToProject(library) {
+		await this.site.addedLibrary(library.name, library.version);
+		await this.properties.addDependency(library.name, library.version);
 	}
 
 	saveProject() {

package/src/cmd/library_init.js

@@ -1,7 +1,5 @@
 import { Command, CommandSite } from './command';
-import { buildLibraryInitGeneratorClass } from 'particle-library-manager';
-
-const promisify = require('es6-promisify');
+import { LibraryInitGenerator } from 'particle-library-manager';
 
 /**
  * Specification and base implementation for the site instance expected by
@@ -13,14 +11,6 @@ export class LibraryInitCommandSite extends CommandSite {
 		super();
 	}
 
-	yeomanAdapter() {
-		throw new Error('not implemented');
-	}
-
-	yeomanEnvironment() {
-		throw new Error('not implemented');
-	}
-
 	options() {
 		return {};
 	}
@@ -29,6 +19,14 @@ export class LibraryInitCommandSite extends CommandSite {
 		return [];
 	}
 
+	prompter() {
+		throw new Error('not implemented');
+	}
+
+	outputStreamer() {
+		throw new Error('not implemented');
+	}
+
 }
 
 /**
@@ -36,10 +34,6 @@ export class LibraryInitCommandSite extends CommandSite {
  */
 export class LibraryInitCommand extends Command {
 
-	generatorClass() {
-		return buildLibraryInitGeneratorClass();
-	}
-
 	/**
 	 *
 	 * @param {object} state The current conversation state.
@@ -47,23 +41,10 @@ export class LibraryInitCommand extends Command {
 	 * @returns {Promise} To run the library initialization command.
 	 */
 	run(state, site) {
-		const yeoman = site.yeomanEnvironment();
-		const args = site.args();
 		const opts = site.options();
-		const env = yeoman.createEnv(args, opts, site.yeomanAdapter());
-		env.registerStub(this.generatorClass(), 'library:init');
-		const run = promisify((...args) => env.run(...args));
-		return run(['library:init'], opts);
 
-		// we ideally want the instance so that we can hook the 'end' event
-		// yeoman-evironment doesn't provide the instance with the registration method above
-		// so we dive below the covers and do it ourselves...
-		// const generator = env.instantiate(LibraryInitGenerator, opts);
-		// return new Promise((fulfill, reject) => {
-		// 	generator.on('end', fulfill);
-		// 	generator.on('error', reject);
-		// 	generator.run();
-		// });
+		const generator = new LibraryInitGenerator({ prompt: site.prompter(), stdout: site.outputStreamer() });
+		return generator.run({ options: opts });
 	}
 }
 

package/src/cmd/library_migrate.js

@@ -1,9 +1,6 @@
 import { Command, CommandSite } from './command';
-
 import { FileSystemLibraryRepository, FileSystemNamingStrategy } from 'particle-library-manager';
 import path from 'path';
-import when from 'when';
-import pipeline from 'when/pipeline';
 import { buildAdapters } from './library_install';
 
 export class LibraryMigrateCommandSite extends CommandSite {
@@ -46,22 +43,19 @@ class AbstractLibraryMigrateCommand extends Command {
 	 *  - result: result of running `processLibrary()` if no errors were produced.
 	 *  - err: any error that was produced.
 	 */
-	run(state, site) {
-		const libsPromise = Promise.resolve(site.getLibraries());
-		return when.map(libsPromise, libdir => {
-			return Promise.resolve(site.notifyStart(libdir))
-			.then(() => {
-				const dir = path.resolve(libdir);
-				const repo = new FileSystemLibraryRepository(dir, FileSystemNamingStrategy.DIRECT);
-				return this.processLibrary(repo, '', state, site, libdir)
-				.then(([res, err]) => {
-					return Promise.resolve(site.notifyEnd(libdir, res, err))
-					.then(() => {
-						return { libdir, res, err };
-					});
-				});
-			});
-		});
+	async run(state, site) {
+		const libraries = await site.getLibraries();
+		const promises = libraries.map(libdir => this._executeLibrary(libdir, state, site));
+		return Promise.all(promises);
+	}
+
+	async _executeLibrary(libdir, state, site){
+		await site.notifyStart(libdir);
+		const dir = path.resolve(libdir);
+		const repo = new FileSystemLibraryRepository(dir, FileSystemNamingStrategy.DIRECT);
+		const [res, err] = await this.processLibrary(repo, '', state, site, libdir);
+		await site.notifyEnd(libdir, res, err);
+		return { libdir, res, err };
 	}
 
 	/**
@@ -89,22 +83,19 @@ export class LibraryMigrateTestCommand extends AbstractLibraryMigrateCommand {
 
 export class LibraryMigrateCommand extends AbstractLibraryMigrateCommand {
 
-	processLibrary(repo, libname, state, site, libdir) {
-		return resultError(pipeline([
-			() => repo.getLibraryLayout(libname),
-			(layout) => {
-				if (layout === 2) {
-					return false;
-				} else {
-					return repo.setLibraryLayout(libname, 2)
-						.then(() => {
-							if (site.isAdaptersRequired()) {
-								return buildAdapters(libdir, libname);
-							}
-						})
-						.then(() => true);
-				}
-			}
-		]));
+	async processLibrary(repo, libname, state, site, libdir) {
+		return resultError(this._processLibrary(repo, libname, state, site, libdir));
+	}
+
+	async _processLibrary(repo, libname, state, site, libdir) {
+		const layout = await repo.getLibraryLayout(libname);
+		if (layout === 2) {
+			return false;
+		}
+		await repo.setLibraryLayout(libname, 2);
+		if (site.isAdaptersRequired()) {
+			await buildAdapters(libdir, libname);
+		}
+		return true;
 	}
 }

package/src/cmd/templates/project/src/project.cpp

@@ -29,7 +29,7 @@ void loop() {
   // The core of your code will likely live here.
 
   // Example: Publish event to cloud every 10 seconds. Uncomment the next 3 lines to try it!
-  // Logging.info("Sending Hello World to the cloud!");
+  // Log.info("Sending Hello World to the cloud!");
   // Particle.publish("Hello world!");
   // delay( 10 * 1000 ); // milliseconds and blocking - see docs for more info!
 }