Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F3282480
ArcanistHelpWorkflow.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Award Token
Flag For Later
Advanced/Developer...
View Handle
View Hovercard
Size
5 KB
Referenced Files
None
Subscribers
None
ArcanistHelpWorkflow.php
View Options
<?php
/*
* Copyright 2012 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Seduces the reader with majestic prose.
*
* @group workflow
*/
final
class
ArcanistHelpWorkflow
extends
ArcanistBaseWorkflow
{
public
function
getCommandSynopses
(
)
{
return
phutil_console_format
(
<<<EOTEXT
**help** [__command__]
**help** --full
EOTEXT
)
;
}
public
function
getCommandHelp
(
)
{
return
phutil_console_format
(
<<<EOTEXT
Supports: english
Shows this help. With __command__, shows help about a specific
command.
EOTEXT
)
;
}
public
function
getArguments
(
)
{
return
array
(
'full'
=>
array
(
'help'
=>
'Print detailed information about each command.'
,
)
,
'*'
=>
'command'
,
)
;
}
public
function
run
(
)
{
$arc_config
=
$this
->
getArcanistConfiguration
(
)
;
$workflows
=
$arc_config
->
buildAllWorkflows
(
)
;
ksort
(
$workflows
)
;
$target
=
null
;
if
(
$this
->
getArgument
(
'command'
)
)
{
$target
=
head
(
$this
->
getArgument
(
'command'
)
)
;
if
(
empty
(
$workflows
[
$target
]
)
)
{
throw
new
ArcanistUsageException
(
"Unrecognized command '{$target}'. Try 'arc help'."
)
;
}
}
$cmdref
=
array
(
)
;
foreach
(
$workflows
as
$command
=>
$workflow
)
{
if
(
$target
&&
$target
!=
$command
)
{
continue
;
}
if
(
!
$target
&&
!
$this
->
getArgument
(
'full'
)
)
{
$cmdref
[
]
=
$workflow
->
getCommandSynopses
(
)
;
continue
;
}
$optref
=
array
(
)
;
$arguments
=
$workflow
->
getArguments
(
)
;
$config_arguments
=
$arc_config
->
getCustomArgumentsForCommand
(
$command
)
;
// This juggling is to put the extension arguments after the normal
// arguments, and make sure the normal arguments aren't overwritten.
ksort
(
$arguments
)
;
ksort
(
$config_arguments
)
;
foreach
(
$config_arguments
as
$argument
=>
$spec
)
{
if
(
empty
(
$arguments
[
$argument
]
)
)
{
$arguments
[
$argument
]
=
$spec
;
}
}
foreach
(
$arguments
as
$argument
=>
$spec
)
{
if
(
$argument
==
'*'
)
{
continue
;
}
if
(
!
empty
(
$spec
[
'hide'
]
)
)
{
continue
;
}
if
(
isset
(
$spec
[
'param'
]
)
)
{
if
(
isset
(
$spec
[
'short'
]
)
)
{
$optref
[
]
=
phutil_console_format
(
" __--%s__ __%s__, __-%s__ __%s__"
,
$argument
,
$spec
[
'param'
]
,
$spec
[
'short'
]
,
$spec
[
'param'
]
)
;
}
else
{
$optref
[
]
=
phutil_console_format
(
" __--%s__ __%s__"
,
$argument
,
$spec
[
'param'
]
)
;
}
}
else
{
if
(
isset
(
$spec
[
'short'
]
)
)
{
$optref
[
]
=
phutil_console_format
(
" __--%s__, __-%s__"
,
$argument
,
$spec
[
'short'
]
)
;
}
else
{
$optref
[
]
=
phutil_console_format
(
" __--%s__"
,
$argument
)
;
}
}
if
(
isset
(
$config_arguments
[
$argument
]
)
)
{
$optref
[
]
=
" (This is a custom option for this "
.
"project.)"
;
}
if
(
isset
(
$spec
[
'supports'
]
)
)
{
$optref
[
]
=
" Supports: "
.
implode
(
', '
,
$spec
[
'supports'
]
)
;
}
if
(
isset
(
$spec
[
'help'
]
)
)
{
$docs
=
$spec
[
'help'
]
;
}
else
{
$docs
=
'This option is not documented.'
;
}
$docs
=
phutil_console_wrap
(
$docs
,
14
)
;
$optref
[
]
=
"{$docs}\n"
;
}
if
(
$optref
)
{
$optref
=
implode
(
"\n"
,
$optref
)
;
$optref
=
"\n\n"
.
$optref
;
}
else
{
$optref
=
"\n"
;
}
$cmdref
[
]
=
$workflow
->
getCommandSynopses
(
)
.
"\n"
.
$workflow
->
getCommandHelp
(
)
.
$optref
;
}
$cmdref
=
implode
(
"\n\n"
,
$cmdref
)
;
if
(
$target
)
{
echo
"\n"
.
$cmdref
.
"\n"
;
return
;
}
$self
=
'arc'
;
echo
phutil_console_format
(
<<<EOTEXT
**NAME**
**{$self}** - arcanist, a code review and revision management utility
**SYNOPSIS**
**{$self}** __command__ [__options__] [__args__]
This help file provides a detailed command reference.
**COMMAND REFERENCE**
{$cmdref}
EOTEXT
)
;
if
(
!
$this
->
getArgument
(
'full'
)
)
{
echo
"Run 'arc help --full' to get commands and options descriptions.\n"
;
return
;
}
echo
phutil_console_format
(
<<<EOTEXT
**OPTION REFERENCE**
__--trace__
Debugging command. Shows underlying commands as they are executed,
and full stack traces when exceptions are thrown.
__--no-ansi__
Output in plain ASCII text only, without color or style.
__--ansi__
Use formatting even in environments which probably don't support it.
Example: arc --ansi unit | less -r
__--load-phutil-library=/path/to/library__
Ignore libraries listed in .arcconfig and explicitly load specified
libraries instead. Mostly useful for Arcanist development.
__--conduit-uri__ __uri__
Ignore configured Conduit URI and use an explicit one instead. Mostly
useful for Arcanist development.
__--conduit-version__ __version__
Ignore software version and claim to be running some other version
instead. Mostly useful for Arcanist development. May cause bad things
to happen.
__--conduit-timeout__ __timeout__
Override the default Conduit timeout. Specified in seconds.
EOTEXT
)
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Mon, Mar 24, 08:07 (1 w, 4 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1259474
Default Alt Text
ArcanistHelpWorkflow.php (5 KB)
Attached To
Mode
rARC Arcanist
Attached
Detach File
Event Timeline
Log In to Comment