-
-
Notifications
You must be signed in to change notification settings - Fork 590
/
cli-flags.js
275 lines (267 loc) · 7.66 KB
/
cli-flags.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
const { packageExists } = require('@webpack-cli/package-utils');
const cli = packageExists('webpack') ? require('webpack').cli : undefined;
const HELP_GROUP = 'help';
const BASIC_GROUP = 'basic';
const ADVANCED_GROUP = 'advanced';
const groups = {
HELP_GROUP,
BASIC_GROUP,
ADVANCED_GROUP,
};
const commands = [
{
name: 'init',
alias: 'c',
type: String,
usage: 'init [scaffold]',
description: 'Initialize a new webpack configuration',
},
{
name: 'migrate',
alias: 'm',
type: String,
usage: 'migrate',
description: 'Migrate a configuration to a new version',
},
{
name: 'loader',
scope: 'external',
alias: 'l',
type: String,
usage: 'loader',
description: 'Scaffold a loader repository',
},
{
name: 'plugin',
alias: 'p',
scope: 'external',
type: String,
usage: 'plugin',
description: 'Scaffold a plugin repository',
},
{
name: 'info',
scope: 'external',
alias: 'i',
type: String,
usage: 'info [options]',
description: 'Outputs information about your system and dependencies',
flags: [
{
name: 'output',
type: String,
description: 'To get the output in specified format ( accept json or markdown )',
},
],
},
{
name: 'serve',
alias: 's',
scope: 'external',
type: String,
usage: 'serve',
description: 'Run the webpack Dev Server',
},
];
const core = [
{
name: 'entry',
usage: '--entry <path to entry file> | --entry <path> --entry <path>',
type: String,
multiple: true,
group: BASIC_GROUP,
description: 'The entry point(s) of your application e.g. ./src/main.js',
link: 'https://webpack.js.org/concepts/#entry',
},
{
name: 'config',
usage: '--config <path to webpack configuration file>',
alias: 'c',
type: String,
multiple: true,
description: 'Provide path to a webpack configuration file e.g. ./webpack.config.js',
link: 'https://webpack.js.org/configuration/',
},
{
name: 'color',
usage: '--color',
type: Boolean,
negative: true,
defaultValue: true,
description: 'Enable/Disable colors on console',
},
{
name: 'merge',
usage: '--merge',
alias: 'm',
type: Boolean,
description: 'Merge two or more configurations using webpack-merge e.g. -c ./webpack.config.js -c ./webpack.test.config.js --merge',
link: 'https://github.com/survivejs/webpack-merge',
},
{
name: 'progress',
usage: '--progress',
type: Boolean,
group: BASIC_GROUP,
description: 'Print compilation progress during build',
},
{
name: 'help',
usage: '--help',
type: Boolean,
group: HELP_GROUP,
description: 'Outputs list of supported flags',
},
{
name: 'output',
usage: '--output <path to output directory>',
alias: 'o',
type: String,
description: 'Output location of the file generated by webpack e.g. ./dist/',
link: 'https://webpack.js.org/concepts/#output',
},
{
name: 'target',
usage: '--target <value>',
alias: 't',
type: String,
group: ADVANCED_GROUP,
multiple: cli !== undefined,
description: 'Sets the build target e.g. node',
link: 'https://webpack.js.org/configuration/target/#target',
},
{
name: 'watch',
usage: '--watch',
type: Boolean,
alias: 'w',
group: BASIC_GROUP,
description: 'Watch for files changes',
link: 'https://webpack.js.org/configuration/watch/',
},
{
name: 'hot',
usage: '--hot',
alias: 'h',
type: Boolean,
negative: true,
group: ADVANCED_GROUP,
description: 'Enables Hot Module Replacement',
link: 'https://webpack.js.org/concepts/hot-module-replacement/',
},
{
name: 'devtool',
usage: '--devtool <value>',
type: String,
alias: 'd',
defaultValue: undefined,
group: BASIC_GROUP,
description: 'Determine source maps to use',
link: 'https://webpack.js.org/configuration/devtool/#devtool',
},
{
name: 'prefetch',
usage: '--prefetch <request>',
type: String,
group: ADVANCED_GROUP,
description: 'Prefetch this request',
link: 'https://webpack.js.org/plugins/prefetch-plugin/',
},
{
name: 'json',
usage: '--json',
type: [String, Boolean],
alias: 'j',
description: 'Prints result as JSON or store it in a file',
},
{
name: 'mode',
usage: '--mode <development | production | none>',
type: String,
description: 'Defines the mode to pass to webpack',
link: 'https://webpack.js.org/concepts/#mode',
},
{
name: 'version',
usage: '--version | --version <external-package>',
alias: 'v',
type: Boolean,
group: HELP_GROUP,
description: 'Get current version',
},
{
name: 'stats',
usage: '--stats <value>',
type: [String, Boolean],
negative: true,
description: 'It instructs webpack on how to treat the stats e.g. verbose',
link: 'https://webpack.js.org/configuration/stats/#stats',
},
{
name: 'env',
usage: '--env',
type: String,
multiple: true,
description: 'Environment passed to the configuration when it is a function',
},
{
name: 'name',
usage: '--name',
type: String,
group: BASIC_GROUP,
description: 'Name of the configuration. Used when loading multiple configurations.',
},
{
name: 'config-name',
usage: '--config-name <name of config>',
type: String,
multiple: true,
description: 'Name of the configuration to use',
},
/* {
name: "analyze",
type: Boolean,
group: BASIC_GROUP,
description: "analyze build for performance improvements"
}, */
/* {
name: "interactive",
type: Boolean,
alias: "i",
description: "Use webpack interactively",
group: BASIC_GROUP
} */
];
// Extract all the flags being exported from core. A list of cli flags generated by core
// can be found here https://github.com/webpack/webpack/blob/master/test/__snapshots__/Cli.test.js.snap
let flagsFromCore =
cli !== undefined
? Object.entries(cli.getArguments()).map(([flag, meta]) => {
if (meta.simpleType === 'string') {
meta.type = String;
meta.usage = `--${flag} <value>`;
} else if (meta.simpleType === 'number') {
meta.type = Number;
meta.usage = `--${flag} <value>`;
} else {
meta.type = Boolean;
meta.negative = true;
meta.usage = `--${flag}`;
}
return {
...meta,
name: flag,
group: 'core',
};
})
: [];
// duplicate flags
const duplicateFlags = core.map((flag) => flag.name);
// remove duplicate flags
flagsFromCore = flagsFromCore.filter((flag) => !duplicateFlags.includes(flag.name));
module.exports = {
groups,
commands,
core: [...core, ...flagsFromCore],
flagsFromCore,
};