1+ /**
2+ * This configuration file defines custom commands for the "rush" command-line.
3+ * For full documentation, please see https://rushjs.io
4+ */
15{
26 "$schema" : " https://developer.microsoft.com/json-schemas/rush/v5/command-line.schema.json" ,
37
8+ /**
9+ * Custom "commands" introduce new verbs for the command-line. To see the help for these
10+ * example commands, try "rush --help", "rush my-bulk-command --help", or
11+ * "rush my-global-command --help".
12+ */
13+ "commands" : [
14+ // {
15+ // /**
16+ // * (Required) Determines the type of custom command.
17+ // * Rush's "bulk" commands are invoked separately for each project. Rush will look in
18+ // * each project's package.json file for a "scripts" entry whose name matches the
19+ // * command name. By default, the command will run for every project in the repo,
20+ // * according to the dependency graph (similar to how "rush build" works).
21+ // * The set of projects can be restricted e.g. using the "--to" or "--from" parameters.
22+ // */
23+ // "commandKind": "bulk",
24+ //
25+ // /**
26+ // * (Required) The name that will be typed as part of the command line. This is also the name
27+ // * of the "scripts" hook in the project's package.json file.
28+ // * The name should be comprised of lower case words separated by hyphens.
29+ // */
30+ // "name": "my-bulk-command",
31+ //
32+ // /**
33+ // * (Required) A short summary of the custom command to be shown when printing command line
34+ // * help, e.g. "rush --help".
35+ // */
36+ // "summary": "Example bulk custom command",
37+ //
38+ // /**
39+ // * A detailed description of the command to be shown when printing command line
40+ // * help (e.g. "rush --help my-command").
41+ // * If omitted, the "summary" text will be shown instead.
42+ // *
43+ // * Whenever you introduce commands/parameters, taking a little time to write meaningful
44+ // * documentation can make a big difference for the developer experience in your repo.
45+ // */
46+ // "description": "This is an example custom command that runs separately for each project",
47+ //
48+ // /**
49+ // * (Required) If true, then this command is safe to be run in parallel, i.e. executed
50+ // * simultaneously for multiple projects. Similar to "rush build", regardless of parallelism
51+ // * projects will not start processing until their dependencies have completed processing.
52+ // */
53+ // "enableParallelism": false,
54+ //
55+ // /**
56+ // * Normally Rush requires that each project's package.json has a "scripts" entry matching
57+ // * the custom command name. To disable this check, set "ignoreMissingScript" to true;
58+ // * projects with a missing definition will be skipped.
59+ // */
60+ // "ignoreMissingScript": false
61+ // },
62+ //
63+ // {
64+ // /**
65+ // * (Required) Determines the type of custom command.
66+ // * Rush's "global" commands are invoked once for the entire repo.
67+ // */
68+ // "commandKind": "global",
69+ //
70+ // "name": "my-global-command",
71+ // "summary": "Example global custom command",
72+ // "description": "This is an example custom command that runs once for the entire repo",
73+ //
74+ // /**
75+ // * A script that will be invoked using the OS shell. The working directory will be the folder
76+ // * that contains rush.json. If custom parameters are associated with this command, their
77+ // * values will be appended to the end of this string.
78+ // */
79+ // "shellCommand": "node common/scripts/my-global-command.js"
80+ // }
81+ ],
82+
83+ /**
84+ * Custom "parameters" introduce new parameters for specified Rush command-line commands.
85+ * For example, you might define a "--production" parameter for the "rush build" command.
86+ */
487 "parameters" : [
88+ // {
89+ // /**
90+ // * (Required) Determines the type of custom parameter.
91+ // * A "flag" is a custom command-line parameter whose presence acts as an on/off switch.
92+ // */
93+ // "parameterKind": "flag",
94+ //
95+ // /**
96+ // * (Required) The long name of the parameter. It must be lower-case and use dash delimiters.
97+ // */
98+ // "longName": "--my-flag",
99+ //
100+ // /**
101+ // * An optional alternative short name for the parameter. It must be a dash followed by a single
102+ // * lower-case or upper-case letter, which is case-sensitive.
103+ // *
104+ // * NOTE: The Rush developers recommend that automation scripts should always use the long name
105+ // * to improve readability. The short name is only intended as a convenience for humans.
106+ // * The alphabet letters run out quickly, and are difficult to memorize, so *only* use
107+ // * a short name if you expect the parameter to be needed very often in everyday operations.
108+ // */
109+ // "shortName": "-m",
110+ //
111+ // /**
112+ // * (Required) A long description to be shown in the command-line help.
113+ // *
114+ // * Whenever you introduce commands/parameters, taking a little time to write meaningful
115+ // * documentation can make a big difference for the developer experience in your repo.
116+ // */
117+ // "description": "A custom flag parameter that is passed to the scripts that are invoked when building projects",
118+ //
119+ // /**
120+ // * (Required) A list of custom commands and/or built-in Rush commands that this parameter may
121+ // * be used with. The parameter will be appended to the shell command that Rush invokes.
122+ // */
123+ // "associatedCommands": [ "build", "rebuild" ]
124+ // },
125+ //
126+ // {
127+ // /**
128+ // * (Required) Determines the type of custom parameter.
129+ // * A "flag" is a custom command-line parameter whose presence acts as an on/off switch.
130+ // */
131+ // "parameterKind": "choice",
132+ // "longName": "--my-choice",
133+ // "description": "A custom choice parameter for the \"my-global-command\" custom command",
134+ //
135+ // "associatedCommands": [ "my-global-command" ],
136+ //
137+ // /**
138+ // * Normally if a parameter is omitted from the command line, it will not be passed
139+ // * to the shell command. this value will be inserted by default. Whereas if a "defaultValue"
140+ // * is defined, the parameter will always be passed to the shell command, and will use the
141+ // * default value if unspecified. The value must be one of the defined alternatives.
142+ // */
143+ // "defaultValue": "vanilla",
144+ //
145+ // /**
146+ // * (Required) A list of alternative argument values that can be chosen for this parameter.
147+ // */
148+ // "alternatives": [
149+ // {
150+ // /**
151+ // * A token that is one of the alternatives that can be used with the choice parameter,
152+ // * e.g. "vanilla" in "--flavor vanilla".
153+ // */
154+ // "name": "vanilla",
155+ //
156+ // /**
157+ // * A detailed description for the alternative that can be shown in the command-line help.
158+ // *
159+ // * Whenever you introduce commands/parameters, taking a little time to write meaningful
160+ // * documentation can make a big difference for the developer experience in your repo.
161+ // */
162+ // "description": "Use the vanilla flavor (the default)"
163+ // },
164+ //
165+ // {
166+ // "name": "chocolate",
167+ // "description": "Use the chocolate flavor"
168+ // },
169+ //
170+ // {
171+ // "name": "strawberry",
172+ // "description": "Use the strawberry flavor"
173+ // }
174+ // ]
175+ // }
5176 {
6177 "longName" : " --no-color" ,
7178 "parameterKind" : " flag" ,
15186 "associatedCommands" : [ " build" , " rebuild" ]
16187 }
17188 ]
18- }
189+ }
0 commit comments