Vale Server v1.4

A re-designed Dashboard, including a new rule editor with built-in regex101 integration.

Vale Server’s new Studio page

Vale Studio [beta]

One of Vale’s most popular features is its support for YAML-based rules, which allow for a high degree of customization and extensibility without requiring any programming experience. The new Studio dashboard page leverages the machine-readable nature of these YAML files to offer a suite of validation and debugging tools.

Validation

At the most basic level, Vale Studio will warn about “malformed” rules — such as those with YAML formatting errors or missing keys.

Vale Studio warning about a rule missing an 'extends' keys.

Testing

Assuming a rule passes the validation suite, its results will be shown in the right-hand editor panel:

Vale Studio displaying a rule’s in-text alerts.

regex101 Integration

Many of Vale’s extension points are designed to provide a layer of abstraction over raw regular expressions, allowing for less boilerplate and more maintainable patterns. For example, consider the following substitution rule:

A substitution rule implementing a subset of the Plain Language guidelines.
\b(?:(accompany)|(address)|(allocate)|(abundance)|(accelerate))\b
A demonstration of Vale Studio’s regex101 integration.

Going Forward

Vale Server’s new Studio page represents a significant improvement to Vale’s development workflow, but there’s still quite a bit of work to be done — future releases of Vale Server will include the following additions:

  • Support for spelling rules, including regex101 integration for filters and auto-generated ignore files.
  • Support for multi-pattern and exception-based rules (conditional, consistency, and capitalization).
  • Support for importing, exporting, and saving Studio sessions.

--

--

An open-source software developer with interests in natural language processing, data science, and collaborative writing. More @ https://github.com/jdkato.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Joseph Kato

An open-source software developer with interests in natural language processing, data science, and collaborative writing. More @ https://github.com/jdkato.