mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-24 04:16:27 +02:00
60 lines
1.6 KiB
Go
60 lines
1.6 KiB
Go
// Package deprecate provides simple functions to standardize the output
|
|
// of deprecation notices on goreleaser
|
|
package deprecate
|
|
|
|
import (
|
|
"bytes"
|
|
"strings"
|
|
"text/template"
|
|
|
|
"github.com/apex/log"
|
|
"github.com/apex/log/handlers/cli"
|
|
"github.com/fatih/color"
|
|
"github.com/goreleaser/goreleaser/pkg/context"
|
|
)
|
|
|
|
const baseURL = "https://goreleaser.com/deprecations#"
|
|
|
|
// Notice warns the user about the deprecation of the given property.
|
|
func Notice(ctx *context.Context, property string) {
|
|
NoticeCustom(ctx, property, "`{{ .Property }}` should not be used anymore, check {{ .URL }} for more info")
|
|
}
|
|
|
|
// NoticeCustom warns the user about the deprecation of the given property.
|
|
func NoticeCustom(ctx *context.Context, property, tmpl string) {
|
|
ctx.Deprecated = true
|
|
// XXX: this is very ugly!
|
|
oldHandler, ok := log.Log.(*log.Logger).Handler.(*cli.Handler)
|
|
if !ok {
|
|
// probably in a test, and the cli logger wasn't set
|
|
return
|
|
}
|
|
w := oldHandler.Writer
|
|
handler := cli.New(w)
|
|
handler.Padding = cli.Default.Padding + 3
|
|
log := &log.Logger{
|
|
Handler: handler,
|
|
Level: log.InfoLevel,
|
|
}
|
|
// replaces . and _ with -
|
|
url := baseURL + strings.NewReplacer(
|
|
".", "",
|
|
"_", "",
|
|
":", "",
|
|
" ", "-",
|
|
).Replace(property)
|
|
var out bytes.Buffer
|
|
if err := template.Must(template.New("deprecation").Parse("DEPRECATED: "+tmpl)).Execute(&out, templateData{
|
|
URL: url,
|
|
Property: property,
|
|
}); err != nil {
|
|
panic(err) // this should never happen
|
|
}
|
|
log.Warn(color.New(color.Bold, color.FgHiYellow).Sprintf(out.String()))
|
|
}
|
|
|
|
type templateData struct {
|
|
URL string
|
|
Property string
|
|
}
|