setOptionValue should clear option source (#1795)

* Have setOptionValue call setOptionValueWithSource instead of the other way around * Add explicit undefined to pass tests
tj · Sep 6, 2022 · 84d9201 · 84d9201
1 parent 82fcb98
commit 84d9201
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/lib/command.js b/lib/command.js
@@ -780,12 +780,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
    */
 
   setOptionValue(key, value) {
-    if (this._storeOptionsAsProperties) {
-      this[key] = value;
-    } else {
-      this._optionValues[key] = value;
-    }
-    return this;
+    return this.setOptionValueWithSource(key, value, undefined);
   }
 
   /**
@@ -798,7 +793,11 @@ Expecting one of '${allowedValues.join("', '")}'`);
     */
 
   setOptionValueWithSource(key, value, source) {
-    this.setOptionValue(key, value);
+    if (this._storeOptionsAsProperties) {
+      this[key] = value;
+    } else {
+      this._optionValues[key] = value;
+    }
     this._optionValueSources[key] = source;
     return this;
   }

diff --git a/tests/options.getset.test.js b/tests/options.getset.test.js
@@ -28,7 +28,7 @@ test('when setOptionValueWithSource then value returned by opts', () => {
   const cheeseValue = 'blue';
   program
     .option('--cheese [type]', 'cheese type')
-    .setOptionValue('cheese', cheeseValue);
+    .setOptionValueWithSource('cheese', cheeseValue, 'cli');
   expect(program.opts().cheese).toBe(cheeseValue);
 });
 
@@ -57,3 +57,12 @@ test('when option value parsed from cli then option source is cli', () => {
   program.parse(['--foo'], { from: 'user' });
   expect(program.getOptionValueSource('foo')).toBe('cli');
 });
+
+test('when setOptionValue then clears previous source', () => {
+  const program = new commander.Command();
+  program
+    .option('--foo', 'description', 'default value');
+  expect(program.getOptionValueSource('foo')).toBe('default');
+  program.setOptionValue('foo', 'bar');
+  expect(program.getOptionValueSource('foo')).toBeUndefined();
+});