feat: add notice on function call to inform or warn the end-users

go-sprout / sprout

From sprig to sprout - Useful template functions for Go templates with steroids

https://sprout.atom.codes

MIT License

86 stars 4 forks source link

feat: add notice on function call to inform or warn the end-users #58

Closed 42atomys closed 3 weeks ago

42atomys commented 3 weeks ago

Description

When you are a middle-app (between sprout and the user how write the template), you need to be careful when you upgrade a template library due to potential breaking changes or deprecated functions. This solution let developer be stress less about upgrade of sprout 🌱

Changes

Add notice feature
Add notice on numeric registry
Add notice on sprigin package

Fixes #57

Checklist

[x] I have read the CONTRIBUTING.md document.
[x] My code follows the code style of this project.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.
[x] I have updated the documentation accordingly.
[x] This change requires a change to the documentation on the website.

Additional Information

Example of output using a custom slog.Logger

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Files	Coverage Δ
handler.go	`100.0% <100.0%> (ø)`
notice.go	`100.0% <100.0%> (ø)`
registry.go	`100.0% <100.0%> (ø)`
registry/numeric/numeric.go	`94.1% <100.0%> (+1.0%)`	:arrow_up:
sprigin/sprig_backward_compatibility.go	`100.0% <100.0%> (ø)`
sprout.go	`100.0% <100.0%> (ø)`