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
-
Working Exploit for a Linux Kernel Flaw Made Public
Even before a bug received its CVE identifier or an upstream fix, the local privilege escalation vulnerability exploit found its way into the wild.
-
r/opensource Bans AI-Assisted and AI-Related Projects
The de facto subreddit for all things open source has not only banned AI-related projects but also users who "don't speak English."
-
Bottlenecks Discovered by Meta Engineers Lead to Scalability Improvements
Thanks to a small group of engineers at Meta, the Linux kernel module kernfs has been improved, which has led to some serious gains.
-
PwnEscape Poses VM Vulnerability
A guest-to-host escape flaw in Linux KVM, named PwnEscape, might be yet another means of attacking Linux.
-
Linux Mint 27 Set for a Christmas Release
The developers behind Linux Mint have announced a Christmas release, and it looks like Santa's sack will be brimming with features.
-
Is Linus Torvalds Vibe Coding?
The creator of Linux has added AI into his process for Linux kernel development, and it's more than just for debugging.
-
openKylin 3.0 Released with Expanded AI Integration
The latest release features a pre-installed AI agent to help perform tasks.
-
DigitalOcean Ends Open Source Credits Program
In a change that has surprised many open source developers, DigitalOcean has decided to sunset its Open Source Credits Program.
-
Office 365 Available for Testing on Linux via Bottles
Linux users can now test the official Office 365, thanks to Mirko Brombin's work on Bottles.
-
Dutch Government Turns to Open Source for Digital Sovereignty
Following in the footsteps of other European countries, the Netherlands is looking to increase its sovereign digital infrastructure with open source software.
