Enforcing text style with Vale
Prose Police
Maintaining a consistent style can become challenging when multiple individuals contribute to a software project's documentation or a magazine. Vale checks your plain text files and even allows you to create custom style rules.
Vale [1] is an open source command-line tool used to enforce editorial style guidelines in texts. It doesn't work with word processors such as LibreOffice Writer. Instead, it's tailored for documents composed in plain-text markup languages such as Markdown [2], reStructuredText [3], AsciiDoc [4], or HTML. These markup languages are often used in documentation of open source projects, making Vale an ideal tool for enforcing a consistent style in software documentation. The list of Vale users [5] encompasses companies and projects such as Microsoft, Docker, Linode, Red Hat, GitLab, Grafana Labs, Neo4j, Angular, and Fedora.
Of course, Vale isn't restricted to documentation. As long as you write your texts in one of the supported markup languages, Vale can check them. Since I've always written my magazine articles in Markdown, I began to use Vale a few years ago to check them for common language errors, using some custom rules to cater for the preferences of different magazines. I like how Vale provides capabilities for my text files that I'm familiar with from code linters for programming languages.
Installing Vale
The Vale project publishes its source code [6], written in Go, on GitHub under the MIT license. The Vale releases [7] page offers downloadable precompiled binaries for Linux, macOS, and Windows. Some Linux distributions have packaged Vale and offer it through their repositories, but these are often older releases. There are also third-party packages available to install Vale from PyPI or from npm. Docker Hub also hosts Vale as a container image, jdkato/vale [8]. You can find instructions for all installation types [9] in Vale's documentation.
[...]
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Manjaro 26.0 Primary Desktop Environments Default to Wayland
If you want to stick with X.Org, you'll be limited to the desktop environments you can choose.
-
Mozilla Plans to AI-ify Firefox
With a new CEO in control, Mozilla is doubling down on a strategy of trust, all the while leaning into AI.
-
Gnome Says No to AI-Generated Extensions
If you're a developer wanting to create a new Gnome extension, you'd best set aside that AI code generator, because the extension team will have none of that.
-
Parrot OS Switches to KDE Plasma Desktop
Yet another distro is making the move to the KDE Plasma desktop.
-
TUXEDO Announces Gemini 17
TUXEDO Computers has released the fourth generation of its Gemini laptop with plenty of updates.
-
Two New Distros Adopt Enlightenment
MX Moksha and AV Linux 25 join ranks with Bodhi Linux and embrace the Enlightenment desktop.
-
Solus Linux 4.8 Removes Python 2
Solus Linux 4.8 has been released with the latest Linux kernel, updated desktops, and a key removal.
-
Zorin OS 18 Hits over a Million Downloads
If you doubt Linux isn't gaining popularity, you only have to look at Zorin OS's download numbers.
-
TUXEDO Computers Scraps Snapdragon X1E-Based Laptop
Due to issues with a Snapdragon CPU, TUXEDO Computers has cancelled its plans to release a laptop based on this elite hardware.
-
Debian Unleashes Debian Libre Live
Debian Libre Live keeps your machine free of proprietary software.

