-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
CompletionShell.php
173 lines (156 loc) · 4.75 KB
/
CompletionShell.php
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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP Project
* @since 2.5.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Shell;
use Cake\Console\Shell;
/**
* Provide command completion shells such as bash.
*
* @property \Cake\Shell\Task\CommandTask $Command
*/
class CompletionShell extends Shell
{
/**
* Contains tasks to load and instantiate
*
* @var array
*/
public $tasks = ['Command'];
/**
* Echo no header by overriding the startup method
*
* @return void
*/
public function startup()
{
}
/**
* Not called by the autocomplete shell - this is for curious users
*
* @return int|bool Returns the number of bytes returned from writing to stdout.
*/
public function main()
{
return $this->out($this->getOptionParser()->help());
}
/**
* list commands
*
* @return int|bool|null Returns the number of bytes returned from writing to stdout.
*/
public function commands()
{
$options = $this->Command->commands();
return $this->_output($options);
}
/**
* list options for the named command
*
* @return int|bool|null Returns the number of bytes returned from writing to stdout.
*/
public function options()
{
$commandName = $subCommandName = '';
if (!empty($this->args[0])) {
$commandName = $this->args[0];
}
if (!empty($this->args[1])) {
$subCommandName = $this->args[1];
}
$options = $this->Command->options($commandName, $subCommandName);
return $this->_output($options);
}
/**
* list subcommands for the named command
*
* @return int|bool|null Returns the number of bytes returned from writing to stdout.
*/
public function subcommands()
{
if (!$this->args) {
return $this->_output();
}
$options = $this->Command->subCommands($this->args[0]);
return $this->_output($options);
}
/**
* Guess autocomplete from the whole argument string
*
* @return int|bool|null Returns the number of bytes returned from writing to stdout.
*/
public function fuzzy()
{
return $this->_output();
}
/**
* Gets the option parser instance and configures it.
*
* @return \Cake\Console\ConsoleOptionParser
*/
public function getOptionParser()
{
$parser = parent::getOptionParser();
$parser->setDescription(
'Used by shells like bash to autocomplete command name, options and arguments'
)->addSubcommand('commands', [
'help' => 'Output a list of available commands',
'parser' => [
'description' => 'List all available',
]
])->addSubcommand('subcommands', [
'help' => 'Output a list of available subcommands',
'parser' => [
'description' => 'List subcommands for a command',
'arguments' => [
'command' => [
'help' => 'The command name',
'required' => false,
]
]
]
])->addSubcommand('options', [
'help' => 'Output a list of available options',
'parser' => [
'description' => 'List options',
'arguments' => [
'command' => [
'help' => 'The command name',
'required' => false,
],
'subcommand' => [
'help' => 'The subcommand name',
'required' => false,
]
]
]
])->addSubcommand('fuzzy', [
'help' => 'Guess autocomplete'
])->setEpilog([
'This command is not intended to be called manually',
]);
return $parser;
}
/**
* Emit results as a string, space delimited
*
* @param array $options The options to output
* @return int|bool|null Returns the number of bytes returned from writing to stdout.
*/
protected function _output($options = [])
{
if ($options) {
return $this->out(implode($options, ' '));
}
}
}