Changeset 251921 in webkit

Timestamp:

Nov 1, 2019 9:08:33 AM (4 years ago)

Author:

Devin Rousso

Message:

Web Inspector: make the default content of the Inspector Bootstrap Script a comment that explains how it works
​https://bugs.webkit.org/show_bug.cgi?id=203704

Reviewed by Timothy Hatcher.

• UserInterface/Controllers/NetworkManager.js:

(WI.NetworkManager.prototype.async createBootstrapScript):

• Localizations/en.lproj/localizedStrings.js:

Location:

trunk/Source/WebInspectorUI

Files:

• ChangeLog (modified) (1 diff)
• Localizations/en.lproj/localizedStrings.js (modified) (7 diffs)
• UserInterface/Controllers/NetworkManager.js (modified) (1 diff)

trunk/Source/WebInspectorUI/ChangeLog

@@ +1 @@
+2019-11-01  Devin Rousso  <drousso@apple.com>
+
+        Web Inspector: make the default content of the Inspector Bootstrap Script a comment that explains how it works
+        https://bugs.webkit.org/show_bug.cgi?id=203704
+
+        Reviewed by Timothy Hatcher.
+
+        * UserInterface/Controllers/NetworkManager.js:
+        (WI.NetworkManager.prototype.async createBootstrapScript):
+
+        * Localizations/en.lproj/localizedStrings.js:
+
 2019-11-01  Devin Rousso  <drousso@apple.com>
 

trunk/Source/WebInspectorUI/Localizations/en.lproj/localizedStrings.js

@@ -635 +635 @@
 localizedStrings["Invisible characters"] = "Invisible characters";
 localizedStrings["Invoke getter"] = "Invoke getter";
+localizedStrings["It is evaluated immediately after the global object is created, before any other content has loaded."] = "It is evaluated immediately after the global object is created, before any other content has loaded.";
 localizedStrings["JP2"] = "JP2";
 localizedStrings["JPEG"] = "JPEG";
@@ -715 +716 @@
 localizedStrings["Missing result level"] = "Missing result level";
 localizedStrings["Mixed"] = "Mixed";
+localizedStrings["Modifications made here will take effect on the next load of any page or sub-frame."] = "Modifications made here will take effect on the next load of any page or sub-frame.";
 localizedStrings["Module Code"] = "Module Code";
 localizedStrings["Multi-Entry"] = "Multi-Entry";
@@ -1058 +1060 @@
 localizedStrings["Socket"] = "Socket";
 localizedStrings["Sockets"] = "Sockets";
+localizedStrings["Some examples of ways to use this script include (but are not limited to):"] = "Some examples of ways to use this script include (but are not limited to):";
 localizedStrings["Sort Ascending"] = "Sort Ascending";
 localizedStrings["Sort Descending"] = "Sort Descending";
@@ -1122 +1125 @@
 localizedStrings["Text Frame"] = "Text Frame";
 localizedStrings["Text Node"] = "Text Node";
+localizedStrings["The Inspector Bootstrap Script is guaranteed to be the first script evaluated in any page, as well as any sub-frames."] = "The Inspector Bootstrap Script is guaranteed to be the first script evaluated in any page, as well as any sub-frames.";
 localizedStrings["The \u201C%s\u201D audit failed"] = "The \u201C%s\u201D audit failed";
 localizedStrings["The \u201C%s\u201D audit is unsupported"] = "The \u201C%s\u201D audit is unsupported";
@@ -1128 +1132 @@
 localizedStrings["The \u201C%s\u201D audit threw an error"] = "The \u201C%s\u201D audit threw an error";
 localizedStrings["The \u201C%s\u201D\ntable is empty."] = "The \u201C%s\u201D\ntable is empty.";
+localizedStrings["The contents and enabled state will be preserved across Web Inspector sessions."] = "The contents and enabled state will be preserved across Web Inspector sessions.";
 localizedStrings["The page's content has changed"] = "The page's content has changed";
 localizedStrings["The resource was requested insecurely."] = "The resource was requested insecurely.";
@@ -1297 +1302 @@
 localizedStrings["default"] = "default";
 localizedStrings["default prevented"] = "default prevented";
+localizedStrings["ensuring that common debugging functions are available on every page via the Console"] = "ensuring that common debugging functions are available on every page via the Console";
 localizedStrings["for changes to take effect"] = "for changes to take effect";
 localizedStrings["invalid HAR"] = "invalid HAR";
@@ -1308 +1314 @@
 localizedStrings["non-string %s"] = "non-string %s";
 localizedStrings["originally %s"] = "originally %s";
+localizedStrings["overriding built-in functions to log call traces or add `debugger` statements"] = "overriding built-in functions to log call traces or add `debugger` statements";
 localizedStrings["popup"] = "popup";
 localizedStrings["popup, toggle"] = "popup, toggle";

trunk/Source/WebInspectorUI/UserInterface/Controllers/NetworkManager.js

@@ -298 +298 @@
             source = await WI.objectStores.general.get(NetworkManager.bootstrapScriptSourceObjectStoreKey);
 
+        if (!source) {
+            source = `
+/*
+ * ${WI.UIString("The Inspector Bootstrap Script is guaranteed to be the first script evaluated in any page, as well as any sub-frames.")}
+ * ${WI.UIString("It is evaluated immediately after the global object is created, before any other content has loaded.")}
+ * 
+ * ${WI.UIString("Modifications made here will take effect on the next load of any page or sub-frame.")}
+ * ${WI.UIString("The contents and enabled state will be preserved across Web Inspector sessions.")}
+ * 
+ * ${WI.UIString("Some examples of ways to use this script include (but are not limited to):")}
+ *  - ${WI.UIString("overriding built-in functions to log call traces or add `debugger` statements")}
+ *  - ${WI.UIString("ensuring that common debugging functions are available on every page via the Console")}
+ */
+`;
+        }
+
         const target = null;
         const url = null;
         const sourceURL = NetworkManager.bootstrapScriptURL;
-        this._bootstrapScript = new WI.LocalScript(target, url, sourceURL, WI.Script.SourceType.Program, source || "", {injected: true, editable: true});
+        this._bootstrapScript = new WI.LocalScript(target, url, sourceURL, WI.Script.SourceType.Program, source, {injected: true, editable: true});
         this._bootstrapScript.addEventListener(WI.SourceCode.Event.ContentDidChange, this._handleBootstrapScriptContentDidChange, this);