<!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>[41974] trunk/src: Code Editor: Keep linting and its error reporting configured when `lint` option is changed dynamically.</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="https://core.trac.wordpress.org/changeset/41974">41974</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/41974","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-23 19:54:33 +0000 (Mon, 23 Oct 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'>Code Editor: Keep linting and its error reporting configured when `lint` option is changed dynamically.
Also explicitly disable `lint` option for SCSS and LESS.
See <a href="https://core.trac.wordpress.org/ticket/12423">#12423</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscodeeditorjs">trunk/src/wp-admin/js/code-editor.js</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscodeeditorjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/code-editor.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/code-editor.js 2017-10-23 18:57:46 UTC (rev 41973)
+++ trunk/src/wp-admin/js/code-editor.js 2017-10-23 19:54:33 UTC (rev 41974)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -36,92 +36,124 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @returns {void}
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function configureLinting( editor, settings ) { // eslint-disable-line complexity
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var lintOptions = editor.getOption( 'lint' ), currentErrorAnnotations = [], updateErrorNotice, previouslyShownErrorAnnotations = [];
- if ( ! lintOptions ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var currentErrorAnnotations = [], previouslyShownErrorAnnotations = [];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( true === lintOptions ) {
- lintOptions = {};
- } else {
- lintOptions = $.extend( {}, lintOptions );
- }
-
- // Note that rules must be sent in the "deprecated" lint.options property to prevent linter from complaining about unrecognized options. See <https://github.com/codemirror/CodeMirror/pull/4944>.
- if ( ! lintOptions.options ) {
- lintOptions.options = {};
- }
-
- // Configure JSHint.
- if ( 'javascript' === settings.codemirror.mode && settings.jshint ) {
- $.extend( lintOptions.options, settings.jshint );
- }
-
- // Configure CSSLint.
- if ( 'css' === settings.codemirror.mode && settings.csslint ) {
- $.extend( lintOptions.options, settings.csslint );
- }
-
- // Configure HTMLHint.
- if ( 'htmlmixed' === settings.codemirror.mode && settings.htmlhint ) {
- lintOptions.options.rules = $.extend( {}, settings.htmlhint );
-
- if ( settings.jshint ) {
- lintOptions.options.rules.jshint = settings.jshint;
- }
- if ( settings.csslint ) {
- lintOptions.options.rules.csslint = settings.csslint;
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Call the onUpdateErrorNotice if there are new errors to show.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @returns {void}
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- updateErrorNotice = function() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function updateErrorNotice() {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( settings.onUpdateErrorNotice && ! _.isEqual( currentErrorAnnotations, previouslyShownErrorAnnotations ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.onUpdateErrorNotice( currentErrorAnnotations, editor );
</span><span class="cx" style="display: block; padding: 0 10px"> previouslyShownErrorAnnotations = currentErrorAnnotations;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- };
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Wrap the onUpdateLinting CodeMirror event to route to onChangeLintingErrors and onUpdateErrorNotice.
- lintOptions.onUpdateLinting = (function( onUpdateLintingOverridden ) {
- return function( annotations, annotationsSorted, cm ) {
- var errorAnnotations = _.filter( annotations, function( annotation ) {
- return 'error' === annotation.severity;
- } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Get lint options.
+ *
+ * @returns {object} Lint options.
+ */
+ function getLintOptions() { // eslint-disable-line complexity
+ var options = editor.getOption( 'lint' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( onUpdateLintingOverridden ) {
- onUpdateLintingOverridden.apply( annotations, annotationsSorted, cm );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! options ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Skip if there are no changes to the errors.
- if ( _.isEqual( errorAnnotations, currentErrorAnnotations ) ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( true === options ) {
+ options = {};
+ } else if ( _.isObject( options ) ) {
+ options = $.extend( {}, options );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- currentErrorAnnotations = errorAnnotations;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Note that rules must be sent in the "deprecated" lint.options property to prevent linter from complaining about unrecognized options. See <https://github.com/codemirror/CodeMirror/pull/4944>.
+ if ( ! options.options ) {
+ options.options = {};
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( settings.onChangeLintingErrors ) {
- settings.onChangeLintingErrors( errorAnnotations, annotations, annotationsSorted, cm );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Configure JSHint.
+ if ( 'javascript' === settings.codemirror.mode && settings.jshint ) {
+ $.extend( options.options, settings.jshint );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Update notifications when the editor is not focused to prevent error message
- * from overwhelming the user during input, unless there are now no errors or there
- * were previously errors shown. In these cases, update immediately so they can know
- * that they fixed the errors.
- */
- if ( ! cm.state.focused || 0 === currentErrorAnnotations.length || previouslyShownErrorAnnotations.length > 0 ) {
- updateErrorNotice();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Configure CSSLint.
+ if ( 'css' === settings.codemirror.mode && settings.csslint ) {
+ $.extend( options.options, settings.csslint );
+ }
+
+ // Configure HTMLHint.
+ if ( 'htmlmixed' === settings.codemirror.mode && settings.htmlhint ) {
+ options.options.rules = $.extend( {}, settings.htmlhint );
+
+ if ( settings.jshint ) {
+ options.options.rules.jshint = settings.jshint;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- };
- })( lintOptions.onUpdateLinting );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( settings.csslint ) {
+ options.options.rules.csslint = settings.csslint;
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- editor.setOption( 'lint', lintOptions );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Wrap the onUpdateLinting CodeMirror event to route to onChangeLintingErrors and onUpdateErrorNotice.
+ options.onUpdateLinting = (function( onUpdateLintingOverridden ) {
+ return function( annotations, annotationsSorted, cm ) {
+ var errorAnnotations = _.filter( annotations, function( annotation ) {
+ return 'error' === annotation.severity;
+ } );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( onUpdateLintingOverridden ) {
+ onUpdateLintingOverridden.apply( annotations, annotationsSorted, cm );
+ }
+
+ // Skip if there are no changes to the errors.
+ if ( _.isEqual( errorAnnotations, currentErrorAnnotations ) ) {
+ return;
+ }
+
+ currentErrorAnnotations = errorAnnotations;
+
+ if ( settings.onChangeLintingErrors ) {
+ settings.onChangeLintingErrors( errorAnnotations, annotations, annotationsSorted, cm );
+ }
+
+ /*
+ * Update notifications when the editor is not focused to prevent error message
+ * from overwhelming the user during input, unless there are now no errors or there
+ * were previously errors shown. In these cases, update immediately so they can know
+ * that they fixed the errors.
+ */
+ if ( ! editor.state.focused || 0 === currentErrorAnnotations.length || previouslyShownErrorAnnotations.length > 0 ) {
+ updateErrorNotice();
+ }
+ };
+ })( options.onUpdateLinting );
+
+ return options;
+ }
+
+ editor.setOption( 'lint', getLintOptions() );
+
+ // Keep lint options populated.
+ editor.on( 'optionChange', function( cm, option ) {
+ var options;
+ if ( 'lint' !== option ) {
+ return;
+ }
+ options = editor.getOption( 'lint' );
+ if ( true === options ) {
+ editor.setOption( 'lint', getLintOptions() ); // Expand to include linting options.
+ }
+
+ // Force update on error notice to show or hide.
+ if ( editor.getOption( 'lint' ) ) {
+ editor.performLint();
+ } else {
+ currentErrorAnnotations = [];
+ updateErrorNotice();
+ }
+ } );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Update error notice when leaving the editor.
</span><span class="cx" style="display: block; padding: 0 10px"> editor.on( 'blur', updateErrorNotice );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2017-10-23 18:57:46 UTC (rev 41973)
+++ trunk/src/wp-includes/general-template.php 2017-10-23 19:54:33 UTC (rev 41974)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3311,6 +3311,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'text/x-scss' === $type || 'text/x-less' === $type || 'text/x-sass' === $type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $settings['codemirror'] = array_merge( $settings['codemirror'], array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'mode' => $type,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'lint' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'autoCloseBrackets' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'matchBrackets' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span></span></pre>
</div>
</div>
</body>
</html>