Big switch from .arguments to .argument in tests

docs/options-taking-varying-arguments.md

@@ -5,7 +5,7 @@ and subtle issues in depth.
 
 - [Options taking varying numbers of option-arguments](#options-taking-varying-numbers-of-option-arguments)
   - [Parsing ambiguity](#parsing-ambiguity)
-    - [Alternative: Make  `--` part of your syntax](#alternative-make----part-of-your-syntax)
+    - [Alternative: Make  `--` part of your syntax](#alternative-make-----part-of-your-syntax)
     - [Alternative: Put options last](#alternative-put-options-last)
     - [Alternative: Use options instead of command-arguments](#alternative-use-options-instead-of-command-arguments)
   - [Combining short options, and options taking arguments](#combining-short-options-and-options-taking-arguments)
@@ -34,7 +34,7 @@ intend the argument following the option as a command or command-argument.
 ```js
 program
   .name('cook')
-  .arguments('[technique]')
+  .argument('[technique]')
   .option('-i, --ingredient [ingredient]', 'add cheese or given ingredient')
   .action((technique, options) => {
     console.log(`technique: ${technique}`);

docs/zh-CN/可变参数的选项.md

@@ -31,7 +31,7 @@ Commander 首先解析选项的参数，而用户有可能想将选项后面跟
 ```js
 program
   .name('cook')
-  .arguments('[technique]')
+  .argument('[technique]')
   .option('-i, --ingredient [ingredient]', 'add cheese or given ingredient')
   .action((technique, options) => {
     console.log(`technique: ${technique}`);
@@ -190,4 +190,4 @@ halal servings: true
 ```js
 .combineFlagAndOptionalValue(true)  // `-v45` 被视为 `--vegan=45`，这是默认的行为
 .combineFlagAndOptionalValue(false) // `-vl` 被视为 `-v -l`
-```
+```

examples/pass-through-options.js

@@ -5,7 +5,8 @@ const { Command } = require('../'); // include commander in git clone of command
 const program = new Command();
 
 program
-  .arguments('<utility> [args...]')
+  .argument('<utility>')
+  .argument('[args...]')
   .passThroughOptions()
   .option('-d, --dry-run')
   .action((utility, args, options) => {

tests/command.allowExcessArguments.test.js

@@ -94,7 +94,7 @@ describe('allowUnknownOption', () => {
   test('when specify expected arg and allowExcessArguments(false) then no error', () => {
     const program = new commander.Command();
     program
-      .arguments('<file>')
+      .argument('<file>')
       .exitOverride()
       .allowExcessArguments(false)
       .action(() => {});
@@ -107,7 +107,7 @@ describe('allowUnknownOption', () => {
   test('when specify excess after <arg> and allowExcessArguments(false) then error', () => {
     const program = new commander.Command();
     program
-      .arguments('<file>')
+      .argument('<file>')
       .exitOverride()
       .allowExcessArguments(false)
       .action(() => {});
@@ -120,7 +120,7 @@ describe('allowUnknownOption', () => {
   test('when specify excess after [arg] and allowExcessArguments(false) then error', () => {
     const program = new commander.Command();
     program
-      .arguments('[file]')
+      .argument('[file]')
       .exitOverride()
       .allowExcessArguments(false)
       .action(() => {});
@@ -133,7 +133,7 @@ describe('allowUnknownOption', () => {
   test('when specify args for [args...] and allowExcessArguments(false) then no error', () => {
     const program = new commander.Command();
     program
-      .arguments('[files...]')
+      .argument('[files...]')
       .exitOverride()
       .allowExcessArguments(false)
       .action(() => {});

tests/command.allowUnknownOption.test.js

@@ -83,7 +83,7 @@ describe('allowUnknownOption', () => {
     program
       .exitOverride()
       .command('sub')
-      .arguments('[args...]') // unknown option will be passed as an argument
+      .argument('[args...]') // unknown option will be passed as an argument
       .allowUnknownOption()
       .option('-p, --pepper', 'add pepper')
       .action(() => { });

tests/command.asterisk.test.js

@@ -33,7 +33,7 @@ describe(".command('*')", () => {
     const program = new commander.Command();
     program
       .command('*')
-      .arguments('[args...]')
+      .argument('[args...]')
       .action(mockAction);
     program.parse(['node', 'test', 'unrecognised-command']);
     expect(mockAction).toHaveBeenCalled();
@@ -59,7 +59,7 @@ describe(".command('*')", () => {
       .command('install');
     program
       .command('*')
-      .arguments('[args...]')
+      .argument('[args...]')
       .action(mockAction);
     program.parse(['node', 'test', 'unrecognised-command']);
     expect(mockAction).toHaveBeenCalled();
@@ -73,7 +73,7 @@ describe(".command('*')", () => {
       .command('install');
     const star = program
       .command('*')
-      .arguments('[args...]')
+      .argument('[args...]')
       .option('-d, --debug')
       .action(mockAction);
     program.parse(['node', 'test', 'unrecognised-command', '--debug']);
@@ -93,7 +93,7 @@ describe(".command('*')", () => {
       .command('install');
     program
       .command('*')
-      .arguments('[args...]')
+      .argument('[args...]')
       .action(mockAction);
     let caughtErr;
     try {

tests/command.chain.test.js

@@ -1,4 +1,4 @@
-const { Command, Option } = require('../');
+const { Command, Option, Argument } = require('../');
 
 // Testing the functions which should chain.
 // parse and parseAsync are tested in command.parse.test.js
@@ -16,6 +16,18 @@ describe('Command methods that should return this for chaining', () => {
     expect(result).toBe(program);
   });
 
+  test('when call .argument() then returns this', () => {
+    const program = new Command();
+    const result = program.argument('<file>');
+    expect(result).toBe(program);
+  });
+
+  test('when call .addArgument() then returns this', () => {
+    const program = new Command();
+    const result = program.addArgument(new Argument('<file>'));
+    expect(result).toBe(program);
+  });
+
   test('when set .arguments() then returns this', () => {
     const program = new Command();
     const result = program.arguments('<file>');

tests/command.help.test.js

@@ -235,16 +235,25 @@ test('when option has choices and default then both included in helpInformation'
   expect(helpInformation).toMatch('(choices: "red", "blue", default: "red")');
 });
 
-test('when arguments then included in helpInformation', () => {
+test('when argument then included in helpInformation', () => {
   const program = new commander.Command();
   program
     .name('foo')
-    .arguments('<file>');
+    .argument('<file>');
   const helpInformation = program.helpInformation();
   expect(helpInformation).toMatch('Usage: foo [options] <file>');
 });
 
-test('when arguments described then included in helpInformation', () => {
+test('when argument described then included in helpInformation', () => {
+  const program = new commander.Command();
+  program
+    .argument('<file>', 'input source')
+    .helpOption(false);
+  const helpInformation = program.helpInformation();
+  expect(helpInformation).toMatch(/Arguments:\n +file +input source/);
+});
+
+test('when arguments described in deprecated way then included in helpInformation', () => {
   const program = new commander.Command();
   program
     .arguments('<file>')
@@ -254,7 +263,7 @@ test('when arguments described then included in helpInformation', () => {
   expect(helpInformation).toMatch(/Arguments:\n +file +input source/);
 });
 
-test('when arguments described and empty description then arguments included in helpInformation', () => {
+test('when arguments described in deprecated way and empty description then arguments still included in helpInformation', () => {
   const program = new commander.Command();
   program
     .arguments('<file>')

tests/command.positionalOptions.test.js

@@ -9,7 +9,7 @@ describe('program with passThrough', () => {
     program.passThroughOptions();
     program
       .option('-d, --debug')
-      .arguments('<args...>');
+      .argument('<args...>');
     return program;
   }
 
@@ -77,10 +77,10 @@ describe('program with positionalOptions and subcommand', () => {
     program
       .enablePositionalOptions()
       .option('-s, --shared <value>')
-      .arguments('<args...>');
+      .argument('<args...>');
     const sub = program
       .command('sub')
-      .arguments('[arg]')
+      .argument('[arg]')
       .option('-s, --shared <value>')
       .action(() => {}); // Not used, but normal to have action handler on subcommand.
     return { program, sub };
@@ -151,10 +151,10 @@ describe('program with positionalOptions and default subcommand (called sub)', (
       .enablePositionalOptions()
       .option('-s, --shared')
       .option('-g, --global')
-      .arguments('<args...>');
+      .argument('<args...>');
     const sub = program
       .command('sub', { isDefault: true })
-      .arguments('[args...]')
+      .argument('[args...]')
       .option('-s, --shared')
       .option('-d, --default')
       .action(() => {}); // Not used, but normal to have action handler on subcommand.
@@ -218,11 +218,11 @@ describe('subcommand with passThrough', () => {
     program
       .enablePositionalOptions()
       .option('-s, --shared <value>')
-      .arguments('<args...>');
+      .argument('<args...>');
     const sub = program
       .command('sub')
       .passThroughOptions()
-      .arguments('[args...]')
+      .argument('[args...]')
       .option('-s, --shared <value>')
       .option('-d, --debug')
       .action(() => {}); // Not used, but normal to have action handler on subcommand.
@@ -289,7 +289,7 @@ describe('default command with passThrough', () => {
     const sub = program
       .command('sub', { isDefault: true })
       .passThroughOptions()
-      .arguments('[args...]')
+      .argument('[args...]')
       .option('-d, --debug')
       .action(() => {}); // Not used, but normal to have action handler on subcommand.
     return { program, sub };
@@ -332,11 +332,11 @@ describe('program with action handler and positionalOptions and subcommand', ()
     program
       .enablePositionalOptions()
       .option('-g, --global')
-      .arguments('<args...>')
+      .argument('<args...>')
       .action(() => {});
     const sub = program
       .command('sub')
-      .arguments('[arg]')
+      .argument('[arg]')
       .action(() => {});
     return { program, sub };
   }
@@ -379,11 +379,11 @@ describe('program with action handler and passThrough and subcommand', () => {
     program
       .passThroughOptions()
       .option('-g, --global')
-      .arguments('<args...>')
+      .argument('<args...>')
       .action(() => {});
     const sub = program
       .command('sub')
-      .arguments('[arg]')
+      .argument('[arg]')
       .option('-g, --group')
       .option('-d, --debug')
       .action(() => {});
@@ -451,7 +451,7 @@ describe('passThroughOptions(xxx) and option after command-argument', () => {
     const program = new commander.Command();
     program
       .option('-d, --debug')
-      .arguments('<args...>');
+      .argument('<args...>');
     return program;
   }
 

tests/command.unknownCommand.test.js

@@ -30,7 +30,7 @@ describe('unknownCommand', () => {
       .exitOverride()
       .command('sub');
     program
-      .arguments('[args...]')
+      .argument('[args...]')
       .action(() => { });
     expect(() => {
       program.parse('node test.js unknown'.split(' '));

tests/command.unknownOption.test.js

@@ -54,7 +54,7 @@ describe('unknownOption', () => {
     const program = new commander.Command();
     program
       .exitOverride()
-      .arguments('[file]')
+      .argument('[file]')
       .action(() => {});
 
     let caughtErr;
@@ -71,7 +71,7 @@ describe('unknownOption', () => {
     const program = new commander.Command();
     program
       .exitOverride()
-      .arguments('[file]')
+      .argument('[file]')
       .action(() => {});
 
     let caughtErr;

tests/commander.configureCommand.test.js

@@ -17,7 +17,7 @@ test('when default then options+command passed to action', () => {
   const program = new commander.Command();
   const callback = jest.fn();
   program
-    .arguments('<value>')
+    .argument('<value>')
     .action(callback);
   program.parse(['node', 'test', 'value']);
   expect(callback).toHaveBeenCalledWith('value', program.opts(), program);
@@ -60,7 +60,7 @@ test('when storeOptionsAsProperties() then command+command passed to action', ()
   const callback = jest.fn();
   program
     .storeOptionsAsProperties()
-    .arguments('<value>')
+    .argument('<value>')
     .action(callback);
   program.parse(['node', 'test', 'value']);
   expect(callback).toHaveBeenCalledWith('value', program, program);
@@ -71,7 +71,7 @@ test('when storeOptionsAsProperties(false) then opts+command passed to action',
   const callback = jest.fn();
   program
     .storeOptionsAsProperties(false)
-    .arguments('<value>')
+    .argument('<value>')
     .action(callback);
   program.parse(['node', 'test', 'value']);
   expect(callback).toHaveBeenCalledWith('value', program.opts(), program);

tests/help.commandTerm.test.js

@@ -27,7 +27,7 @@ describe('subcommandTerm', () => {
 
   test('when command has <argument> then returns name <argument>', () => {
     const command = new commander.Command('program')
-      .arguments('<argument>');
+      .argument('<argument>');
     const helper = new commander.Help();
     expect(helper.subcommandTerm(command)).toEqual('program <argument>');
   });
@@ -36,7 +36,7 @@ describe('subcommandTerm', () => {
     const command = new commander.Command('program')
       .alias('alias')
       .option('-a,--all')
-      .arguments('<argument>');
+      .argument('<argument>');
     const helper = new commander.Help();
     expect(helper.subcommandTerm(command)).toEqual('program|alias [options] <argument>');
   });

tests/help.longestArgumentTermLength.test.js

@@ -12,20 +12,16 @@ describe('longestArgumentTermLength', () => {
 
   test('when has argument description then returns argument length', () => {
     const program = new commander.Command();
-    program.arguments('<wonder>');
-    program.description('dummy', { wonder: 'wonder description' });
+    program.argument('<wonder>', 'wonder description');
     const helper = new commander.Help();
     expect(helper.longestArgumentTermLength(program, helper)).toEqual('wonder'.length);
   });
 
   test('when has multiple argument descriptions then returns longest', () => {
     const program = new commander.Command();
-    program.arguments('<alpha> <longest> <beta>');
-    program.description('dummy', {
-      alpha: 'x',
-      longest: 'x',
-      beta: 'x'
-    });
+    program.argument('<alpha>', 'x');
+    program.argument('<longest>', 'x');
+    program.argument('<beta>', 'x');
     const helper = new commander.Help();
     expect(helper.longestArgumentTermLength(program, helper)).toEqual('longest'.length);
   });