particle-commands 1.0.5 → 1.0.6

package/CHANGELOG.md

@@ -3,6 +3,9 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+### 1.0.6 - 2026-01-30
+- Include env in project.properties for new project
+
 ### 1.0.5 - 2025-10-21
 - Bump to exclusive >= node 22
 - Migrate to latest particle eslint config

package/dist/cmd/project_init.js

@@ -251,9 +251,9 @@ var ProjectInitCommand = exports.ProjectInitCommand = function (_Command) {
 		}
 	}, {
 		key: 'createNotifyTemplateIfNeeded',
-		value: function createNotifyTemplateIfNeeded(site, fs, targetFile, templateName, data) {
+		value: async function createNotifyTemplateIfNeeded(site, fs, targetFile, templateName, data) {
 			// assumes the parent directory of the template exists
-			var content = this.expandTemplate(fs, templateName, data);
+			var content = await this.expandTemplate(fs, templateName, data);
 			return this.createNotifyFileIfNeeded(site, fs, targetFile, content);
 		}
 
@@ -316,7 +316,7 @@ var ProjectInitCommand = exports.ProjectInitCommand = function (_Command) {
 					return project.save();
 				}
 			}).then(function () {
-				return project.writeAssetOtaDir();
+				return project.populateProjectProperties();
 			});
 		}
 

package/dist/cmd/project_properties.js

