Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Commit 1a74ece

Browse files
committed
Merge pull request #11174 from le717/issue-10412
Add deprecation warning for convertPreferences()
2 parents 7793f40 + d652187 commit 1a74ece

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/preferences/PreferencesManager.js

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ define(function (require, exports, module) {
112112

113113
/**
114114
* Retreive the preferences data for the given clientID.
115+
* @deprecated
116+
*
115117
* @param {string|{id: string, uri: string}} clientID - A unique identifier or a requireJS module object
116118
* @param {string=} defaults - Default preferences stored as JSON
117119
* @param {boolean=} _doNotCreate Do not create the storage if it does not already exist. Used for conversion.
@@ -123,7 +125,8 @@ define(function (require, exports, module) {
123125
// having _doNotCreate set to true, then the caller is using the old preferences model.
124126
if (!_doNotCreate) {
125127
var clientString = typeof clientID === "object" ? clientID.uri : clientID;
126-
DeprecationWarning.deprecationWarning("getPreferenceStorage is called with client ID '" + clientString + ",' use PreferencesManager.definePreference instead.");
128+
DeprecationWarning.deprecationWarning("PreferencesManager.getPreferenceStorage() called with client id '" +
129+
clientString + "' has been deprecated. Use PreferencesManager.definePreference() instead.");
127130
}
128131
if (!clientID || (typeof clientID === "object" && (!clientID.id || !clientID.uri))) {
129132
console.error("Invalid clientID");
@@ -308,6 +311,7 @@ define(function (require, exports, module) {
308311
* * `user newkey`: convert to a user-level preference, changing the key to newkey
309312
*
310313
* Once a key has been converted, it will not be converted again.
314+
* @deprecated
311315
*
312316
* @param {string|Object} clientID ClientID used in the old preferences
313317
* @param {Object} rules Rules for conversion (as defined above)
@@ -318,6 +322,9 @@ define(function (require, exports, module) {
318322
* examines each preference key for migration.
319323
*/
320324
function convertPreferences(clientID, rules, isViewState, prefCheckCallback) {
325+
DeprecationWarning.deprecationWarning("PreferencesManager.convertPreferences() has been deprecated. " +
326+
"Please upgrade to the current Preferences system " +
327+
"(https://github.com/adobe/brackets/wiki/Preferences-System#conversion-from-the-pre-36-preferences-system).");
321328
PreferencesImpl.smUserScopeLoading.done(function () {
322329
PreferencesImpl.userScopeLoading.done(function () {
323330
if (!clientID || (typeof clientID === "object" && (!clientID.id || !clientID.uri))) {
@@ -528,7 +535,7 @@ define(function (require, exports, module) {
528535
* @return {boolean} true if a value was set
529536
*/
530537
function setValueAndSave(id, value, options) {
531-
DeprecationWarning.deprecationWarning("setValueAndSave called for " + id + ". Use set instead.");
538+
DeprecationWarning.deprecationWarning("PreferencesManager.setValueAndSave() called for " + id + ". Use PreferencesManager.set() instead.", true);
532539
var changed = exports.set(id, value, options).stored;
533540
PreferencesImpl.manager.save();
534541
return changed;

0 commit comments

Comments
 (0)