implement strict priorities.

tj · Sep 1, 2022 · a08a768 · a08a768
1 parent 8bea61c
commit a08a768
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/lib/command.js b/lib/command.js
@@ -57,13 +57,13 @@ class Command extends EventEmitter {
     this._showHelpAfterError = false;
     this._showSuggestionAfterError = true;
 
-    // 'unknown' value is left out on purpose, should be treated as such
-    this._precedence = [
-      'default',
-      'implied', // implied by others configs
-      'config', // placeholder for configuration files
+    this._priorities = [
+      'cli',
       'env',
-      'cli'
+      'config', // placeholder for configuration files
+      'implied', // implied by others configs
+      'default', // default option value
+      undefined // initial state, not touched yet
     ];
 
     // see .configureOutput() for docs
@@ -421,6 +421,13 @@ Expecting one of '${allowedValues.join("', '")}'`);
     return this;
   }
 
+  strictPriority(priority) {
+    this._strictPriority = true;
+    if (priority) {
+      this._priorities = priority;
+    }
+  }
+
   /**
    * Register callback to use as replacement for calling process.exit.
    *
@@ -802,7 +809,8 @@ Expecting one of '${allowedValues.join("', '")}'`);
     * @return {Command} `this` command for chaining
     */
 
-  setOptionValueWithSource(key, value, source = 'unknown') {
+  setOptionValueWithSource(key, value, source = null) {
+    if (this._strictPriority && !this._isNewSourcePreferred(source, this.getOptionValueSource(key))) return;
     if (this._storeOptionsAsProperties) {
       this[key] = value;
     } else {
@@ -1612,10 +1620,7 @@ Expecting one of '${allowedValues.join("', '")}'`);
    * @api private
    */
   _isNewSourcePreferred(newSource, existingSource) {
-    // unknown source should always take precedence. undefined existingSource means option not set.
-    if (newSource == null || !this._precedence.includes(newSource) || existingSource === undefined) return true;
-    if (existingSource === null || !this._precedence.includes(existingSource)) return false;
-    return this._precedence.indexOf(newSource) >= this._precedence.indexOf(existingSource);
+    return this._priorities.indexOf(newSource) <= this._priorities.indexOf(existingSource);
   }
 
   /**

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -266,7 +266,7 @@ export interface OutputConfiguration {
 
 export type AddHelpTextPosition = 'beforeAll' | 'before' | 'after' | 'afterAll';
 export type HookEvent = 'preSubcommand' | 'preAction' | 'postAction';
-export type OptionValueSource = 'default' | 'implied' | 'config' | 'env' | 'cli' | 'unknown';
+export type OptionValueSource = 'default' | 'implied' | 'config' | 'env' | 'cli' | null;
 
 export interface OptionValues {
   [key: string]: any;
@@ -595,7 +595,7 @@ export class Command {
   /**
    * Retrieve option value source.
    */
-  getOptionValueSource(key: string): OptionValueSource;
+  getOptionValueSource(key: string): OptionValueSource | undefined;
 
   /**
    * Alter parsing of short flags with optional values.

diff --git a/typings/index.test-d.ts b/typings/index.test-d.ts
@@ -172,7 +172,7 @@ expectType<commander.Command>(program.setOptionValue('example', true));
 expectType<commander.Command>(program.setOptionValueWithSource('example', [], 'cli'));
 
 // getOptionValueSource
-expectType<commander.OptionValueSource>(program.getOptionValueSource('example'));
+expectType<commander.OptionValueSource | undefined>(program.getOptionValueSource('example'));
 
 // combineFlagAndOptionalValue
 expectType<commander.Command>(program.combineFlagAndOptionalValue());