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
-
Is AI Coming to Your Ubuntu Desktop?
According to the VP of Engineering at Canonical, AI could soon be added to the Ubuntu desktop distribution.
-
Framework Laptop 13 Pro Competes with the Best
Framework has released what might be considered the MacBook of Linux devices.
-
The Latest CachyOS Features Supercharged Kernel
The latest release of CachyOS brings with it an enhanced version of the latest Linux kernel.
-
Kernel 7.0 Is a Bit More Rusty
Linux kernel 7.0 has been released for general availability, with Rust finally getting its due.
-
France Says "Au Revoir" to Microsoft
In a move that should surprise no one, France announced plans to reduce its reliance on US technology, and Microsoft Windows is the first to get the boot.
-
CIQ Releases Compatibility Catalog for Rocky Linux
The company behind Rocky Linux is making an open catalog available to developers, hobbyists, and other contributors, so they can verify and publish compatibility with the CIQ lineup.
-
KDE Gets Some Resuscitation
KDE is bringing back two themes that vanished a few years ago, putting a bit more air under its wings.
-
Ubuntu 26.04 Beta Arrives with Some Surprises
Ubuntu 26.04 is almost here, but the beta version has been released, and it might surprise some people.
-
Ubuntu MATE Dev Leaving After 12 years
Martin Wimpress, the maintainer of Ubuntu MATE, is now searching for his successor. Are you the next in line?
-
Kali Linux Waxes Nostalgic with BackTrack Mode
For those who've used Kali Linux since its inception, the changes with the new release are sure to put a smile on your face.
