use empty settings on first load, comment settings

Author: tkopets

SQLTools.py

@@ -18,6 +18,9 @@
 
 SYNTAX_PLAIN_TEXT = 'Packages/Text/Plain text.tmLanguage'
 SYNTAX_SQL = 'Packages/SQL/SQL.tmLanguage'
+SQLTOOLS_SETTINGS_FILE = 'SQLTools.sublime-settings'
+SQLTOOLS_CONNECTIONS_FILE = 'SQLToolsConnections.sublime-settings'
+SQLTOOLS_QUERIES_FILE = 'SQLToolsSavedQueries.sublime-settings'
 
 USER_FOLDER                  = None
 DEFAULT_FOLDER               = None
@@ -43,12 +46,12 @@ def startPlugin():
     USER_FOLDER = os.path.join(sublime.packages_path(), 'User')
     DEFAULT_FOLDER = os.path.dirname(__file__)
 
-    SETTINGS_FILENAME            = os.path.join(USER_FOLDER, "SQLTools.sublime-settings")
-    SETTINGS_FILENAME_DEFAULT    = os.path.join(DEFAULT_FOLDER, "SQLTools.sublime-settings")
-    CONNECTIONS_FILENAME         = os.path.join(USER_FOLDER, "SQLToolsConnections.sublime-settings")
-    CONNECTIONS_FILENAME_DEFAULT = os.path.join(DEFAULT_FOLDER, "SQLToolsConnections.sublime-settings")
-    QUERIES_FILENAME             = os.path.join(USER_FOLDER, "SQLToolsSavedQueries.sublime-settings")
-    QUERIES_FILENAME_DEFAULT     = os.path.join(DEFAULT_FOLDER, "SQLToolsSavedQueries.sublime-settings")
+    SETTINGS_FILENAME            = os.path.join(USER_FOLDER, SQLTOOLS_SETTINGS_FILE)
+    SETTINGS_FILENAME_DEFAULT    = os.path.join(DEFAULT_FOLDER, SQLTOOLS_SETTINGS_FILE)
+    CONNECTIONS_FILENAME         = os.path.join(USER_FOLDER, SQLTOOLS_CONNECTIONS_FILE)
+    CONNECTIONS_FILENAME_DEFAULT = os.path.join(DEFAULT_FOLDER, SQLTOOLS_CONNECTIONS_FILE)
+    QUERIES_FILENAME             = os.path.join(USER_FOLDER, SQLTOOLS_QUERIES_FILE)
+    QUERIES_FILENAME_DEFAULT     = os.path.join(DEFAULT_FOLDER, SQLTOOLS_QUERIES_FILE)
 
     settings    = Settings(SETTINGS_FILENAME, default=SETTINGS_FILENAME_DEFAULT)
     queries     = Storage(QUERIES_FILENAME, default=QUERIES_FILENAME_DEFAULT)
@@ -580,6 +583,13 @@ def reload():
 
 
 def plugin_loaded():
+    # this ensures we have empty settings file in 'User' directory during first start
+    # otherwise sublime will copy entire contents of 'SQLTools.sublime-settings'
+    # which is not desirable and prevents future changes to queries and other
+    # sensible defaults defined in settings file, as those would be overriden by content
+    # from older versions of SQLTools in 'User\SQLTools.sublime-settings'
+    sublime.save_settings(SQLTOOLS_SETTINGS_FILE)
+
     try:
         from package_control import events
 

SQLTools.sublime-settings

@@ -1,21 +1,25 @@
+// NOTE: it is strongly advised to override
+// only those settings that you wish to change
+// in your Users/SQLTools.sublime-settings
 {
     "debug"                 : true,
-    "thread_timeout"        : 15,
+    "thread_timeout"        : 15,     // query timeout in seconds
     "history_size"          : 100,
     "show_result_on_window" : false,
     "clear_output"          : false,
     "safe_limit"            : false,
     "show_query"            : false,
     "expand_to_paragraph"   : false,
     /**
-     * The list of syntax selector for which the plugin autocompletion will be active.
+     * The list of syntax selectors for which the plugin autocompletion will be active.
      * An empty list means autocompletion always active.
      */
     "selectors": ["source.sql", "source.pgsql", "source.plpgsql.postgres", "source.plsql.oracle", "source.tsql"],
-    "autocompletion": "smart",  /* possible values: "basic", "smart" or false (disable) */
-    "unescape_quotes" : [
-        "php"
-    ],
+    /**
+     * Possible values for autocompletion: "basic", "smart" or false (disable)
+     * Completion keywords case is controlled by format.keyword_case (see below)
+     */
+    "autocompletion": "smart",
     /**
      * If DB cli binary is not in PATH, set the full path in "cli" section.
      * Note: forward slashes ("/") should be used in path. Example:
@@ -41,8 +45,11 @@
         "indent_width"    : 4,
         "reindent"        : true
     },
+    "unescape_quotes" : [
+        "php"
+    ],
     /**
-     * Client options for you SGBD.
+     * Client options for you RDBMS.
      * In this file, the section cli has the names you can use here. Eg: "pgsql": "psql"
      * So here, you must have "psql with the same sections listed bellow (options, before, args and queries)"
      *