Vale: enforcing style guidelines for text

Sun, 7 Apr 2024 03:40:42 +1000

Andrew Pam <xanni [at] glasswings.com.au>

Andrew Pam
https://lwn.net/Articles/964075/

'While programmers are used to having tools to check their code for stylistic
problems, writers often limit automatic checks of their texts to spelling and,
sometimes, grammar, because there are not a lot of options for further
checking. If that is the case, Vale, an open-source, command-line tool to
enforce editorial-style guidelines, would make a useful addition to their
toolbox. The recent release of Vale 3.0 warrants a look at this versatile tool,
which assists writers by identifying common errors and helping them maintain a
consistent voice in their prose.

Vale is the creation of Joseph Kato, who published the initial version in 2018.
He introduced it as "a command-line tool that brings code-like linting to
prose". In the context of programming, linting means analyzing source code to
flag common errors, suspicious constructs, and stylistic mistakes. The program
that does this analysis, known as a linter, typically adheres to a style guide,
such as PEP 8 for Python code. Kato's program provides writers with a similar
tool. However, it doesn't aim to serve writers who use word processors like
LibreOffice Writer. Instead, Vale supports documents composed in plain-text
markup languages such as Markdown, reStructuredText, AsciiDoc, or HTML.
Consequently, it aligns more closely with the needs of documentation writers
and technical writers.

Vale is written in the Go programming language, is cross-platform, and its code
is published on GitHub under the MIT license. Precompiled binaries are
available for Linux, macOS, and Windows. A few Linux distributions have
packaged Vale and offer it through their repositories. There are also
third-party packages enabling Vale installation from PyPI or from npm.'

Share and enjoy,
               *** Xanni ***
--
mailto:xanni@xanadu.net               Andrew Pam
http://xanadu.com.au/                 Chief Scientist, Xanadu
https://glasswings.com.au/            Partner, Glass Wings
https://sericyb.com.au/               Manager, Serious Cybernetics

Comment via email

Home E-Mail Sponsors Index Search About Us