fix: remove extra warning on unset deprecated option

gemini-testing · Sep 3, 2024 · 448b9a8 · 448b9a8
1 parent 75f3c2a
commit 448b9a8
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/lib/core.js b/lib/core.js
@@ -32,6 +32,8 @@ function option({
                 : defaultValue;
         } else if (!isDeprecated) {
             throw new MissingOptionError(locator.name);
+        } else {
+            isSetByUser = false;
         }
 
         if (isSetByUser && isDeprecated) {

diff --git a/test/option.js b/test/option.js
@@ -1,7 +1,18 @@
+const sinon = require('sinon');
 const {option} = require('../lib/core');
 const {MissingOptionError} = require('../lib/errors');
 
 describe('option', () => {
+    let consoleWarnStub;
+
+    beforeEach(() => {
+        consoleWarnStub = sinon.stub(console, 'warn');
+    });
+
+    afterEach(() => {
+        consoleWarnStub.restore();
+    });
+
     const LAZY_CONFIG = {
         root: {defaultKey: 'defaultValue'}
     };
@@ -155,6 +166,18 @@ describe('option', () => {
             const parser = option({isDeprecated: true});
             assert.doesNotThrow(() => parser({}, LAZY_CONFIG), MissingOptionError);
         });
+
+        it('should not log warning on deprecated option', () => {
+            option({isDeprecated: true})({}, LAZY_CONFIG);
+
+            assert.notCalled(consoleWarnStub);
+        });
+    });
+
+    it('should log warning on deprecated option if option is set', () => {
+        option({isDeprecated: true})({envVar: 'foo'}, LAZY_CONFIG);
+
+        assert.calledWith(consoleWarnStub, sinon.match('option is deprecated'));
     });
 
     function testAfterParseCallback(name) {