cmhughes / latexindent.pl

Perl script to add indentation (leading horizontal space) to LaTeX files. It can modify line breaks before, during and after code blocks; it can perform text wrapping and paragraph line break removal. It can also perform string-based and regex-based substitutions/replacements. The script is customisable through its YAML interface.
GNU General Public License v3.0
884 stars 84 forks source link

Update readme.md to clarify executables name #335

Closed musm closed 2 years ago

tdegeus commented 2 years ago

Note that I'm happy to make an alias latexindent on conda (I don't think this will interfere with anything). If you want, you can open a PR here https://github.com/conda-forge/latexindent.pl-feedstock

But may first a comment from @cmhughes on this subject is wanted : https://github.com/cmhughes/latexindent.pl/blob/5cb5cdd8accebe517a831bd0f3fe8719d37717d2/Makefile.PL#L29 allows you to also distribute with CPAN if you want. In that case too the name of the executable will be latexindent.pl (as this is the name you have chosen for the script). In addition the name for pre-commit is latexindent.pl. I guess it is mostly on CTAN that the name is slightly inconsistent, but maybe it is good to take a long-term position on this. E.g. I can imagine you only use latexindent.pl except for CTAN

musm commented 2 years ago

Note that I'm happy to make an alias latexindent on conda

Honestly, that would make a lot of sense as most external applications expecting latexindent assume an executable and not a perl script. So I would be in favor if you would like to make that change.