<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[6191] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php: devhub/cli: Prepend installation instructions when applicable</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/6191">6191</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/6191","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>danielbachhuber</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-11-29 18:36:26 +0000 (Wed, 29 Nov 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>devhub/cli: Prepend installation instructions when applicable
See https://github.com/wp-cli/wp-cli/issues/4282</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinccliphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinccliphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php 2017-11-29 17:45:26 UTC (rev 6190)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php 2017-11-29 18:36:26 UTC (rev 6191)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,6 +6,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private static $meta_key = 'wporg_cli_markdown_source';
</span><span class="cx" style="display: block; padding: 0 10px"> private static $supported_post_types = array( 'command' );
</span><span class="cx" style="display: block; padding: 0 10px"> private static $posts_per_page = 350;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private static $non_bundled_commands = array(
+ 'https://github.com/wp-cli/admin-command',
+ 'https://github.com/wp-cli/dist-archive-command',
+ 'https://github.com/wp-cli/doctor-command',
+ 'https://github.com/wp-cli/find-command',
+ 'https://github.com/wp-cli/profile-command',
+ 'https://github.com/wp-cli/scaffold-package-command',
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function init() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'init', array( __CLASS__, 'action_init_register_cron_jobs' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -273,7 +281,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $breadcrumbs;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = self::append_subcommands( get_queried_object()->post_content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = get_queried_object()->post_content;
+ $content = self::prepend_installation( $content );
+ $content = self::append_subcommands( $content );
</ins><span class="cx" style="display: block; padding: 0 10px"> $items = self::get_tags( 'h([1-4])', $content );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( count( $items ) > 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $quick_links = '<span class="quick-links">(';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -302,6 +312,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Transform HTML entity artifacts back to their original
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '&#039;', '\'', $content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = self::prepend_installation( $content );
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = self::append_subcommands( $content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $repo_url = get_post_meta( get_the_ID(), 'repo_url', true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -365,6 +376,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $content;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static function prepend_installation( $content ) {
+ $repo_url = get_post_meta( get_the_ID(), 'repo_url', true );
+
+ // Only non-bundled commands
+ if ( ! in_array( $repo_url, self::$non_bundled_commands, true ) ) {
+ return;
+ }
+ $repo_slug = str_replace( 'https://github.com/', '', $repo_url );
+ ob_start(); ?>
+ <h3>INSTALLING</h3>
+
+ <p>Use the <code><?php the_title(); ?></code> command by installing the command's package:</p>
+
+ <pre><code>wp package install <?php echo esc_html( $repo_slug ); ?></code></pre>
+
+ <p>Once the package is successfully installed, the <code><?php the_title(); ?></code> command will appear in the list of available commands.</p>
+ <?php
+ $installing_instructions = ob_get_clean();
+ // Insert before OPTIONS but after description if OPTIONS exists
+ $options_match = '#<h3>OPTIONS<\/h3>#';
+ if ( preg_match( $options_match, $content ) ) {
+ $content = preg_replace( $options_match, $installing_instructions . '$0', $content );
+ } else {
+ // Otherwise, appending to description is fine.
+ $content .= $installing_instructions;
+ }
+ return $content;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static function append_subcommands( $content ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $children = get_children( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_parent' => get_the_ID(),
</span></span></pre>
</div>
</div>
</body>
</html>