Merge pull request #397 from essentialkaos/develop

Version 12.83.1

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### 12.83.1
+
+* `[protip]` Disabling tips using environment variable (`PROTIP=0`)
+
 ### 12.83.0
 
 * `[protip]` Added new package for showing usage tips

ek.go

@@ -20,7 +20,7 @@ import (
 // ////////////////////////////////////////////////////////////////////////////////// //
 
 // VERSION is current ek package version
-const VERSION = "12.83.0"
+const VERSION = "12.83.1"
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 

protip/protip.go

@@ -3,6 +3,7 @@ package protip
 
 import (
 	"math/rand"
+	"os"
 
 	"github.com/essentialkaos/ek/v12/fmtc"
 	"github.com/essentialkaos/ek/v12/fmtutil/panel"
@@ -40,6 +41,8 @@ var Options = panel.Options{panel.TOP_LINE, panel.BOTTOM_LINE}
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
+var disabled = os.Getenv("PROTIP") == "0"
+
 var collection *Tips
 
 // ////////////////////////////////////////////////////////////////////////////////// //
@@ -50,6 +53,11 @@ func Add(tips ...*Tip) {
 		collection = &Tips{}
 	}
 
+	// Don't add if tips are disabled by env vars
+	if disabled {
+		return
+	}
+
 	for _, tip := range tips {
 		if tip == nil || tip.Title == "" ||
 			tip.Message == "" || !fmtc.IsTag(tip.ColorTag) {
@@ -66,7 +74,7 @@ func Add(tips ...*Tip) {
 
 // Show shows random tip if required
 func Show(force bool) bool {
-	if collection == nil || len(collection.data) == 0 {
+	if collection == nil || len(collection.data) == 0 || disabled {
 		return false
 	}
 

protip/protip_test.go

@@ -42,6 +42,14 @@ func (s *TipSuite) TestAdd(c *C) {
 	c.Assert(collection.data, HasLen, 0)
 
 	tip.Message = "Test message"
+
+	disabled = true
+
+	Add(tip)
+	c.Assert(collection.data, HasLen, 0)
+
+	disabled = false
+
 	Add(tip)
 	c.Assert(collection.data, HasLen, 1)
 	c.Assert(collection.data[0].Weight, Equals, 0.5)

usage/usage_test.go

@@ -146,7 +146,7 @@ func (s *UsageSuite) TestUsage(c *C) {
 	c.Assert(info.GetOption("u:unknown").String(), Equals, "")
 }
 
-func (s *UsageSuite) TestDeattachedPrint(c *C) {
+func (s *UsageSuite) TestDetachedPrint(c *C) {
 	cmd := &Command{Name: "test", Desc: "Test command", ColorTag: "{#99}"}
 	opt := &Option{Long: "test", Short: "T", Desc: "Test option", ColorTag: "{#99}"}