Feature/argument arg explicit (#1567)

* Add new methods

* Add chain test

* Add tests for Argument.required

* Add typings for argRequired and argOptional

Author: shadowspawn

lib/argument.js

@@ -109,6 +109,22 @@ class Argument {
     };
     return this;
   };
+
+  /**
+   * Make option-argument required.
+   */
+  argRequired() {
+    this.required = true;
+    return this;
+  }
+
+  /**
+   * Make option-argument optional.
+   */
+  argOptional() {
+    this.required = false;
+    return this;
+  }
 }
 
 /**

tests/argument.chain.test.js

@@ -18,4 +18,16 @@ describe('Argument methods that should return this for chaining', () => {
     const result = argument.choices(['a']);
     expect(result).toBe(argument);
   });
+
+  test('when call .argRequired() then returns this', () => {
+    const argument = new Argument('<value>');
+    const result = argument.argRequired();
+    expect(result).toBe(argument);
+  });
+
+  test('when call .argOptional() then returns this', () => {
+    const argument = new Argument('<value>');
+    const result = argument.argOptional();
+    expect(result).toBe(argument);
+  });
 });

tests/argument.required.test.js

@@ -0,0 +1,34 @@
+const commander = require('../');
+
+// Low-level tests of setting Argument.required.
+// Higher level tests of optional/required arguments elsewhere.
+
+test('when name with surrounding <> then argument required', () => {
+  const argument = new commander.Argument('<name>');
+  expect(argument.required).toBe(true);
+});
+
+test('when name with surrounding [] then argument optional', () => {
+  const argument = new commander.Argument('[name]');
+  expect(argument.required).toBe(false);
+});
+
+test('when name without surrounding brackets then argument required', () => {
+  // default behaviour, allowed from Commander 8
+  const argument = new commander.Argument('name');
+  expect(argument.required).toBe(true);
+});
+
+test('when call .argRequired() then argument required', () => {
+  const argument = new commander.Argument('name');
+  argument.required = false;
+  argument.argRequired();
+  expect(argument.required).toBe(true);
+});
+
+test('when call .argOptional() then argument optional', () => {
+  const argument = new commander.Argument('name');
+  argument.required = true;
+  argument.argOptional();
+  expect(argument.required).toBe(false);
+});

typings/index.d.ts

@@ -63,6 +63,15 @@ export class Argument {
    */
    choices(values: string[]): this;
 
+  /**
+   * Make option-argument required.
+   */
+   argRequired(): this;
+
+  /**
+   * Make option-argument optional.
+   */
+  argOptional(): this;
   }
 
 export class Option {

typings/index.test-d.ts

@@ -395,6 +395,12 @@ expectType<commander.Argument>(baseArgument.argParser((value: string, previous:
 // choices
 expectType<commander.Argument>(baseArgument.choices(['a', 'b']));
 
+// argRequired
+expectType<commander.Argument>(baseArgument.argRequired());
+
+// argOptional
+expectType<commander.Argument>(baseArgument.argOptional());
+
 // createArgument
 expectType<commander.Argument>(program.createArgument('<name>'));
 expectType<commander.Argument>(program.createArgument('<name>', 'description'));