Latexindent.pl Save

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.

Project README

latexindent.pl

Build Status Build status Documentation Status pre-commit

latexindent logo

latexindent.pl is a perl script to beautify/tidy/format/indent (add horizontal leading space to) code within environments, commands, after headings and within special code blocks.

It has the ability to align delimiters in environments and commands, and can modify line breaks including text wrapping and one-sentence-per-line.

It can also perform string-based and regex-based substitutions/replacements. The script is customisable through its YAML interface.

It has support for Conda, docker and pre-commit.

version

latexindent.pl, version 3.20.1, 2023-01-07

author

Chris Hughes (cmhughes)

example

Before:

\begin{one}
latexindent.pl adds leading
space to code blocks.
\begin{two}
It aims to beautify .tex, .sty
and .cls files. It is customisable
via its YAML interface.
\end{two}
\end{one}

After running

latexindent.pl myfile.tex

then you receive:

\begin{one}
	latexindent.pl adds leading
	space to code blocks.
	\begin{two}
		It aims to beautify .tex, .sty
		and .cls files. It is customisable
		via its YAML interface.
	\end{two}
\end{one}

tl;dr, a quick-start section is available for those short of time.

There are many more features available, detailed in full within the documentation.

documentation

For complete details, please see:

getting started

perl users

You'll need

latexindent.pl
LatexIndent/*.pm
defaultSettings.yaml

in the same directory.

You'll need a few readily-available perl modules. Full details are given within the Appendix of the documentation; you might also like to see .travis.yml for Linux/MacOS users, and .appveyor.yml for Strawberry perl users.

Windows users without perl Windows users who do not have a perl installation might prefer to get
latexindent.exe

latexindent.exe is a standalone executable file which does not require a perl installation. It is available at releases page of this repository and also from https://ctan.org/tex-archive/support/latexindent.

Linux users Please see the [Linux section of the appendix](https://latexindentpl.readthedocs.io/en/latest/sec-appendices.html#linux)
Ubuntu Linux users without perl Ubuntu Linux users who do not have a perl installation might try the standalone executable
latexindent-linux

which should be saved as simply latexindent. It is available at releases page of this repository and also from https://ctan.org/tex-archive/support/latexindent.

Mac users Please see the [Mac section of the appendix](https://latexindentpl.readthedocs.io/en/latest/sec-appendices.html#mac)
Mac users without perl Mac users who do not have a perl installation might try the standalone executable
latexindent-macos

which should be saved as simply latexindent. It is available at releases page of this repository and also from https://ctan.org/tex-archive/support/latexindent.

conda users If you use conda you'll only need
conda install latexindent.pl -c conda-forge

this will install the executable and all its dependencies (including perl) in the activate environment. You don't even have to worry about defaultSettings.yaml as it is included too.

Full details at using conda.

Important: the executable name is latexindent.pl (not latexindent).

Conda Version

docker users If you use latexindent via docker you'll only need
docker pull ghcr.io/cmhughes/latexindent.pl
docker run -v /path/to/local/myfile.tex:/myfile.tex --rm -it ghcr.io/cmhughes/latexindent.pl -s -w myfile.tex

Full details at using docker.

pre-commit

You can use latexindent with the pre-commit framework by adding this to your .pre-commit-config.yaml:

  - repo: https://github.com/cmhughes/latexindent.pl.git
    rev: V3.20.1
    hooks:
      - id: latexindent

Full details at pre-commit users, including a worked example demonstrating how you can add a .latexindent.yaml to the root of the git repo to customize the behavior.

testing

A nice way to test the script is to navigate to the test-cases directory, and then run the command (on Linux/Mac -- sorry, a Windows test-case version is not available):

./test-cases.sh

important

This script may not work for your style of formatting; I highly recommend that when you first use the script you use the -o switch to output to a separate file; something like

latexindent.pl myfile.tex -o myfile-output.tex

and then check myfile-output.tex carefully to make sure that nothing has been changed (or removed) in a way that will damage your file.

I recommend using each of the following:

  • a visual check, at the very least;
  • a check using latexdiff myfile.tex myfile-output.tex.

I recommend using a version control system to track your files, especially if you intend to use latexindent.pl to modify files.

feature requests

I'm happy to review feature requests, but I make no promises as to if they will be implemented; if they can be implemented, I make no promises as to how long it will take to implement them, and in which order I do so -- some features are more difficult than others! Feel free to post on the issues page of this repository, but please do use the given issue template!

development model

I follow the development model given here: http://nvie.com/posts/a-successful-git-branching-model/ which means that latexindent.pl always has (at least) two branches:

main
develop

The main branch always contains the released version and develop contains the development version. When developing a new feature or bug fix, I typically use:

git checkout develop
git checkout -b feature/name-of-feature

and then I merge it into the develop branch using

git checkout develop
git merge feature/name-of-feature --no-ff

perl version

I develop latexindent.pl on Ubuntu Linux, using perlbrew; I currently develop on perl version v5.36.0

GitHub Actions

The standalone executables latexindent.exe, latexindent-linux, latexindent-macos are created and released by GitHub Actions; the file that controls this is available within the github/workflows directory of this repository, and you can track the actions on the actions page of this repository.

Batch latexindent.pl check Publish latexindent.exe Publish docker image

build status

I use both travis-ci (Linux) and AppVeyor (Windows) as continuous integration services to test latexindent.pl for a small selection of test cases for every commit (I use git to track changes in the many test cases listed in the test-cases directory); you can see which versions of perl are tested by travis-ci within .travis.yml. Additionally, GitHub actions performs checks on a selection of test cases on every commit.

Build Status Build status

You might like to checkout the following related projects on github.

arara: GitHub stars

atom-beautify: GitHub stars

LaTeX-Workshop: GitHub stars

Neelfrost/dotfiles: GitHub stars

latex-formatter: GitHub stars

thank you

Thank you to the contributors to the project!

quotes

I find that the following quotes resonate with me with regards to my approach to latexindent.pl:

  • I want people to use Perl. I want to be a positive ingredient of the world and make my American history. So, whatever it takes to give away my software and get it used, that's great. Larry Wall
  • A common, brute-force approach to parsing documents where newlines are not significant is to read ... the entire file as one string ... and then extract tokens one by one, Christiansen & Torkington, Perl Cookbook, Section 6.16
  • Once you understand the power that regular expressions provide, the small amount of work spent learning them will feel trivial indeed Friedl, Mastering Regular Expressions, end of Chapter 1.
  • a problem speaks to them, and they have to solve it...and it becomes a hobby. But they keep coming back to it every now and then. They keep tinkering. It will never be finished...that's the point of a hobby, Westwood to Reacher in 'Make Me', Lee Child
  • Do the best you can until you know better. Then when you know better, do better. Maya Angelou

changelog

changelog.md provides details of the history of the project.

Open Source Agenda is not affiliated with "Latexindent.pl" Project. README Source: cmhughes/latexindent.pl
Stars
644
Open Issues
3
Last Commit
3 weeks ago
License

Open Source Agenda Badge

Open Source Agenda Rating