blob: 4a75cf2625d6f125c475c23d3729ea3e8db97173 [file] [log] [blame]
Leo Repp58b9f112021-11-22 11:57:47 +01001var path = require('path');
2
3module.exports = {
4 help: {
5 short: 'h',
6 info: 'Display this help text.',
7 type: Boolean
8 },
9 base: {
10 short: 'b',
11 info: 'Specify an alternate base path. By default, all file paths are relative to the Gruntfile. ' +
12 '(grunt.file.setBase) *',
13 type: path
14 },
15 color: {
16 info: 'Disable colored output.',
17 type: Boolean,
18 negate: true
19 },
20 gruntfile: {
21 info: 'Specify an alternate Gruntfile. By default, grunt looks in the current or parent directories ' +
22 'for the nearest Gruntfile.js or Gruntfile.coffee file.',
23 type: path
24 },
25 debug: {
26 short: 'd',
27 info: 'Enable debugging mode for tasks that support it.',
28 type: [Number, Boolean]
29 },
30 stack: {
31 info: 'Print a stack trace when exiting with a warning or fatal error.',
32 type: Boolean
33 },
34 force: {
35 short: 'f',
36 info: 'A way to force your way past warnings. Want a suggestion? Don\'t use this option, fix your code.',
37 type: Boolean
38 },
39 tasks: {
40 info: 'Additional directory paths to scan for task and "extra" files. (grunt.loadTasks) *',
41 type: Array
42 },
43 npm: {
44 info: 'Npm-installed grunt plugins to scan for task and "extra" files. (grunt.loadNpmTasks) *',
45 type: Array
46 },
47 write: {
48 info: 'Disable writing files (dry run).',
49 type: Boolean,
50 negate: true
51 },
52 verbose: {
53 short: 'v',
54 info: 'Verbose mode. A lot more information output.',
55 type: Boolean
56 },
57 version: {
58 short: 'V',
59 info: 'Print the grunt version. Combine with --verbose for more info.',
60 type: Boolean
61 },
62 // Even though shell auto-completion is now handled by grunt-cli, leave this
63 // option here for display in the --help screen.
64 completion: {
65 info: 'Output shell auto-completion rules. See the grunt-cli documentation for more information.',
66 type: String
67 },
68 require: {
69 info: 'Specify a language interpreter to require first if you are writing your Gruntfile in ' +
70 'a language Grunt doesn\'t support by default.',
71 type: String
72 },
73};