Introducing Vale Server

A control flow diagram of Vale Server’s functionality

Vale Server 101

Vale Server running through its Visual Studio Code client.

Styles

Vale Server’s web-based dashboard.

Projects

Vale Server’s project-based vocabulary dashboard.
  • All entries in accept.txt are automatically added to a case-insensitive substitution rule (Vocab.Terms), ensuring that any occurrences of these words or phrases exactly match their corresponding entry in accept.txt. Each term is automatically added to every exception list in all inherited styles — meaning that you now only need to update your project’s vocabulary to customize third-party styles.
  • Entries in reject.txt are automatically added to an existence rule (Vocab.Avoid) that will flag all occurrences as errors.

Clients

Clients (Sublime Text 3 shown above) have rich support for Vale Server and its resources.
  • Jump to Rule Definition: Access a rule’s definition from its in-text occurrences.
  • Jump to Source: Open the relevant section of a style guide from occurrences of its rules.
  • StylesPath Navigation: Browse and edit your styles from within your editor.

Privacy

Vale vs. Vale Server

  1. A precise set of guidelines (i.e., error-level, fail-worthy rules) checked through Vale on your CI service; and
  2. an expanded set of guidelines checked (on-the-fly) through Vale Server’s various client integrations.

Going Forward

  • Microsoft Word and web browser clients;
  • an interactive Rule Creator for the dashboard;
  • multiple new styles (including a grammar-focused one);
  • support for XML documents; and
  • the ability to sync your projects across multiple computers and users.

--

--

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