Merge branch 'develop'

cmhughes · Jul 18, 2024 · 78d452f · 78d452f
2 parents fed474e + 3827ce7
commit 78d452f
Show file tree

Hide file tree

Showing 20 changed files with 45 additions and 22 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -17,7 +17,7 @@ FROM perl:5.40.0-slim-threaded-buster
 #
 
 ARG LATEXINDENT_VERSION
-ENV LATEXINDENT_VERSION ${LATEXINDENT_VERSION:-V3.24.3}
+ENV LATEXINDENT_VERSION ${LATEXINDENT_VERSION:-V3.24.4}
 
 RUN apt-get update \
     && apt-get install \

diff --git a/LatexIndent/Version.pm b/LatexIndent/Version.pm
@@ -20,6 +20,6 @@ use warnings;
 use Exporter qw/import/;
 our @EXPORT_OK = qw/$versionNumber $versionDate/;
 
-our $versionNumber = '3.24.3';
-our $versionDate   = '2024-07-14';
+our $versionNumber = '3.24.4';
+our $versionDate   = '2024-07-18';
 1
diff --git a/LatexIndent/Wrap.pm b/LatexIndent/Wrap.pm
@@ -659,6 +659,13 @@ sub text_wrap_comment_blocks {
     # call the text wrapping routine
     my $columns = ${ $mainSettings{modifyLineBreaks}{textWrapOptions} }{columns};
 
+    # fail gracefully if columns == 0
+    if ($columns==0){
+        $logger->warn("* textWrapOptions: columns is set to 0, can't text wrap with this");
+        ${ ${ $mainSettings{modifyLineBreaks}{textWrapOptions} }{comments} }{wrap} = 0;
+        return;
+    } 
+
     #
     # text wrap comment blocks
     #

diff --git a/defaultSettings.yaml b/defaultSettings.yaml
@@ -1,5 +1,5 @@
 #
-# latexindent.pl, version 3.24.3, 2024-07-14
+# latexindent.pl, version 3.24.4, 2024-07-18
 #
 # defaultSettings.yaml, the default settings for latexindent.pl
 #

diff --git a/documentation/changelog.md b/documentation/changelog.md
@@ -1,6 +1,9 @@
-<!-- announcement: -y switch bug fix for lookForAlignDelims-->
+<!-- announcement: graceful fail for columns=0 text wrapping-->
 
 # changelog.md
+## V3.24.4, July 18, 2024
+graceful fail for `columns=0` when text wrapping block comments, see [issue 552](https://github.com/cmhughes/latexindent.pl/issues/552)
+
 ## V3.24.3, July 14, 2024
 `-y` switch bug fix for `lookForAlignDelims`, see [issue 551](https://github.com/cmhughes/latexindent.pl/issues/551)
 

diff --git a/documentation/conf.py b/documentation/conf.py
@@ -63,9 +63,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'3.24.3'
+version = u'3.24.4'
 # The full version, including alpha/beta/rc tags.
-release = u'3.24.3'
+release = u'3.24.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/documentation/demonstrations/pre-commit-config-conda.yaml b/documentation/demonstrations/pre-commit-config-conda.yaml
@@ -1,5 +1,5 @@
 - repo: https://github.com/cmhughes/latexindent.pl
-  rev: V3.24.3
+  rev: V3.24.4
   hooks:
   - id: latexindent-conda
     args: [-s]
diff --git a/documentation/demonstrations/pre-commit-config-cpan.yaml b/documentation/demonstrations/pre-commit-config-cpan.yaml
@@ -1,5 +1,5 @@
 - repo: https://github.com/cmhughes/latexindent.pl
-  rev: V3.24.3
+  rev: V3.24.4
   hooks:
   - id: latexindent
     args: [-s]
diff --git a/documentation/demonstrations/pre-commit-config-demo.yaml b/documentation/demonstrations/pre-commit-config-demo.yaml
@@ -1,5 +1,5 @@
 - repo: https://github.com/cmhughes/latexindent.pl
-  rev: V3.24.3
+  rev: V3.24.4
   hooks:
   - id: latexindent
     args: [-l, -m, -s, -w]
diff --git a/documentation/demonstrations/pre-commit-config-docker.yaml b/documentation/demonstrations/pre-commit-config-docker.yaml
@@ -1,5 +1,5 @@
 - repo: https://github.com/cmhughes/latexindent.pl
-  rev: V3.24.3
+  rev: V3.24.4
   hooks:
     - id: latexindent-docker
       args: [-s]
diff --git a/documentation/latexindent-yaml-schema.json b/documentation/latexindent-yaml-schema.json
@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/schema",
   "$id": "latexindent-yaml-schema.json",
   "title": "latexindent.pl YAML schema",
-  "description": "latexindent.pl YAML schema helper, V3.24.3 2024-07-14",
+  "description": "latexindent.pl YAML schema helper, V3.24.4 2024-07-18",
   "type": "object",
   "properties": {
     "fileExtensionPreference": {

diff --git a/documentation/readme.txt b/documentation/readme.txt
@@ -1,5 +1,5 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-    latexindent.pl, version 3.24.3, 2024-07-14
+    latexindent.pl, version 3.24.4, 2024-07-18
 
     PERL script to indent code within environments, and align delimited 
     environments in .tex files.

diff --git a/documentation/title.tex b/documentation/title.tex
@@ -8,14 +8,14 @@
 			sharp corners,
 			enhanced,
 			overlay={\node[anchor=north east,outer sep=2pt] at ([xshift=3cm,yshift=4mm]frame.north east) {\includegraphics[width=3cm]{logo}}; }]
-		\centering\ttfamily\bfseries latexindent.pl\\[1cm] Version 3.24.3
+		\centering\ttfamily\bfseries latexindent.pl\\[1cm] Version 3.24.4
 	\end{tcolorbox}
 }
 \author{Chris Hughes \thanks{and contributors!
 		See \vref{sec:contributors}.
 		For
 		all communication, please visit \cite{latexindent-home}.}}
-\date{2024-07-14}
+\date{2024-07-18}
 \maketitle
 \begin{adjustwidth}{1cm}{1cm}
 	\small

diff --git a/helper-scripts/update-version.sh b/helper-scripts/update-version.sh
@@ -48,10 +48,10 @@
 #        - <upload latexindent.zip to ctan>
 
 minorVersion=0
-oldVersion='3.24.2'
-newVersion='3.24.3'
-oldDate='2024-06-15'
-newDate='2024-07-14'
+oldVersion='3.24.3'
+newVersion='3.24.4'
+oldDate='2024-07-14'
+newDate='2024-07-18'
 updateVersion=0
 gitMode=0
 

diff --git a/latexindent.pl b/latexindent.pl
@@ -1,6 +1,6 @@
 #!/usr/bin/env perl
 #
-#   latexindent.pl, version 3.24.3, 2024-07-14
+#   latexindent.pl, version 3.24.4, 2024-07-18
 #
 #	This program is free software: you can redistribute it and/or modify
 #	it under the terms of the GNU General Public License as published by

diff --git a/readme.md b/readme.md
@@ -21,7 +21,7 @@ and [pre-commit](https://latexindentpl.readthedocs.io/en/latest/sec-appendices.h
 
 ## version
 
-    latexindent.pl, version 3.24.3, 2024-07-14
+    latexindent.pl, version 3.24.4, 2024-07-18
 
 ## author
 Chris Hughes (cmhughes)
@@ -157,7 +157,7 @@ framework](https://pre-commit.com) by adding this to your
 
 ```yaml
   - repo: https://github.com/cmhughes/latexindent.pl.git
-    rev: V3.24.3
+    rev: V3.24.4
     hooks:
       - id: latexindent
 ```

diff --git a/test-cases/text-wrap/issue-552.tex b/test-cases/text-wrap/issue-552.tex
@@ -0,0 +1,2 @@
+% 1
+%  2
diff --git a/test-cases/text-wrap/issue-552.txt b/test-cases/text-wrap/issue-552.txt
@@ -0,0 +1,2 @@
+WARN:   textWrapOptions: columns is set to 0, can't text wrap with this
+       No objects found.
diff --git a/test-cases/text-wrap/issue-552.yaml b/test-cases/text-wrap/issue-552.yaml
@@ -0,0 +1,4 @@
+modifyLineBreaks:
+  textWrapOptions:
+    comments:
+      wrap: 1
diff --git a/test-cases/text-wrap/text-wrap-remove-PLB.sh b/test-cases/text-wrap/text-wrap-remove-PLB.sh
@@ -281,6 +281,11 @@ latexindent.pl -s -m -r -l issue-502.yaml,addruler2.yaml issue-502.tex -o=+-mod1
 latexindent.pl -s -m -r -l issue-502a.yaml,addruler2.yaml issue-502a.tex -o=+-mod1
 
 latexindent.pl -s -l issue-506.yaml -m issue-506.tex -o=+-mod1
+
+latexindent.pl -l issue-552.yaml -m issue-552.tex -s
+cp indent.log issue-552.txt
+perl -p0i -e 's/.*?(WARN)/$1/s' issue-552.txt
+perl -p0i -e 's/INFO:.*//s' issue-552.txt
 set +x
 [[ $gitStatus == 1 ]] && git status
 [[ $noisyMode == 1 ]] && makenoise
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		WARN: textWrapOptions: columns is set to 0, can't text wrap with this
		No objects found.