#1066893 RFP: vale -- :pencil: A markup-aware linter for prose built with speed and extensibility in mind.

#1066893#5
Date:
2024-03-15 01:23:31 UTC
From:
To:
* Package name    : vale
  Version         : 3.0.0-1
  Upstream Author : errata.ai
* URL             : https://github.com/errata-ai/vale
* License         : Expat
  Programming Lang: Go
  Description     : A markup-aware linter for prose built with speed and extensibility in mind.

Vale is a command-line tool that brings code-like linting to
prose. It's fast, cross-platform (Windows, macOS, and Linux), and
highly customizable.

Key Features

    Support for markup: Vale has a rich understanding of many markup formats, allowing it to avoid syntax-related false positives and intelligently exclude code snippets from prose-related rules.

    A highly customizable extension system: Vale is capable of enforcing your style—be it a standard editorial style guide or a custom in-house set of rules (such as those created by GitLab, Homebrew, Linode, CockroachDB, and Spotify).

    Easy-to-install, stand-alone binaries: Unlike other tools, Vale doesn't require you to install and configure a particular programming language and its related tooling (such as Python/pip or Node.js/npm).
----

There are a handful of spell-checkers and linters for prose in Debian,
but vale is a little different. It's not *only* a spellchecker and does
*other* things like checking for styles or allow for extensibility.

Similar software include diction(1) and markdownlint, where diction is
*really* old (e.g. doesn't know about markdown) and mdl is not very
customizable (e.g. it's hard, in my experience to add words to a
dictionary).

So I'm considering vale instead.

#1066893#10
Date:
2024-03-15 01:56:05 UTC
From:
To:
A bunch of deps are missing from debian at the moment:

2024/03/14 21:19:20 Build-Dependency "github.com/pterm/pterm" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control
2024/03/14 21:19:20 Build-Dependency "github.com/d5/tengo" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control
2024/03/14 21:19:20 Build-Dependency "github.com/errata-ai/regexp2" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control
2024/03/14 21:19:20 Build-Dependency "github.com/mholt/archiver" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control
2024/03/14 21:19:20 Build-Dependency "github.com/adrg/strutil" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control
2024/03/14 21:19:20 Build-Dependency "github.com/errata-ai/ini" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control
2024/03/14 21:19:20 Build-Dependency "github.com/jdkato/twine" is not yet available in Debian, or has not yet been converted to use XS-Go-Import-Path in debian/control

so that's kind of a big undertaking. some of those are actually pretty
interesting on their own, like pterm looks like a cool lib!

Others are more of a problem, like errata-ai/regexp2 which is a fork of
an existing lib (*also* not in Debian). errata-ai/ini looks like a
rather gratitious fork as well.