Enhancement: support project-wise settings

timbrel · Mar 31, 2018 · 1ce57a7 · 1ce57a7
1 parent 5fc7a07
commit 1ce57a7
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 31 deletions.
diff --git a/Default.sublime-commands b/Default.sublime-commands
@@ -4,7 +4,12 @@
         "command": "edit_settings",
         "args": {
             "base_file": "${packages}/GitSavvy/GitSavvy.sublime-settings",
-            "default": "// Settings in here override those in \"GitSavvy/GitSavvy.sublime-settings\",\n\n{\n\t$0\n}\n"}
+            "default": "// Settings in here override those in \"GitSavvy/GitSavvy.sublime-settings\",\n\n{\n\t$0\n}\n"
+        }
+    },
+    {
+        "caption": "Preferences: GitSavvy Project Settings",
+        "command": "gs_edit_project_settings"
     },
     {
         "caption": "Preferences: GitSavvy Key Bindings",

diff --git a/GitSavvy.sublime-project b/GitSavvy.sublime-project
@@ -1,27 +1,37 @@
 {
-    "folders": [
-        {
-            "path": ".",
-            "folder_exclude_patterns": [
-                ".git",
-                "__pycache__"
-            ]
-        }
-    ],
-    "settings": {
-        "rulers": [100, 120],
-        "tab_size": 4,
-        "translate_tabs_to_spaces": true
-    },
-    "build_systems":
-    [
-        {
-            "name": "Reload GitSavvy",
-            "target": "gs_reload_modules_debug"
-        },
-        {
-            "name": "Test GitSavvy",
-            "target": "unit_testing_current_package"
-        }
-    ]
+	"build_systems":
+	[
+		{
+			"name": "Reload GitSavvy",
+			"target": "gs_reload_modules_debug"
+		},
+		{
+			"name": "Test GitSavvy",
+			"target": "unit_testing_current_package"
+		}
+	],
+	"folders":
+	[
+		{
+			"folder_exclude_patterns":
+			[
+				".git",
+				"__pycache__"
+			],
+			"path": "."
+		}
+	],
+	"settings":
+	{
+		"GitSavvy":
+		{
+		},
+		"rulers":
+		[
+			100,
+			120
+		],
+		"tab_size": 4,
+		"translate_tabs_to_spaces": true
+	}
 }
diff --git a/common/global_events.py b/common/global_events.py
@@ -73,16 +73,18 @@ def run(self):
         project_file_name = self.window.project_file_name()
         project_data = self.window.project_data()
         if not project_file_name or project_data is None:
-            sublime.error_message("no project data found.")
+            sublime.error_message("No project data found.")
 
-        if project_data and "settings" not in project_data:
+        if project_data is None:
+            project_data = {}
+        if "settings" not in project_data:
             project_data["settings"] = {"GitSavvy": {}}
         if "GitSavvy" not in project_data["settings"]:
             project_data["settings"]["GitSavvy"] = {}
 
         self.window.set_project_data(project_data)
 
-        self.window.run_command("edit_settings", {
+        sublime.set_timeout(lambda: self.window.run_command("edit_settings", {
             "user_file": project_file_name,
             "base_file": "${packages}/GitSavvy/GitSavvy.sublime-settings"
-        })
+        }), 100)
diff --git a/core/settings.py b/core/settings.py
@@ -7,6 +7,11 @@ def __init__(self, parent=None):
         self.global_settings = sublime.load_settings("GitSavvy.sublime-settings")
 
     def get(self, key, default=None):
+        project_data = sublime.active_window().project_data()
+        if project_data and "settings" in project_data and "GitSavvy" in project_data["settings"]:
+            project_savvy_settings = project_data["settings"]["GitSavvy"]
+            if key in project_savvy_settings:
+                return project_savvy_settings.get(key)
         return self.global_settings.get(key, default)
 
     def set(self, key, value):

diff --git a/docs/README.md b/docs/README.md
@@ -185,7 +185,20 @@ For all syntax specific view we have a settings file. These are nothing extra fr
 
 ### Editing Settings
 
-To open the GitSavvy settings, simply run the `Preferences: GitSavvy Settings` command from the command palette. The default settings are documented with helpful inline comments.
+To open the GitSavvy settings, simply run the `Preferences: GitSavvy Settings` command from the command palette. The default settings are documented with helpful inline comments. GitSavvy also supports project specific settings, run the 
+`Preference: GitSavvy Project Settings` command and add the key `"GitSavvy"` as follows
+
+```
+{
+    "settings":
+    {
+        "GitSavvy":
+        {
+            // GitSavvy settings go here
+        }
+    }
+}
+```
 
 [Preferences Editor](https://packagecontrol.io/packages/Preferences%20Editor) is really good package for editing you settings.