Skip to content
This repository has been archived by the owner on Jul 11, 2019. It is now read-only.

Commit

Permalink
update release notes, replace user settings if legacy settings are co…
Browse files Browse the repository at this point in the history
…ntained within
  • Loading branch information
joeferraro committed Aug 13, 2015
1 parent 5bcd30f commit ead05cf
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
20 changes: 19 additions & 1 deletion messages/5.0.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,22 @@ MavensMate-SublimeText 5.0.0 changelog

### IMPORTANT ###

Version 5 of MavensMate for Sublime Text no longer depends on the "mm" API, rather it depends on a brand new app called "mavensmate-app" (https://github.com/joeferraro/mavensmate-app). mavensmate-app is the MavensMate UI and the MavensMate local server packaged with a pretty bow. In keeping with our commitment to never expose your source code/intellectual property to any server other than Salesforce.com, mavensmate-app's local server facilitates communication between your local machine and Salesforce.com, *only*. Your source code never passes through any (nonexistent) MavensMate remote server. If you're interested in reviewing the source code of the local MavensMate server, you can find it at https://github.com/joeferraro/MavensMate.
Version 5 of MavensMate for Sublime Text no longer depends on the "mm" API, rather it depends on a brand new app called "mavensmate-app" (https://github.com/joeferraro/mavensmate-app). mavensmate-app is the MavensMate UI and the MavensMate local server packaged with a pretty bow. In keeping with our commitment to never expose your source code/intellectual property to any server other than Salesforce.com, mavensmate-app's local server facilitates communication between your local machine and Salesforce.com, *only*. Your source code never passes through any (nonexistent) MavensMate remote server. If you're interested in reviewing the source code of the local MavensMate server, you can find it at https://github.com/joeferraro/MavensMate.

### UPDATED SETTINGS MANAGEMENT ###

Version 5 of the MavensMate for Sublime Text plugin introduces the concept of "global" settings which are accessed via MavensMate > Settings > Global Settings. You'll notice that many of the global settings are those formerly managed by JSON files in Sublime Text. The reason they have moved is so that those users with Sublime Text, Atom, Visual Studio Code, etc. installed can manage core MavensMate settings in a single place. For example, mm_workspace is NO LONGER managed within Sublime Text; rather it is a global setting managed by the MavensMate app (mavensmate-app).

-- Managing MavensMate for Sublime Text Settings --

There are three types of settings you need to be aware of: default plugin settings, user plugin settings, and global settings

DEFAULT PLUGIN SETTINGS - the default settings for MavensMate for Sublime Text. DO NOT modify these settings, as they will be overwritten anytime you update MavensMate for Sublime Text.

USER PLUGIN SETTINGS - the user-specific settings for MavensMAte for Sublime Text. You are strongly encouraged to copy the default settings to this file and update any settings within this file.

GLOBAL SETTINGS - the core MavensMate settings, which are managed by the MavensMate app.

-- Troubleshooting --

If you are updating a setting and it doesn't seem to be working, be sure you are updating the right settings. USER PLUGIN SETTINGS are ONLY those settings SPECIFIC to the MavensMate for Sublime Text plugin (for example, mm_compile_on_save). GLOBAL SETTINGS are different altogether and can only be managed within the MavensMate app.
2 changes: 1 addition & 1 deletion sublime/settings-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Settings Help

Version 5 of the MavensMate for Sublime Text plugin introduces the concept of "global" settings which are accessed via MavensMate > Settings > Global Settings. You'll notice that many of the global settings are those formerly managed by JSON files in Sublime Text. The reason they have moved is so that those users with Sublime Text, Atom, Visual Studio Code, etc. installed can manage core MavensMate settings in a single place.

For those users upgrading from Version 4 of the MavensMate for Sublime Text plugin, you are strongly encouraged to overwrite your MavensMate for Sublime Text "User Plugin Settings" with those found in "Global Plugin Settings" as the list of settings managed by Sublime Text is now a much shorter. For example, mm_workspace is NO LONGER managed within Sublime Text; rather it is a global setting managed by the MavensMate app.
For those users upgrading from Version 4 of the MavensMate for Sublime Text plugin, you are strongly encouraged to overwrite your MavensMate for Sublime Text "User Plugin Settings" with those found in "Global Plugin Settings" as the list of settings managed by Sublime Text is now a much shorter. For example, mm_workspace is NO LONGER managed within Sublime Text; rather it is a global setting managed by the MavensMate app (mavensmate-app).

-- Managing MavensMate for Sublime Text Settings --

Expand Down
5 changes: 5 additions & 0 deletions util.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ def package_check():
try:
if not os.path.isfile(os.path.join(sublime.packages_path(),"User","mavensmate.sublime-settings")):
shutil.copyfile(os.path.join(sublime.packages_path(),"MavensMate","mavensmate.sublime-settings"), os.path.join(sublime.packages_path(),"User","mavensmate.sublime-settings"))
elif os.path.isfile(os.path.join(sublime.packages_path(),"User","mavensmate.sublime-settings")):
user_settings = get_file_as_string(os.path.join(sublime.packages_path(),"User","mavensmate.sublime-settings"))
if 'mm_use_keyring' in user_settings or 'mm_workspace' in user_settings or 'mm_api_version' in user_settings:
shutil.copyfile(os.path.join(sublime.packages_path(),"MavensMate","mavensmate.sublime-settings"), os.path.join(sublime.packages_path(),"User","mavensmate.sublime-settings"))

except:
debug('could not migrate default settings to user settings')
pass
Expand Down

0 comments on commit ead05cf

Please sign in to comment.