Skip to content

Commit

Permalink
Add Errorf to bunt
Browse files Browse the repository at this point in the history
Add `Errorf` function to create an error with styled text.
  • Loading branch information
HeavyWombat committed Jul 18, 2019
1 parent f8256db commit 006da9d
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 0 deletions.
28 changes: 28 additions & 0 deletions error.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Copyright © 2019 The Homeport Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package bunt

import "fmt"

// Errorf wraps fmt.Errorf(err error, format string, a ...interface{}) and evaluates any text markers into its respective format
func Errorf(format string, a ...interface{}) error {
return fmt.Errorf(Sprintf(format, a...))
}
44 changes: 44 additions & 0 deletions error_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright © 2019 The Homeport Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package bunt_test

import (
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"

. "github.com/gonvenience/bunt"
)

var _ = Describe("error functions", func() {
Context("process markdown style in Errorf function", func() {
BeforeEach(func() {
ColorSetting = ON
})

AfterEach(func() {
ColorSetting = AUTO
})

It("should parse and process markdown style in Errorf", func() {
Expect(Errorf("failed to start *%s*", "*X*").Error()).To(BeEquivalentTo("failed to start \x1b[1m*X*\x1b[0m"))
})
})
})

0 comments on commit 006da9d

Please sign in to comment.