Merge pull request #11616 from ficristo/fix-3296

Marcel Gerber · Marcel Gerber · commit 93a30a2467e3 · 2016-05-01T20:35:21.000+02:00
Fix for #3296: add deprecation warning for global Mustache
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -64,7 +64,6 @@
         "require": false,
         "define": false,
         "$": false,
-        "PathUtils": false,
-        "Mustache": false
+        "PathUtils": false
     }
 }
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -274,7 +274,6 @@ module.exports = function (grunt) {
                     'src/thirdparty/CodeMirror/lib/util/searchcursor.js',
                     'src/thirdparty/CodeMirror/addon/edit/closetag.js',
                     'src/thirdparty/CodeMirror/addon/selection/active-line.js',
-                    'src/thirdparty/mustache/mustache.js',
                     'src/thirdparty/path-utils/path-utils.min',
                     'src/thirdparty/less-2.5.1.min.js'
                 ],
diff --git a/src/brackets.js b/src/brackets.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, brackets: true, $, window, navigator, Mustache, jQuery */
+/*global define, brackets: true, $, window, navigator, jQuery */
 
 // TODO: (issue #264) break out the definition of brackets into a separate module from the application controller logic
 
@@ -115,6 +115,18 @@ define(function (require, exports, module) {
         }
     });
 
+    // DEPRECATED: In future we want to remove the global Mustache, but for now we
+    // expose our required Mustache globally so as to avoid breaking extensions in the
+    // interim.
+    var Mustache = require("thirdparty/mustache/mustache");
+
+    Object.defineProperty(window, "Mustache", {
+        get: function () {
+            DeprecationWarning.deprecationWarning('Use brackets.getModule("thirdparty/mustache/mustache") instead of global Mustache.', true);
+            return Mustache;
+        }
+    });
+
     // Load modules that self-register and just need to get included in the main project
     require("command/DefaultMenus");
     require("document/ChangedDocumentTracker");
