diff --git a/Changes b/Changes index 172ed44..9744788 100644 --- a/Changes +++ b/Changes @@ -1,9 +1,10 @@ Revision history for Perl module YAML::Tidy -v0.7.1 2024-01-04 23:12:38+01:00 +v0.8.0 2024-01-05 22:38:36+01:00 - Fix tidying unicode files - Require YAML::LibYAML::API v0.14.0 + - Allow seralizing reused anchors - Change module versioning scheme 0.007 2022-08-06 00:09:43+02:00 diff --git a/LICENSE b/LICENSE index f125083..bd85e7e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -This software is copyright (c) 2022 by Tina Müller. +This software is copyright (c) 2024 by Tina Müller. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. @@ -12,7 +12,7 @@ b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- -This software is Copyright (c) 2022 by Tina Müller. +This software is Copyright (c) 2024 by Tina Müller. This is free software, licensed under: @@ -272,7 +272,7 @@ That's all there is to it! --- The Artistic License 1.0 --- -This software is Copyright (c) 2022 by Tina Müller. +This software is Copyright (c) 2024 by Tina Müller. This is free software, licensed under: diff --git a/Makefile.PL b/Makefile.PL index f3519b0..ad3b7b5 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -46,7 +46,7 @@ my %WriteMakefileArgs = ( "Test::Warnings" => "0.029", "YAML::LibYAML::API" => "0.14.0" }, - "VERSION" => "v0.7.1", + "VERSION" => "v0.8.0", "test" => { "TESTS" => "t/*.t" } diff --git a/dist.ini b/dist.ini index db4ae80..c138f07 100644 --- a/dist.ini +++ b/dist.ini @@ -2,9 +2,9 @@ name = YAML-Tidy author = Tina Müller license = Perl_5 copyright_holder = Tina Müller -copyright_year = 2022 +copyright_year = 2024 -version = v0.7.1 +version = v0.8.0 [@Filter] -bundle = @Basic diff --git a/lib/YAML/Tidy.pm b/lib/YAML/Tidy.pm index 4de8388..a5bdc30 100644 --- a/lib/YAML/Tidy.pm +++ b/lib/YAML/Tidy.pm @@ -947,16 +947,46 @@ YAML::Tidy - Tidy YAML files b: c: d -For documentation see L +=head1 DESCRIPTION + +yamltidy is a linter or rather a formatter for YAML files. + +It can adjust formatting without removing comments or blank lines. For examples see L -=head1 DESCRIPTION +The code can be found at L. + +=head1 FEATURES + +=over + +=item Trim trailing spaces + +=item Adjust indentation + +=item Add or remove headers and footers + +=item Remove unnecessary quotes (currently according to the YAML 1.2 Core Schema) -yamltidy can automatically tidy formatting in your YAML files, for example -adjust indentation and remove trailing spaces. +=item Serialize reused aliases -For more information, see L. +=back + +=head2 Plans + +=over + +=item Add option for batch processing multiple files, e.g. by extension + +=item Use exit code to signal if yamltidy did any changes + +=item Quoting: Allow to add patterns for strings that should be quoted + +=item For more, see L. Suggestions + welcome! + +=back =head1 METHODS @@ -1005,7 +1035,7 @@ Tina Müller Etinita@cpan.orgE =head1 COPYRIGHT AND LICENSE -Copyright 2020 by Tina Müller +Copyright 2024 by Tina Müller This library is free software and may be distributed under the same terms as perl itself. diff --git a/xt/03.spelling.t b/xt/03.spelling.t index 483ad5c..83e2ef1 100644 --- a/xt/03.spelling.t +++ b/xt/03.spelling.t @@ -10,6 +10,7 @@ add_stopwords(); all_pod_files_spelling_ok( qw( bin lib ) ); __DATA__ +linter perltidy yamllint yamltidy