@@ -121,17 +121,23 @@ var ProjectProperties = function () {
 			return this.fs.writeFile(this.name(), data, 'utf8');
 		}
 	}, {
-		key: 'writeAssetOtaDir',
-		value: function writeAssetOtaDir() {
+		key: 'populateProjectProperties',
+		value: function populateProjectProperties() {
 			var _this3 = this;
 
-			// // Add a commented line for assetOtaDir if it doesn't exist
-			this.load().then(function () {
+			// Add a commented line for assetOtaDir and env if they don't exist
+			return this.load().then(function () {
 				var val = _this3.getField('#assetOtaDir');
 				if (!val) {
 					_this3.setField('#assetOtaDir', 'assets');
 					return _this3.save();
 				}
+			}).then(function () {
+				var val = _this3.getField('#env');
+				if (!val) {
+					_this3.setField('#env', 'env.json');
+					return _this3.save();
+				}
 			});
 		}
 	}, {

package/dist/cmd/templates/project/README.md

@@ -15,6 +15,8 @@ Feel free to replace this README.md file with your own content, or keep it for r
   - [Testing and Debugging](#testing-and-debugging)
   - [GitHub Actions (CI/CD)](#github-actions-cicd)
   - [OTA](#ota)
+  - [Assets](#assets)
+  - [Environment](#environment)
 - [Support and Feedback](#support-and-feedback)
 - [Version](#version)
 
@@ -91,10 +93,30 @@ Test OTA with the 'Particle: Cloud Flash' command in Visual Studio Code or the C
 
 This firmware supports binary assets in OTA packages, allowing the inclusion of audio, images, configurations, and external microcontroller firmware. More details are [here](https://docs.particle.io/reference/device-os/api/asset-ota/asset-ota/).
 
+### Assets
+
+To include assets in your OTA bundle, create an `assets` folder in your project root and place your files there. These can include audio files, images, configuration files, or firmware for external microcontrollers.
+
+To enable asset OTA, uncomment the following line in `project.properties`:
+```
+assetOtaDir=assets
+```
+
+See the [Asset OTA documentation](https://docs.particle.io/reference/device-os/api/asset-ota) for more details.
+
+### Environment
+
+To bundle environment variables with your firmware, create an `env.json` file in your project root. Uncomment the following line in `project.properties` to enable it:
+```
+env=env.json
+```
+
+See the [Environment documentation](https://docs.particle.io/reference/device-os/api/environment) for more details.
+
 ## Support and Feedback
 
 For support or feedback on this template or any Particle products, please join our [community](https://community.particle.io)!
 
 ## Version
 
-Template version 1.0.2
+Template version 1.0.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "particle-commands",
   "description": "Library of UX-neutral commands that provide key functionality for developer tools",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "author": "Matthew McGowan",
   "contributors": [
     {

package/src/cmd/project_init.js

@@ -176,9 +176,9 @@ export class ProjectInitCommand extends Command {
 			});
 	}
 
-	createNotifyTemplateIfNeeded(site, fs, targetFile, templateName, data) {
+	async createNotifyTemplateIfNeeded(site, fs, targetFile, templateName, data) {
 		// assumes the parent directory of the template exists
-		const content = this.expandTemplate(fs, templateName, data);
+		const content = await this.expandTemplate(fs, templateName, data);
 		return this.createNotifyFileIfNeeded(site, fs, targetFile, content);
 	}
 
@@ -223,7 +223,7 @@ export class ProjectInitCommand extends Command {
 					return project.save();
 				}
 			})
-			.then(() => project.writeAssetOtaDir());
+			.then(() => project.populateProjectProperties());
 	}
 
 	/**

package/src/cmd/project_properties.js

@@ -72,15 +72,21 @@ export default class ProjectProperties {
 		return this.fs.writeFile(this.name(), data, 'utf8');
 	}
 
-	writeAssetOtaDir() {
-		// // Add a commented line for assetOtaDir if it doesn't exist
-		this.load()
+	populateProjectProperties() {
+		// Add a commented line for assetOtaDir and env if they don't exist
+		return this.load()
 			.then(() => {
 				const val = this.getField('#assetOtaDir');
 				if (!val) {
 					this.setField('#assetOtaDir', 'assets');
 					return this.save();
 				}
+			}).then(() => {
+				const val = this.getField('#env');
+				if (!val) {
+					this.setField('#env', 'env.json');
+					return this.save();
+				}
 			});
 	}
 

package/src/cmd/templates/project/README.md

@@ -15,6 +15,8 @@ Feel free to replace this README.md file with your own content, or keep it for r
   - [Testing and Debugging](#testing-and-debugging)
   - [GitHub Actions (CI/CD)](#github-actions-cicd)
   - [OTA](#ota)
+  - [Assets](#assets)
+  - [Environment](#environment)
 - [Support and Feedback](#support-and-feedback)
 - [Version](#version)
 
@@ -91,10 +93,30 @@ Test OTA with the 'Particle: Cloud Flash' command in Visual Studio Code or the C
 
 This firmware supports binary assets in OTA packages, allowing the inclusion of audio, images, configurations, and external microcontroller firmware. More details are [here](https://docs.particle.io/reference/device-os/api/asset-ota/asset-ota/).
 
+### Assets
+
+To include assets in your OTA bundle, create an `assets` folder in your project root and place your files there. These can include audio files, images, configuration files, or firmware for external microcontrollers.
+
+To enable asset OTA, uncomment the following line in `project.properties`:
+```
+assetOtaDir=assets
+```
+
+See the [Asset OTA documentation](https://docs.particle.io/reference/device-os/api/asset-ota) for more details.
+
+### Environment
+
+To bundle environment variables with your firmware, create an `env.json` file in your project root. Uncomment the following line in `project.properties` to enable it:
+```
+env=env.json
+```
+
+See the [Environment documentation](https://docs.particle.io/reference/device-os/api/environment) for more details.
+
 ## Support and Feedback
 
 For support or feedback on this template or any Particle products, please join our [community](https://community.particle.io)!
 
 ## Version
 
-Template version 1.0.2
+Template version 1.0.3

package/test/cmd/project_init.spec.js

@@ -118,6 +118,15 @@ describe('project_init', () => {
 				});
 		});
 
+		it('populates commented assetOtaDir and env fields in project.properties', () => {
+			return createProject({ directory:'dir6', name:'name6' })
+				.then(() => expectProject('dir6', { name:'name6' }))
+				.then((project) => {
+					expect(project.getField('#assetOtaDir')).to.equal('assets');
+					expect(project.getField('#env')).to.equal('env.json');
+				});
+		});
+
 		// todo - preserve comments and field order
 	});
 });