<!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>[175628] trunk/Source/WebInspectorUI</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">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/175628">175628</a></dd>
<dt>Author</dt> <dd>jonowells@apple.com</dd>
<dt>Date</dt> <dd>2014-11-05 10:43:30 -0800 (Wed, 05 Nov 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Web Inspector: Add infrastructure for eslint based static analyzer
https://bugs.webkit.org/show_bug.cgi?id=137890
Reviewed by Timothy Hatcher.
Adding a manager to analyze source code, return warnings (AnalyzerMessages), and cache warnings.
* UserInterface/Base/Main.js: Create analyzerManager singleton.
* UserInterface/Controllers/AnalyzerManager.js: Added.
(WebInspector.AnalyzerManager):
(set WebInspector.AnalyzerManager.prototype.getAnalyzerMessagesForSourceCode.):
(set WebInspector.AnalyzerManager.prototype.getAnalyzerMessagesForSourceCode):
(set WebInspector.AnalyzerManager.prototype.set get sourceCodeCanBeAnalyzed):
(set WebInspector.AnalyzerManager.prototype._handleSourceCodeContentDidChange):
* UserInterface/Main.html: Add new files.
* UserInterface/Models/AnalyzerMessage.js: Added.
(WebInspector.AnalyzerMessage):
(WebInspector.AnalyzerMessage.prototype.get sourceCodeLocation):
(WebInspector.AnalyzerMessage.prototype.get sourceCode):
(WebInspector.AnalyzerMessage.prototype.get text):
(WebInspector.AnalyzerMessage.prototype.get ruleIdentifier):
* UserInterface/Models/SourceCode.js: Added call to WebInspector.Object.addConstructorFunctions().</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebInspectorUIChangeLog">trunk/Source/WebInspectorUI/ChangeLog</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceBaseMainjs">trunk/Source/WebInspectorUI/UserInterface/Base/Main.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceMainhtml">trunk/Source/WebInspectorUI/UserInterface/Main.html</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceModelsSourceCodejs">trunk/Source/WebInspectorUI/UserInterface/Models/SourceCode.js</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceControllersAnalyzerManagerjs">trunk/Source/WebInspectorUI/UserInterface/Controllers/AnalyzerManager.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceModelsAnalyzerMessagejs">trunk/Source/WebInspectorUI/UserInterface/Models/AnalyzerMessage.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebInspectorUIChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/ChangeLog (175627 => 175628)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/ChangeLog 2014-11-05 18:43:19 UTC (rev 175627)
+++ trunk/Source/WebInspectorUI/ChangeLog 2014-11-05 18:43:30 UTC (rev 175628)
</span><span class="lines">@@ -1,3 +1,28 @@
</span><ins>+2014-11-05 Jonathan Wells <jonowells@apple.com>
+
+ Web Inspector: Add infrastructure for eslint based static analyzer
+ https://bugs.webkit.org/show_bug.cgi?id=137890
+
+ Reviewed by Timothy Hatcher.
+
+ Adding a manager to analyze source code, return warnings (AnalyzerMessages), and cache warnings.
+
+ * UserInterface/Base/Main.js: Create analyzerManager singleton.
+ * UserInterface/Controllers/AnalyzerManager.js: Added.
+ (WebInspector.AnalyzerManager):
+ (set WebInspector.AnalyzerManager.prototype.getAnalyzerMessagesForSourceCode.):
+ (set WebInspector.AnalyzerManager.prototype.getAnalyzerMessagesForSourceCode):
+ (set WebInspector.AnalyzerManager.prototype.set get sourceCodeCanBeAnalyzed):
+ (set WebInspector.AnalyzerManager.prototype._handleSourceCodeContentDidChange):
+ * UserInterface/Main.html: Add new files.
+ * UserInterface/Models/AnalyzerMessage.js: Added.
+ (WebInspector.AnalyzerMessage):
+ (WebInspector.AnalyzerMessage.prototype.get sourceCodeLocation):
+ (WebInspector.AnalyzerMessage.prototype.get sourceCode):
+ (WebInspector.AnalyzerMessage.prototype.get text):
+ (WebInspector.AnalyzerMessage.prototype.get ruleIdentifier):
+ * UserInterface/Models/SourceCode.js: Added call to WebInspector.Object.addConstructorFunctions().
+
</ins><span class="cx"> 2014-11-04 Joseph Pecoraro <pecoraro@apple.com>
</span><span class="cx">
</span><span class="cx"> Web Inspector: Too much whitespace in resource details sidebar in groups
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceBaseMainjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Base/Main.js (175627 => 175628)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Base/Main.js 2014-11-05 18:43:19 UTC (rev 175627)
+++ trunk/Source/WebInspectorUI/UserInterface/Base/Main.js 2014-11-05 18:43:30 UTC (rev 175628)
</span><span class="lines">@@ -1,5 +1,5 @@
</span><span class="cx"> /*
</span><del>- * Copyright (C) 2013 Apple Inc. All rights reserved.
</del><ins>+ * Copyright (C) 2013-2014 Apple Inc. All rights reserved.
</ins><span class="cx"> *
</span><span class="cx"> * Redistribution and use in source and binary forms, with or without
</span><span class="cx"> * modification, are permitted provided that the following conditions
</span><span class="lines">@@ -100,6 +100,7 @@
</span><span class="cx"> this.cssStyleManager = new WebInspector.CSSStyleManager;
</span><span class="cx"> this.logManager = new WebInspector.LogManager;
</span><span class="cx"> this.issueManager = new WebInspector.IssueManager;
</span><ins>+ this.analyzerManager = new WebInspector.AnalyzerManager;
</ins><span class="cx"> this.runtimeManager = new WebInspector.RuntimeManager;
</span><span class="cx"> this.applicationCacheManager = new WebInspector.ApplicationCacheManager;
</span><span class="cx"> this.timelineManager = new WebInspector.TimelineManager;
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceControllersAnalyzerManagerjs"></a>
<div class="addfile"><h4>Added: trunk/Source/WebInspectorUI/UserInterface/Controllers/AnalyzerManager.js (0 => 175628)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Controllers/AnalyzerManager.js (rev 0)
+++ trunk/Source/WebInspectorUI/UserInterface/Controllers/AnalyzerManager.js 2014-11-05 18:43:30 UTC (rev 175628)
</span><span class="lines">@@ -0,0 +1,122 @@
</span><ins>+/*
+ * Copyright (C) 2014 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+WebInspector.AnalyzerManager = function()
+{
+ WebInspector.Object.call(this);
+
+ this._eslintConfig = {
+ env: {
+ "browser": true,
+ "node": false
+ },
+ globals: {
+ "document": true
+ },
+ rules: {
+ "consistent-return": 2,
+ "curly": 0,
+ "eqeqeq": 0,
+ "new-parens": 0,
+ "no-comma-dangle": 0,
+ "no-console": 0,
+ "no-constant-condition": 0,
+ "no-extra-bind": 2,
+ "no-extra-semi": 2,
+ "no-proto": 0,
+ "no-return-assign": 2,
+ "no-trailing-spaces": 2,
+ "no-underscore-dangle": 0,
+ "no-unused-expressions": 2,
+ "no-wrap-func": 2,
+ "semi": 2,
+ "space-infix-ops": 2,
+ "space-return-throw-case": 2,
+ "strict": 0,
+ "valid-typeof": 2
+ }
+ };
+
+ this._sourceCodeMessagesMap = new WeakMap;
+
+ WebInspector.SourceCode.addEventListener(WebInspector.SourceCode.Event.ContentDidChange, this._handleSourceCodeContentDidChange, this);
+};
+
+WebInspector.AnalyzerManager._typeAnalyzerMap = new Map;
+WebInspector.AnalyzerManager._typeAnalyzerMap.set(WebInspector.Resource.Type.Script, eslint);
+
+WebInspector.AnalyzerManager.prototype = {
+ constructor: WebInspector.AnalyzerManager,
+ __proto__: WebInspector.Object.prototype,
+
+ // Public
+
+ getAnalyzerMessagesForSourceCode: function(sourceCode)
+ {
+ return new Promise(function(resolve, reject) {
+ var analyzer = WebInspector.AnalyzerManager._typeAnalyzerMap.get(sourceCode.type);
+ if (!analyzer) {
+ reject(new Error("This resource type cannot be analyzed."));
+ return;
+ }
+
+ if (this._sourceCodeMessagesMap.has(sourceCode)) {
+ resolve(this._sourceCodeMessagesMap.get(sourceCode));
+ return;
+ }
+
+ function retrieveAnalyzerMessages()
+ {
+ var analyzerMessages = [];
+ var rawAnalyzerMessages = analyzer.verify(sourceCode.content, this._eslintConfig);
+
+ // Raw line and column numbers are one-based. SourceCodeLocation expects them to be zero-based so we subtract 1 from each.
+ for (var rawAnalyzerMessage of rawAnalyzerMessages)
+ analyzerMessages.push(new WebInspector.AnalyzerMessage(new WebInspector.SourceCodeLocation(sourceCode, rawAnalyzerMessage.line - 1, rawAnalyzerMessage.column - 1), rawAnalyzerMessage.message, rawAnalyzerMessage.ruleId));
+
+ this._sourceCodeMessagesMap.set(sourceCode, analyzerMessages);
+
+ resolve(analyzerMessages);
+ }
+
+ sourceCode.requestContent(retrieveAnalyzerMessages.bind(this));
+ }.bind(this));
+ },
+
+ sourceCodeCanBeAnalyzed: function(sourceCode)
+ {
+ return sourceCode.type === WebInspector.Resource.Type.Script;
+ },
+
+ // Private
+
+ _handleSourceCodeContentDidChange: function(event)
+ {
+ var sourceCode = event.target;
+
+ // Since sourceCode has changed, remove it and its messages from the map so getAnalyzerMessagesForSourceCode will have to reanalyze the next time it is called.
+ this._sourceCodeMessagesMap.delete(sourceCode);
+ }
+};
</ins></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceMainhtml"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Main.html (175627 => 175628)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Main.html 2014-11-05 18:43:19 UTC (rev 175627)
+++ trunk/Source/WebInspectorUI/UserInterface/Main.html 2014-11-05 18:43:30 UTC (rev 175628)
</span><span class="lines">@@ -175,6 +175,7 @@
</span><span class="cx"> <script src="Base/Utilities.js"></script>
</span><span class="cx">
</span><span class="cx"> <script src="External/Esprima/esprima.js"></script>
</span><ins>+ <script src="External/ESLint/eslint.js"></script>
</ins><span class="cx">
</span><span class="cx"> <script src="Protocol/ApplicationCacheObserver.js"></script>
</span><span class="cx"> <script src="Protocol/CSSObserver.js"></script>
</span><span class="lines">@@ -202,6 +203,7 @@
</span><span class="cx"> <script src="Models/Timeline.js"></script>
</span><span class="cx"> <script src="Models/TimelineRecord.js"></script>
</span><span class="cx">
</span><ins>+ <script src="Models/AnalyzerMessage.js"></script>
</ins><span class="cx"> <script src="Models/ApplicationCacheFrame.js"></script>
</span><span class="cx"> <script src="Models/ApplicationCacheManifest.js"></script>
</span><span class="cx"> <script src="Models/BackForwardEntry.js"></script>
</span><span class="lines">@@ -458,6 +460,7 @@
</span><span class="cx">
</span><span class="cx"> <script src="Controllers/CodeMirrorEditingController.js"></script>
</span><span class="cx">
</span><ins>+ <script src="Controllers/AnalyzerManager.js"></script>
</ins><span class="cx"> <script src="Controllers/ApplicationCacheManager.js"></script>
</span><span class="cx"> <script src="Controllers/BranchManager.js"></script>
</span><span class="cx"> <script src="Controllers/CSSStyleManager.js"></script>
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceModelsAnalyzerMessagejs"></a>
<div class="addfile"><h4>Added: trunk/Source/WebInspectorUI/UserInterface/Models/AnalyzerMessage.js (0 => 175628)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Models/AnalyzerMessage.js (rev 0)
+++ trunk/Source/WebInspectorUI/UserInterface/Models/AnalyzerMessage.js 2014-11-05 18:43:30 UTC (rev 175628)
</span><span class="lines">@@ -0,0 +1,61 @@
</span><ins>+/*
+ * Copyright (C) 2014 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+WebInspector.AnalyzerMessage = function(sourceCodeLocation, text, ruleIdentifier)
+{
+ WebInspector.Object.call(this);
+
+ console.assert(sourceCodeLocation instanceof WebInspector.SourceCodeLocation);
+ console.assert(typeof text === "string");
+
+ this._sourceCodeLocation = sourceCodeLocation;
+ this._text = text;
+ this._ruleIdentifier = ruleIdentifier;
+};
+
+WebInspector.AnalyzerMessage.prototype = {
+ constructor: WebInspector.AnalyzerMessage,
+ __proto__: WebInspector.Object.prototype,
+
+ get sourceCodeLocation()
+ {
+ return this._sourceCodeLocation;
+ },
+
+ get sourceCode()
+ {
+ return this._sourceCodeLocation.sourceCode;
+ },
+
+ get text()
+ {
+ return this._text;
+ },
+
+ get ruleIdentifier()
+ {
+ return this._ruleIdentifier;
+ }
+};
</ins></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceModelsSourceCodejs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Models/SourceCode.js (175627 => 175628)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Models/SourceCode.js 2014-11-05 18:43:19 UTC (rev 175627)
+++ trunk/Source/WebInspectorUI/UserInterface/Models/SourceCode.js 2014-11-05 18:43:30 UTC (rev 175628)
</span><span class="lines">@@ -36,6 +36,8 @@
</span><span class="cx"> this._formatterSourceMap = null;
</span><span class="cx"> };
</span><span class="cx">
</span><ins>+WebInspector.Object.addConstructorFunctions(WebInspector.SourceCode);
+
</ins><span class="cx"> WebInspector.SourceCode.Event = {
</span><span class="cx"> ContentDidChange: "source-code-content-did-change",
</span><span class="cx"> SourceMapAdded: "source-code-source-map-added",
</span></span></pre>
</div>
</div>
</body>
</html>