[rush] command-line.json supports specifying custom remainder for commands and phases

[chengcyber]

Summary

This PR proposes specifying custom remainder for commands and phases in "command-line.json"

Details

• Add "remainders" property in "command-line.json"
• Each item in "remainders" associates with commands or phases
• The associated commands/phases can get the argument list after recognized portion.

How it was tested

modify "common/config/rush/command-line.json"

  "commands": [
    {
      "commandKind": "global",
      "name": "echo",
      "summary": "echo argv",
      "shellCommand": "echo $@"
    },

   // ...

   "remainders": [
     {
        "description": "rest arguments"
        "associatedCommands": ["echo"]
     }
   ]

Run node libraries/rush-lib/lib/start.js echo a b c, it prints

Run node libraries/rush-lib/lib/start.js echo -h, it prints

[iclanton]

Suggested change

	* A list of the names of the phases that this command-line parameter should be provided to.
	* A list of the names of the phases that the remainder of the command-line should be provided to.

[iclanton]

Suggested change

	* A list of custom commands and/or built-in Rush commands that this parameter may be used with, by name.
	* A list of custom commands and/or built-in Rush commands the remainder of the command-line may be used with, by name.

[iclanton]

Suggested change

	remainders?: IRemainderJson[];
	commandLineRemainers?: IRemainderJson[];

[iclanton]

Suggested change

	* Denotes that this is a remainder parameter.
	* The description of how the command-line remainder for the specified commands may be used.

[iclanton]

Is this useful to have as part of this class's API?

[iclanton]

This should be a string, right?

[iclanton]

These should be string arrays, right?

[iclanton]

What happens when a command/phase is associated with two remainders?

My inclination would be to treat the remainder as a singleton that can be associated with commands or phases, and just have a hardcoded description.

[chengcyber]

What happens when a command/phase is associated with two remainders?

Yes. remainder should be a singleton. We should forbid (throw error) when declaring two remainders for the same command

My inclination would be to treat the remainder as a singleton that can be associated with commands or phases, and just have a hardcoded description.

Are you proposing something like the following?

common/config/rush/command-line.json

{
   "remainders": {  // a list of different remainders -> a object declares associated commands and/or phases
      // no description setting at all
      "associatedCommands": [ "FOO", "BAR" ]         // should be unique
      "associatedPhases": ["_phase:FOO", "_phase:BAR"]      //  should be unique
   }
}

If so, the only concern is there is no way to archive the use case as follow:

   "remainders": [
      {
         "associatedCommands": [ "FOO"]         
        "associatedPhases": ["_phase:FOO", "_phase:BAR"]    
      },
      {
         "associatedCommands": ["BAR" ]         
        "associatedPhases": ["_phase:BAR"]    
      }
   ]

custom remainder for _phase:FOO only for FOO command, but not for BAR command.

Maybe the use case is not a big deal (?)