01 Nov 12:55

811c650

v0.6.0

First release in a while! I've been very busy this past month and was also sick for a bit. Not a ton going on this release, but there are some folks waiting for the minor fixes and one feature, so I figured no reason to delay the release.

Features

Disallow yaml anchors and aliases
- New basic formatter configuration option disallow_anchors will forcefully reject anchors if you don't want them in your yaml files

Fixes

Fixed a bug where emoji_support would eat any \ escape character
Fixed misuse of path package when should have been using filepath package for cross-platform compatibility
Fixed issue where the tool would try to format a directory if it was picked up the include path

Contributors

Thanks @imjasonh for their first contribution, the disallow_anchors feature!
Thanks @longkai for the filepath fix and for adding a GitHub Action to automate releases!

Contributors

imjasonh and longkai

Assets 11

22 Sep 01:05

braydonk

v0.5.0

f0be560

v0.5.0

There was a bug in v0.4.0 caused by my oversight that I previously relied on empty string to represent no diffs. With the more robust reporter this was no longer true. I pulled in an update to the package that provides a diff count from the Diff function and used that instead. While fixing that, I realized that the line separator for the multilinediff also assumed lf line endings, which was basically a bug since the beginning. I fixed it with a rearchitecture that allowed for line_ending to be a global setting. There is a chance I'll decide to adjust this again in the future, but in my current architecture that was the only way to make it work (other than autodetecting the line endings based on OS, but OS does not always imply line endings since there's lots of LF line ending folks on Windows).
It also made sense while doing this to adjust the yamlfmt.Factory interface to simply be one function NewFormatter, and make it so that function handles the case where the passed config is nil.

Changelog

f0be560 feat: global linesep character, handle diffs (#50)

Assets 11

20 Sep 14:19

braydonk

v0.4.0

f3eff05

v0.4.0

This release is smaller than the last few. I wanted to get a release out before I go on leave for a bit.

Changes

`emoji_support`

This is a combination of a fix and a feature; the yaml.v3 library does not properly parse emojis because it cannot properly print 4-byte UTF-8 characters. Hopefully that gets fixed soon, and #41 is open to track that when it happens. While this would be sensible to make a default behaviour, I've opted to default to false because it is a hack around a shortcoming of the upstream library.

`retain_line_breaks`

When this is enabled, yamlfmt will keep line breaks instead of deleting them. Similar to emoji_support, I would have liked to make this default but because it's a hack around a shortcoming of the library I'm defaulting it to false as well.

Functional Features architecture

This is an improvement to the API of the Basic Formatter, and features improvements to the base yamlfmt package as well. Previously, there were lots of special conditions tacked on before and after formatting in the Format function of the Basic Formatter, and it was becoming increasingly tangled when the needs of the function expanded. This improves the extensibility of the formatter, which allows for "features" to be created and added to be run as hooks before and after yaml formatting. Future formatters that I write in this package will use it. This marks an improvement to folks forking this tool and adding their own functionality in, provides a nicer basis for folks interested in writing their own formatters, and should hopefully make future contribution a lot more straightforward.

Diff improvement

I've made another improvement to the diff readability. The diff now shows side by side, making it far more easy to read. It still needs some more work, however I've separated that work into a new package that I will from here on incrementally improve in my spare time.

stdout output is more convenient

I had used fmt.Println to output to stdout in previous versions. This caused a problem for folks using yamlfmt as an editor integration, since yamlfmt already appends a newline to the formatted yaml. This release swapped to fmt.Print instead.

If you have any problems or suggestions, feel free to make an issue!

Contributors

Thanks to @longkai for the retaining line break feature and the fix to stdout output.