Rename hide_build_panel to show_panel_on_build

This commit renames hide_build_panel setting to what ST's default settings
provide to control whether to show build panel on build.

Primary target is to remove duplicate negation of wording and to clarify
the meaning of the setting and the functionality behind it.

Author: deathaxe

LaTeXTools.sublime-settings

@@ -455,34 +455,32 @@
 // Build panel and phantoms settings
 // ------------------------------------------------------------------
 
-	// Syntax highlight build panel so that errors, warnings, etc.
-	// show up in different colors.
-	"highlight_build_panel": true,
-
 	// Enable automatic word wraping in build output panel.
 	"build_panel_word_wrap": false,
 
+	// Syntax highlight build output panel so that errors, warnings, etc.
+	// show up in different colors.
+	"highlight_build_panel": true,
+
 	// Scroll build output panel to top after build finished.
 	"scroll_build_panel_to_top": false,
 
-	// OPTION: "hide_build_panel"
-	// Controls when the LaTeX build panel is hidden after a build finishes.
-	// Default: "no_warnings"
+	// Controls whether or not to display any bad boxes in the build output.
+	// If not set to true, the setting "badboxes" for "show_panel_on_build" is
+	// equivalent to "warnings"
+	"display_bad_boxes": false,
+
+	// Controls when the LaTeX build panel is displayed after a build finishes.
+	// Default: "badboxes"
 	//
 	// Possible values are:
-	//   "always"      — always hide the panel, even if the build failed.
-	//   "no_errors"   — hide the panel if there are no errors.
-	//   "no_warnings" — hide the panel if there are neither errors nor warnings.
-	//   "no_badboxes" — hide the panel if there are no errors, warnings, or badboxes
-	//                   (when badbox reporting is enabled).
-	//   "never"       — never hide the panel.
-	"hide_build_panel": "no_badboxes",
-  
-	// OPTION: "display_bad_boxes"
-	// controls whether or not to display any bad boxes in the build output
-	// if this is not set to true, the setting "no_badboxes" for
-	// "hide_build_panel" is equivalent to "no_warnings"
-	"display_bad_boxes": false,
+	//   "never"    — never show build panel.
+	//   "errors"   — show build panel if there are errors.
+	//   "warnings" — show build panel if there are errors or warnings.
+	//   "badboxes" — show build panel if there are errors, warnings, or badboxes
+	//                (when badbox reporting is enabled).
+	//   "always"   — always show build panel, even if the build failed.
+	"show_panel_on_build": "badboxes",
 
 	// OPTION: "show_error_phantoms"
 	// (ST3, Build 3118+ only)

docs/keybindings.md

@@ -63,7 +63,7 @@ This opens a quick panel displaying the current toggle values and their correspo
 
 **Keybinding:** <kbd>shift+escape</kbd>
 
-This will show the LaTeXTools build panel, including any messages from the previous build. This is useful if you have hidden the build panel, either using the `hide_build_panel` setting or by pressing <kbd>escape</kbd> when the panel is visible.
+This will show the LaTeXTools build panel, including any messages from the previous build. This is useful if build panel is not shown automatically due to `show_panel_on_build` setting or hidden by pressing <kbd>escape</kbd>.
 
 ## Removing temporary files from build
 

docs/settings.md

@@ -129,12 +129,12 @@ This section refers to setting that can be found in a platform-specific block fo
 * `highlight_build_panel` (`true`): if `true` the build panel will have a syntax applied to highlight any errors and warnings. Otherwise, the standard output panel configuration will be used.
 * `build_panel_word_wrap` (`false`): if `true` enable word wrapping in build output panel.
 * `scroll_build_panel_to_top` (`false`): if `true` the build output panel is scrolled to top after build finished.
-* `hide_build_panel` (`"no_badboxes"`): controls whether or not to hide the build panel after a build is finished. Possible values:
-	* `"always"`: always hide the panel, even if build failed.
-	* `"no_errors"`: hide the panel if there are no errors.
-	* `"no_warnings"`: hide the panel if there are neither errors nor warnings.
-	* `"no_badboxes"`: hide the panel if there are no errors, warnings, or badboxes; differs from `no_warnings` if `display_bad_boxes` is set to `true`.
-	* `"never"`: never hide the build panel.
+* `show_panel_on_build` (`"badboxes"`): controls when build output panel is displayed. Possible values:
+	* `"always"`: always show build panel.
+	* `"errors"`: show build panel if there are errors.
+	* `"warnings"`: show build panel if there are errors or warnings.
+	* `"badboxes"`: show build panel if there are errors, warnings, or badboxes; differs from `"warnings"` if `display_bad_boxes` is set to `true`.
+	* `"never"`: never show build panel, even if build failed.
 Any other value will be interpreted as the default.
 * `display_bad_boxes` (`false`): if `true` LaTeXTools will display any bad boxes encountered after a build. Note that this is disabled by default.
 * `show_error_phantoms` (`"warnings"`): **ST3 Build 3118 or newer only** controls which errors are displayed via phantoms. Possible values:

latextools/make_pdf.py

@@ -195,7 +195,7 @@ def worker(self, activity_indicator):
             # Note: At least latexmk is known to behave like that.
             message = "Build failed!" if aborted else "Build skipped!"
             activity_indicator.finish(message)
-            if aborted or self.caller.hide_panel_level == "never":
+            if aborted or self.caller.show_panel_level == "always":
                 self.caller.show_output_panel()
             self.caller.output(f"\n[{message}]")
             self.caller.finish(aborted == False)
@@ -255,14 +255,14 @@ def worker(self, activity_indicator):
                 content.append(log_file + ":1: Double-click here to open the full log.")
 
                 show_panel = {
-                    "always": False,
-                    "no_errors": bool(errors),
-                    "no_warnings": bool(errors or warnings),
-                    "no_badboxes": bool(
+                    "always": True,
+                    "errors": bool(errors),
+                    "warnings": bool(errors or warnings),
+                    "badboxes": bool(
                         errors or warnings or (self.caller.display_bad_boxes and badboxes)
                     ),
-                    "never": True,
-                }.get(self.caller.hide_panel_level, bool(errors or warnings))
+                    "never": False,
+                }.get(self.caller.show_panel_level, bool(errors or warnings))
 
                 message = "Build completed"
                 if show_panel:
@@ -431,8 +431,8 @@ def run(
 
         self.output_view.set_read_only(True)
 
-        self.hide_panel_level = get_setting("hide_build_panel", "no_badboxes", view)
-        if self.hide_panel_level == "never":
+        self.show_panel_level = get_setting("show_panel_on_build", "badboxes", view)
+        if self.show_panel_level == "always":
             self.show_output_panel(force=True)
 
         self.plat = sublime.platform()
@@ -571,7 +571,7 @@ def output(self, data):
         )
 
     def show_output_panel(self, force=False):
-        if force or self.hide_panel_level != "always":
+        if force or self.show_panel_level != "never":
             self.window.run_command("show_panel", {"panel": "output.latextools"})
 
     # Also from exec.py