feat: Guard against short options longer than 1 char

pkgjs · Feb 28, 2022 · b0b71c4 · b0b71c4
1 parent 14866a3
commit b0b71c4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/index.js b/index.js
@@ -93,7 +93,11 @@ const parseArgs = ({
     }
 
     if (ObjectHasOwn(optionConfig, 'short')) {
-      validateString(optionConfig.short, `options.${option}.short`);
+      const short = optionConfig.short;
+      validateString(short, `options.${option}.short`);
+      if (short.length !== 1) {
+        throw new Error(`options.${option}.short must be a single character got "${short}"`);
+      }
     }
 
     if (ObjectHasOwn(optionConfig, 'multiple')) {

diff --git a/test/index.js b/test/index.js
@@ -380,3 +380,12 @@ test('invalid union value passed to "type" option', function(t) {
 
   t.end();
 });
+
+test('invalid short option length', function(t) {
+  const passedArgs = [];
+  const passedOptions = { foo: { short: 'fo' } };
+
+  t.throws(function() { parseArgs({ args: passedArgs, options: passedOptions }); });
+
+  t.end();
+});