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
-
Ubuntu Core 26 Offers Game-Changing Enterprise Features
Ubuntu Core 26 could be a game-changer for organizations looking for increased security and reliability.
-
AI Flooding the Linux Kernel Security Mailing List
AI is giving Linus Torvalds a headache, but not in the way you might think.
-
Top Priorities for Open Source Pros Seeking a New Job
Professional fulfillment tops the list, according to LPI report.
-
Container-Based Fedora Hummingbird Designed for Agent-First Builders
Fedora Hummingbird brings the same approach to the host OS as it does to containers to level up security.
-
Linux kernel Developers Considering a Kill Switch
With the rise of Linux vulnerabilities, the kernel developers are now considering adding a component that could help temporarily mitigate against them… in the form of a kill switch.
-
Fedora 44 Now Gaming Ready
The latest version of Fedora has been released with gaming support.
-
Manjaro 26.1 Preview Unveils New Features
The latest Manjaro 26.1 preview has been released with new desktop versions, a new kernel, and more.
-
Microsoft Issues Warning About Linux Vulnerability
The company behind Windows has released information about a flaw that affects millions of Linux systems.
-
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.
