<!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>[53314] trunk/Gruntfile.js: Docs: Adjust comments in `Gruntfile.js` per the documentation standards.</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 { white-space: pre-line; 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="https://core.trac.wordpress.org/changeset/53314">53314</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53314","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-29 14:44:15 +0000 (Fri, 29 Apr 2022)</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'>Docs: Adjust comments in `Gruntfile.js` per the documentation standards.
See <a href="https://core.trac.wordpress.org/ticket/54729">#54729</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkGruntfilejs">trunk/Gruntfile.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkGruntfilejs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/Gruntfile.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/Gruntfile.js 2022-04-29 14:35:01 UTC (rev 53313)
+++ trunk/Gruntfile.js 2022-04-29 14:44:15 UTC (rev 53314)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -516,8 +516,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-admin/css/*.css',
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-includes/css/*.css',
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Exclude minified and already processed files, and files from external packages.
- // These are present when running `grunt build` after `grunt --dev`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Exclude minified and already processed files, and files from external packages.
+ * These are present when running `grunt build` after `grunt --dev`.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> '!wp-admin/css/*-rtl.css',
</span><span class="cx" style="display: block; padding: 0 10px"> '!wp-includes/css/*-rtl.css',
</span><span class="cx" style="display: block; padding: 0 10px"> '!wp-admin/css/*.min.css',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1218,19 +1220,21 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'sync-gutenberg-packages', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( grunt.option( 'update-browserlist' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Updating the browserlist database is opt-in and up to the release lead.
- //
- // Browserlist database should be updated:
- // * In each release cycle up until RC1
- // * If Webpack throws a warning about an outdated database
- //
- // It should not be updated:
- // * After the RC1
- // * When backporting fixes to older WordPress releases.
- //
- // For more context, see:
- // https://github.com/WordPress/wordpress-develop/pull/2621#discussion_r859840515
- // https://core.trac.wordpress.org/ticket/55559
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Updating the browserlist database is opt-in and up to the release lead.
+ *
+ * Browserlist database should be updated:
+ * - In each release cycle up until RC1
+ * - If Webpack throws a warning about an outdated database
+ *
+ * It should not be updated:
+ * - After the RC1
+ * - When backporting fixes to older WordPress releases.
+ *
+ * For more context, see:
+ * https://github.com/WordPress/wordpress-develop/pull/2621#discussion_r859840515
+ * https://core.trac.wordpress.org/ticket/55559
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> grunt.task.run( 'browserslist:update' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1237,8 +1241,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Install the latest version of the packages already listed in package.json.
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.task.run( 'wp-packages:update' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Install any new @wordpress packages that are now required.
- // Update any non-@wordpress deps to the same version as required in the @wordpress packages (e.g. react 16 -> 17).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Install any new @wordpress packages that are now required.
+ * Update any non-@wordpress deps to the same version as required in the @wordpress packages (e.g. react 16 -> 17).
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> grunt.task.run( 'wp-packages:refresh-deps' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Build the files stored in the src/ directory.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1517,12 +1523,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> const files = match[1].split( '\n\t' ).filter( function( file ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Filter out empty lines
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Filter out empty lines.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( '' === file ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // Filter out commented out lines
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Filter out commented out lines.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 0 === file.indexOf( '/' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1529,7 +1535,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> } ).map( function( file ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Strip leading and trailing single quotes and commas
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Strip leading and trailing single quotes and commas.
</ins><span class="cx" style="display: block; padding: 0 10px"> return file.replace( /^\'|\',$/g, '' );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>