diff --git a/src/dependencies.js b/src/dependencies.js
@@ -31,7 +31,7 @@ window.setTimeout(function () {
     "use strict";
 
     var key, missingDeps = "";
-    var deps = { "Mustache": window.Mustache, "jQuery": window.$, "RequireJS": window.require };
+    var deps = { "jQuery": window.$, "RequireJS": window.require };
 
     for (key in deps) {
         if (deps.hasOwnProperty(key) && !deps[key]) {
diff --git a/src/editor/CodeHintList.js b/src/editor/CodeHintList.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, $, window, Mustache */
+/*global define, $, window */
 
 define(function (require, exports, module) {
     "use strict";
@@ -34,7 +34,8 @@ define(function (require, exports, module) {
         StringUtils       = require("utils/StringUtils"),
         ValidationUtils   = require("utils/ValidationUtils"),
         ViewUtils         = require("utils/ViewUtils"),
-        PopUpManager      = require("widgets/PopUpManager");
+        PopUpManager      = require("widgets/PopUpManager"),
+        Mustache          = require("thirdparty/mustache/mustache");
 
     var CodeHintListHTML  = require("text!htmlContent/code-hint-list.html");
 
diff --git a/src/editor/ImageViewer.js b/src/editor/ImageViewer.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, $, window, Mustache */
+/*global define, $, window */
 
 define(function (require, exports, module) {
     "use strict";
@@ -36,8 +36,8 @@ define(function (require, exports, module) {
         StringUtils         = require("utils/StringUtils"),
         FileSystem          = require("filesystem/FileSystem"),
         FileUtils           = require("file/FileUtils"),
-        _                   = require("thirdparty/lodash");
-
+        _                   = require("thirdparty/lodash"),
+        Mustache            = require("thirdparty/mustache/mustache");
 
     var _viewers = {};
 
diff --git a/src/extensibility/ExtensionManagerDialog.js b/src/extensibility/ExtensionManagerDialog.js
@@ -22,12 +22,13 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global brackets, define, $, Mustache */
+/*global brackets, define, $ */
 
 define(function (require, exports, module) {
     "use strict";
 
     var _                           = require("thirdparty/lodash"),
+        Mustache                    = require("thirdparty/mustache/mustache"),
         Dialogs                     = require("widgets/Dialogs"),
         DefaultDialogs              = require("widgets/DefaultDialogs"),
         FileSystem                  = require("filesystem/FileSystem"),
diff --git a/src/extensibility/ExtensionManagerView.js b/src/extensibility/ExtensionManagerView.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50, regexp: true */
-/*global define, $, brackets, Mustache */
+/*global define, $, brackets */
 /*unittests: ExtensionManager*/
 
 define(function (require, exports, module) {
@@ -35,7 +35,8 @@ define(function (require, exports, module) {
         registry_utils            = require("extensibility/registry_utils"),
         InstallExtensionDialog    = require("extensibility/InstallExtensionDialog"),
         LocalizationUtils         = require("utils/LocalizationUtils"),
-        itemTemplate              = require("text!htmlContent/extension-manager-view-item.html");
+        itemTemplate              = require("text!htmlContent/extension-manager-view-item.html"),
+        Mustache                  = require("thirdparty/mustache/mustache");
 
     /**
      * Creates a view enabling the user to install and manage extensions. Must be initialized
diff --git a/src/extensibility/InstallExtensionDialog.js b/src/extensibility/InstallExtensionDialog.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, window, $, brackets, Mustache, document */
+/*global define, window, $, brackets, document */
 /*unittests: Install Extension Dialog*/
 
 define(function (require, exports, module) {
@@ -36,7 +36,8 @@ define(function (require, exports, module) {
         KeyEvent               = require("utils/KeyEvent"),
         Package                = require("extensibility/Package"),
         NativeApp              = require("utils/NativeApp"),
-        InstallDialogTemplate  = require("text!htmlContent/install-extension-dialog.html");
+        InstallDialogTemplate  = require("text!htmlContent/install-extension-dialog.html"),
+        Mustache               = require("thirdparty/mustache/mustache");
 
     var STATE_CLOSED              = 0,
         STATE_START               = 1,
diff --git a/src/extensions/default/DebugCommands/main.js b/src/extensions/default/DebugCommands/main.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50, regexp: true */
-/*global define, $, brackets, window, Mustache*/
+/*global define, $, brackets, window*/
 
 define(function (require, exports, module) {
     "use strict";
@@ -44,6 +44,7 @@ define(function (require, exports, module) {
         MainViewManager        = brackets.getModule("view/MainViewManager"),
         WorkingSetView         = brackets.getModule("project/WorkingSetView"),
         ExtensionManager       = brackets.getModule("extensibility/ExtensionManager"),
+        Mustache               = brackets.getModule("thirdparty/mustache/mustache"),
         ErrorNotification      = require("ErrorNotification"),
         NodeDebugUtils         = require("NodeDebugUtils"),
         PerfDialogTemplate     = require("text!htmlContent/perf-dialog.html"),
diff --git a/src/extensions/default/HealthData/HealthDataPopup.js b/src/extensions/default/HealthData/HealthDataPopup.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global brackets, define, Mustache, $*/
+/*global brackets, define, $*/
 
 
 define(function (require, exports, module) {
@@ -33,6 +33,7 @@ define(function (require, exports, module) {
     var MainViewManager             = brackets.getModule("view/MainViewManager"),
         Dialogs                     = brackets.getModule("widgets/Dialogs"),
         Strings                     = brackets.getModule("strings"),
+        Mustache                    = brackets.getModule("thirdparty/mustache/mustache"),
         HealthDataNotificationHtml  = require("text!htmlContent/healthdata-popup.html");
 
     function closeCallout() {
diff --git a/src/extensions/default/HealthData/HealthDataPreview.js b/src/extensions/default/HealthData/HealthDataPreview.js
@@ -22,12 +22,13 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, Mustache, brackets, $ */
+/*global define, brackets, $ */
 
 define(function (require, exports, module) {
     "use strict";
 
     var _                       = brackets.getModule("thirdparty/lodash"),
+        Mustache                = brackets.getModule("thirdparty/mustache/mustache"),
         PreferencesManager      = brackets.getModule("preferences/PreferencesManager"),
         Strings                 = brackets.getModule("strings"),
         Dialogs                 = brackets.getModule("widgets/Dialogs"),
diff --git a/src/extensions/default/InlineColorEditor/ColorEditor.js b/src/extensions/default/InlineColorEditor/ColorEditor.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, nomen: true, regexp: true, maxerr: 50 */
-/*global define, brackets, $, window, Mustache */
+/*global define, brackets, $, window */
 
 define(function (require, exports, module) {
     "use strict";
@@ -31,6 +31,7 @@ define(function (require, exports, module) {
         PreferencesManager = brackets.getModule("preferences/PreferencesManager"),
         StringUtils        = brackets.getModule("utils/StringUtils"),
         Strings            = brackets.getModule("strings"),
+        Mustache           = brackets.getModule("thirdparty/mustache/mustache"),
         tinycolor          = require("thirdparty/tinycolor-min");
 
     /** Mustache template that forms the bare DOM structure of the UI */
diff --git a/src/extensions/default/InlineTimingFunctionEditor/BezierCurveEditor.js b/src/extensions/default/InlineTimingFunctionEditor/BezierCurveEditor.js
@@ -22,13 +22,14 @@
  */
 
 /*jslint vars: true, plusplus: true, nomen: true, regexp: true, maxerr: 50 */
-/*global define, brackets, $, window, Mustache */
+/*global define, brackets, $, window */
 
 define(function (require, exports, module) {
     "use strict";
 
     var KeyEvent        = brackets.getModule("utils/KeyEvent"),
-        Strings         = brackets.getModule("strings");
+        Strings         = brackets.getModule("strings"),
+        Mustache        = brackets.getModule("thirdparty/mustache/mustache");
 
     var TimingFunctionUtils = require("TimingFunctionUtils");
 
diff --git a/src/extensions/default/InlineTimingFunctionEditor/StepEditor.js b/src/extensions/default/InlineTimingFunctionEditor/StepEditor.js
@@ -22,13 +22,14 @@
  */
 
 /*jslint vars: true, plusplus: true, nomen: true, regexp: true, maxerr: 50 */
-/*global define, brackets, $, window, Mustache */
+/*global define, brackets, $, window */
 
 define(function (require, exports, module) {
     "use strict";
 
     var KeyEvent    = brackets.getModule("utils/KeyEvent"),
-        Strings     = brackets.getModule("strings");
+        Strings     = brackets.getModule("strings"),
+        Mustache    = brackets.getModule("thirdparty/mustache/mustache");
 
     var TimingFunctionUtils = require("TimingFunctionUtils");
 
diff --git a/src/extensions/default/InlineTimingFunctionEditor/main.js b/src/extensions/default/InlineTimingFunctionEditor/main.js
@@ -41,7 +41,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true,  regexp: true, indent: 4, maxerr: 50 */
-/*global define, brackets, $, Mustache */
+/*global define, brackets, $ */
 
 define(function (require, exports, module) {
     "use strict";
@@ -50,6 +50,7 @@ define(function (require, exports, module) {
     var EditorManager       = brackets.getModule("editor/EditorManager"),
         ExtensionUtils      = brackets.getModule("utils/ExtensionUtils"),
         Strings             = brackets.getModule("strings"),
+        Mustache            = brackets.getModule("thirdparty/mustache/mustache"),
 
         InlineTimingFunctionEditor = require("InlineTimingFunctionEditor").InlineTimingFunctionEditor,
         TimingFunctionUtils        = require("TimingFunctionUtils"),
diff --git a/src/extensions/default/RecentProjects/main.js b/src/extensions/default/RecentProjects/main.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */
-/*global define, brackets, window, $, Mustache */
+/*global define, brackets, window, $ */
 
 define(function (require, exports, module) {
     "use strict";
@@ -43,6 +43,7 @@ define(function (require, exports, module) {
         FileUtils               = brackets.getModule("file/FileUtils"),
         PopUpManager            = brackets.getModule("widgets/PopUpManager"),
         Strings                 = brackets.getModule("strings"),
+        Mustache                = brackets.getModule("thirdparty/mustache/mustache"),
         ProjectsMenuTemplate    = require("text!htmlContent/projects-menu.html");
 
     var KeyboardPrefs = JSON.parse(require("text!keyboard.json"));
diff --git a/src/extensions/default/WebPlatformDocs/InlineDocsViewer.js b/src/extensions/default/WebPlatformDocs/InlineDocsViewer.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, brackets, $, window, Mustache */
+/*global define, brackets, $, window */
 
 /**
  * Inline widget to display WebPlatformDocs JSON data nicely formatted
@@ -36,7 +36,8 @@ define(function (require, exports, module) {
         ExtensionUtils  = brackets.getModule("utils/ExtensionUtils"),
         InlineWidget    = brackets.getModule("editor/InlineWidget").InlineWidget,
         KeyEvent        = brackets.getModule("utils/KeyEvent"),
-        Strings         = brackets.getModule("strings");
+        Strings         = brackets.getModule("strings"),
+        Mustache        = brackets.getModule("thirdparty/mustache/mustache");
 
     // Load template
     var inlineEditorTemplate = require("text!InlineDocsViewer.html");
diff --git a/src/extensions/samples/BracketsConfigCentral/main.js b/src/extensions/samples/BracketsConfigCentral/main.js
@@ -22,7 +22,7 @@
  */
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */
-/*global define, brackets, $, Mustache */
+/*global define, brackets, $ */
 
 define(function (require, exports, module) {
     "use strict";
@@ -32,6 +32,7 @@ define(function (require, exports, module) {
         ExtensionUtils              = brackets.getModule("utils/ExtensionUtils"),
         DocumentManager             = brackets.getModule("document/DocumentManager"),
         MainViewFactory             = brackets.getModule("view/MainViewFactory"),
+        Mustache                    = brackets.getModule("thirdparty/mustache/mustache"),
         ConfigViewContent           = require("text!htmlContent/Config.html");
 
     /* our module object */
diff --git a/src/extensions/samples/LocalizationExample/main.js b/src/extensions/samples/LocalizationExample/main.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, brackets, require, Mustache */
+/*global define, brackets, require */
 
 
 require.config({
@@ -40,7 +40,8 @@ define(function (require, exports, module) {
     // Brackets modules
     var CommandManager      = brackets.getModule("command/CommandManager"),
         Menus               = brackets.getModule("command/Menus"),
-        Dialogs             = brackets.getModule("widgets/Dialogs");
+        Dialogs             = brackets.getModule("widgets/Dialogs"),
+        Mustache            = brackets.getModule("thirdparty/mustache/mustache");
 
     // Load an html fragment using the require text plugin. Mustache will later
     // be used to localize some of the text
diff --git a/src/help/HelpCommandHandlers.js b/src/help/HelpCommandHandlers.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, $, brackets, window, Mustache */
+/*global define, $, brackets, window */
 
 define(function (require, exports, module) {
     "use strict";
@@ -39,7 +39,8 @@ define(function (require, exports, module) {
         StringUtils             = require("utils/StringUtils"),
         UpdateNotification      = require("utils/UpdateNotification"),
         AboutDialogTemplate     = require("text!htmlContent/about-dialog.html"),
-        ContributorsTemplate    = require("text!htmlContent/contributors-list.html");
+        ContributorsTemplate    = require("text!htmlContent/contributors-list.html"),
+        Mustache                = require("thirdparty/mustache/mustache");
     // make sure the global brackets variable is loaded
     require("utils/Global");
 
diff --git a/src/index.html b/src/index.html
@@ -47,7 +47,6 @@
     <!-- Pre-load third party scripts that cannot be async loaded. -->
     <!-- build:js thirdparty/thirdparty.min.js -->
     <script src="thirdparty/less-2.5.1.min.js"></script>
-    <script src="thirdparty/mustache/mustache.js"></script>
     <script src="thirdparty/jquery-2.1.3.min.js"></script>
     <!-- endbuild -->
 </head>
diff --git a/src/language/CodeInspection.js b/src/language/CodeInspection.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4 */
-/*global define, $, Mustache, brackets */
+/*global define, $, brackets */
 
 /**
  * Manages linters and other code inspections on a per-language basis. Provides a UI and status indicator for
@@ -58,7 +58,8 @@ define(function (require, exports, module) {
         StatusBar               = require("widgets/StatusBar"),
         Async                   = require("utils/Async"),
         PanelTemplate           = require("text!htmlContent/problems-panel.html"),
-        ResultsTemplate         = require("text!htmlContent/problems-panel-table.html");
+        ResultsTemplate         = require("text!htmlContent/problems-panel-table.html"),
+        Mustache                = require("thirdparty/mustache/mustache");
 
     var INDICATOR_ID = "status-inspection";
 
diff --git a/src/preferences/PreferencesDialogs.js b/src/preferences/PreferencesDialogs.js
@@ -23,7 +23,7 @@
 
 
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
-/*global define, PathUtils, Mustache */
+/*global define, PathUtils */
 
 /**
  * PreferencesDialogs
@@ -38,7 +38,8 @@ define(function (require, exports, module) {
         ProjectManager         = require("project/ProjectManager"),
         StringUtils            = require("utils/StringUtils"),
         Strings                = require("strings"),
-        SettingsDialogTemplate = require("text!htmlContent/project-settings-dialog.html");
+        SettingsDialogTemplate = require("text!htmlContent/project-settings-dialog.html"),
+        Mustache               = require("thirdparty/mustache/mustache");
 
     /**
      * Validate that text string is a valid base url which should map to a server folder
diff --git a/src/project/WorkingSetView.js b/src/project/WorkingSetView.js
diff --git a/src/search/FileFilters.js b/src/search/FileFilters.js
diff --git a/src/search/FindBar.js b/src/search/FindBar.js
diff --git a/src/search/SearchResultsView.js b/src/search/SearchResultsView.js
diff --git a/src/utils/UpdateNotification.js b/src/utils/UpdateNotification.js
diff --git a/src/view/Pane.js b/src/view/Pane.js
diff --git a/src/view/ThemeSettings.js b/src/view/ThemeSettings.js
diff --git a/src/widgets/Dialogs.js b/src/widgets/Dialogs.js
diff --git a/src/widgets/StatusBar.js b/src/widgets/StatusBar.js
diff --git a/test/SpecRunner.html b/test/SpecRunner.html

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,6 @@`
`64`	`64`	`"require": false,`
`65`	`65`	`"define": false,`
`66`	`66`	`"$": false,`
`67`		`- "PathUtils": false,`
`68`		`- "Mustache": false`
	`67`	`+ "PathUtils": false`
`69`	`68`	`}`
`70`	`69`	`}`