chore: [A] Allow using key=value format for config env

Author: hugomontero

src/cli/config.js

@@ -44,7 +44,7 @@ module.exports = ({ commandProcessor, root }) => {
 	});
 
 	commandProcessor.createCommand(env, 'set', 'Set an environment variable', {
-		params: '<key> <value>',
+		params: '<key> [value]',
 		options: {
 			'sandbox': {
 				description: 'Target the sandbox',
@@ -65,9 +65,10 @@ module.exports = ({ commandProcessor, root }) => {
 			return new EnvVarsCommand(args).setEnvVars(args);
 		},
 		examples: {
-			'$0 $command <key> <value> --sandbox': 'Set env var to user\'s sandbox',
+			'$0 $command <key> <value> --sandbox': 'Set env var to user\'s sandbox (space format)',
+			'$0 $command <key=value> --sandbox': 'Set env var to user\'s sandbox (equal sign format)',
 			'$0 $command <key> <value> --org <org>': 'Set env var for an organization',
-			'$0 $command <key> <value> --product <productId>': 'Set env var for a product',
+			'$0 $command <key=value> --product <productId>': 'Set env var for a product',
 			'$0 $command <key> <value> --device <deviceId>': 'Set env var for a device',
 		}
 	});

src/cmd/env.js

@@ -88,8 +88,12 @@ module.exports = class EnvVarsCommand extends CLICommandBase {
 		this.ui.write('---------------------------------------------');
 	};
 
-	async setEnvVars({ params: { key, value }, org, product, device, sandbox }) {
+	async setEnvVars({ params, org, product, device, sandbox }) {
 		this._validateScope({ sandbox, org, product, device });
+
+		// Parse key and value - supports both "key value" and "key=value" formats
+		const { key, value } = this._parseKeyValue(params);
+
 		const operation = this._buildEnvVarOperation({ key, value, operation: 'Set' });
 		await this.ui.showBusySpinnerUntilResolved('Setting environment variable...',
 			this.api.patchEnvVars({
@@ -102,6 +106,28 @@ module.exports = class EnvVarsCommand extends CLICommandBase {
 		this.ui.write(`Key ${key} has been successfully set.`);
 	}
 
+	_parseKeyValue(params) {
+		// If params has both key and value, use them directly (e.g., "key value" format)
+		if (params.key && params.value) {
+			return { key: params.key, value: params.value };
+		}
+
+		// Otherwise, check if key contains "=" (e.g., "key=value" format)
+		if (params.key && params.key.includes('=')) {
+			const [key, ...valueParts] = params.key.split('=');
+			const value = valueParts.join('='); // Handle values that contain "="
+
+			if (!key || value === undefined) {
+				throw new Error('Invalid format. Use either "key value" or "key=value"');
+			}
+
+			return { key, value };
+		}
+
+		// If we got here, the format is invalid
+		throw new Error('Invalid format. Use either "key value" or "key=value"');
+	}
+
 	async deleteEnv({ params: { key }, org, product, device, sandbox, dryRun }) {
 		this._validateScope({ sandbox, org, product, device });
 

src/cmd/env.test.js

@@ -138,12 +138,13 @@ describe('config env Command', () => {
 				error_description: 'Validation error: : Must only contain uppercase letters, numbers, and underscores. Must not start with a number. at "ops[0].key"',
 				error:'invalid_request'
 			};
+			const params = { key: 'invalid-key', value: 'bar' }; // Invalid key with dash
 			nock('https://api.particle.io/v1')
 				.intercept('/env', 'PATCH')
 				.reply(400, apiError);
 			let error;
 			try {
-				await envVarsCommands.setEnvVars({ params: {}, sandbox: true });
+				await envVarsCommands.setEnvVars({ params, sandbox: true });
 			} catch (_error) {
 				error = _error;
 			}
@@ -178,6 +179,58 @@ describe('config env Command', () => {
 			expect(envVarsCommands.ui.showBusySpinnerUntilResolved).calledWith('Setting environment variable...');
 			expect(envVarsCommands.ui.write).to.have.been.calledWith(`Key ${params.key} has been successfully set.`);
 		});
+
+		it('set env var using key=value format', async () => {
+			let receivedBody;
+			const params = { key: 'FOO=bar' };
+			nock('https://api.particle.io/v1')
+				.intercept('/env', 'PATCH')
+				.reply((uri, requestBody) => {
+					receivedBody = requestBody;
+					return [200, sandboxList];
+				});
+			await envVarsCommands.setEnvVars({ params, sandbox: true });
+			expect(receivedBody).to.deep.equal({ ops: [{ key: 'FOO', value: 'bar', op: 'Set' }] });
+			expect(envVarsCommands.ui.showBusySpinnerUntilResolved).calledWith('Setting environment variable...');
+			expect(envVarsCommands.ui.write).to.have.been.calledWith('Key FOO has been successfully set.');
+		});
+
+		it('set env var using key=value format with value containing equals sign', async () => {
+			let receivedBody;
+			const params = { key: 'FOO=bar=baz' };
+			nock('https://api.particle.io/v1')
+				.intercept('/env', 'PATCH')
+				.reply((uri, requestBody) => {
+					receivedBody = requestBody;
+					return [200, sandboxList];
+				});
+			await envVarsCommands.setEnvVars({ params, sandbox: true });
+			expect(receivedBody).to.deep.equal({ ops: [{ key: 'FOO', value: 'bar=baz', op: 'Set' }] });
+			expect(envVarsCommands.ui.showBusySpinnerUntilResolved).calledWith('Setting environment variable...');
+			expect(envVarsCommands.ui.write).to.have.been.calledWith('Key FOO has been successfully set.');
+		});
+
+		it('throws error when key=value format is invalid (empty key)', async () => {
+			const params = { key: '=bar' };
+			let error;
+			try {
+				await envVarsCommands.setEnvVars({ params, sandbox: true });
+			} catch (_error) {
+				error = _error;
+			}
+			expect(error.message).to.equal('Invalid format. Use either "key value" or "key=value"');
+		});
+
+		it('throws error when neither key/value nor key=value format is provided', async () => {
+			const params = { key: 'FOO' }; // Missing value
+			let error;
+			try {
+				await envVarsCommands.setEnvVars({ params, sandbox: true });
+			} catch (_error) {
+				error = _error;
+			}
+			expect(error.message).to.equal('Invalid format. Use either "key value" or "key=value"');
+		});
 	});
 
 	describe('delete env vars', () => {