MkCommands
final class MkCommands extends DrushCommands implements SiteAliasManagerAwareInterface (View source)
Traits
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
Properties
| protected CommandData|null | $commandData | from DrushCommands |
Methods
Starts a background browser/tab for the current site or a specified URL.
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
No description
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
No description
Build a Markdown document for each available Drush command/generator.
Convert generators into Annotated commands (for Help).
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Empty target directories.
Build an array since that's what HelpCLIFormatter expects.
Build an array since that's what HelpCLIFormatter expects.
Convert text like
Write content files, add to nav, build a redirect map.
No description
Get a filename from a command.
Details
bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)
Starts a background browser/tab for the current site or a specified URL.
Uses a non-blocking Process call, so Drush execution will continue.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
DrushConfig
getConfig()
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
protected
__construct(ContainerInterface $container, ContainerInterface $drush_container)
No description
protected SymfonyStyle
io()
Override Robo's IO function with our custom style.
protected DrushLoggerManager|null
logger()
Returns a logger object.
protected void
printFile(string $file)
Print the contents of a file.
preHook(CommandData $commandData)
Persist commandData for use in primary command callback. Used by 'topic' commands.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
static MkCommands
create(ContainerInterface $container, ContainerInterface $drush_container)
No description
void
docs()
Build a Markdown document for each available Drush command/generator.
This command is an early step when building the www.drush.org static site. Adapt it to build a similar site listing the commands that are available on your site. Also see Drush's Github Actions workflow.
array
createAnnotatedCommands(Application $application_generate, Application $application_drush)
Convert generators into Annotated commands (for Help).
static protected string
appendPostAmble()
No description
static protected string
appendAliases($command)
No description
static protected string
appendTopics(AnnotatedCommand $command, string $dir_commands)
No description
static protected string
appendOptions($command)
No description
static protected string
appendOptionsGlobal($application)
No description
static protected string
appendArguments($command)
No description
static protected string
appendUsages(AnnotatedCommand $command)
No description
static protected string
appendPreamble($command, $root)
No description
protected void
writeYml(array $nav_commands, array $nav_generators, array $map_commands, array $map_generators, string $dest)
No description
protected void
writeAllMd(array $pages_all, string $destination_path, string $title)
No description
protected void
prepare($destination)
Empty target directories.
static iterable
argToArray(InputArgument $arg)
Build an array since that's what HelpCLIFormatter expects.
static iterable
optionToArray(InputOption $opt)
Build an array since that's what HelpCLIFormatter expects.
static string
cliTextToMarkdown(string $text)
Convert text like
array
writeContentFilesAndBuildNavAndBuildRedirectMap(array $namespaced, string $destination, string $dir_root, string $destination_path)
Write content files, add to nav, build a redirect map.
protected array
getRedirectMap(Command $command, string $destination)
No description
string
getFilename(string $name)
Get a filename from a command.