Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 3.84 KB

README.md

File metadata and controls

114 lines (82 loc) · 3.84 KB
Raw

jubilant-computing-machine

The General Services Administration (GSA) provides guidance on using plain language when communicating in writing.

Plain language makes it easier for the public to read, understand, and use government communications.

This runs Vale using configuration that's supposed to help prose be more plain language.

Read more at PlainLanguage.gov.

Chris Chinchilla (website and GitHub) curates a series of style rules for Vale. Vale is an open-source command-line tool to give stylistic feedback to writers of content. The intention of these style rules is to help writers write using language that's more readable and accessible.

This tool

This is a containerized tool run from the command-line that includes Vale and a variety of style rules that tests prose.

This image is based on the work of Joseph Kato (GitHub), the original creator of Vale. The base image is available on DockerHub.

CI/CD scanning

LanguageTool Action or vale-linter may be more appropriate for scanning as a part of a CI/CD system. This action already includes the scaffolding to surface the scan results more cleanly, such as PR (Pull Request) comments.

Differences from the JDKato image

The key differences between this and the base image from JDKato are:

  • basic style caching
  • basic default Vale configuration
  • support enabled for more file formats
  • pinned, documented dependencies

Building

Building the image requires a container engine such as Docker or Podman.

docker build \
  --tag jubliant-computing-machine:latest \
  .

Running

Running a container, like building the image, requires a container engine. This example shows how to run a container with the current directory and a style cache bind-mounted to it. If the cache directory doesn't exist, it'll be created.

( [ ! -d "${HOME}/.valestyles" ] && mkdir -p "${HOME}/.valestyles" ) \
&& docker run \
  --interactive \
  --rm \
  --tty \
  --user "$(id --user)" \
  --volume "${PWD}:${PWD}" \
  --volume "${HOME}/.valestyles:/styles" \
  --workdir "${PWD}" \
  docker.io/wesleydeanflexion/jubliant-computing-machine

Custom Vocabularies

Custom vocabularies (regular expressions that may be allowed or prohibited) may be specified by adding lines to .vale.accept and .vale.reject, respectively. These correspond to accept.txt and reject.txt per the Vale Vocab documentation.

Custom Styles

Custom styles are also supported. When configured as a package (e.g., Readability, proselint, one may use the sync command to vale in order to download and install the appropriate packages.

Configuration Files

When a configuration file (.vale.ini) is available, it'll be used; if not, a default vale.ini will be used instead.

Public registries

The image is built and published to several public registries for your convenience:

  • DockerHub: docker.io/wesleydeanflexion/jubliant-computing-machine:latest
  • GitHub Container Registry: ghcr.io/flexion/jubilant-computing-machine:latest

Running as an alias

Including this line in your shell configuration file (e.g., .bashrc) will set an alias of vale that'll run the containerized image without installing Vale on your local system.

alias vale='docker run -it --rm -u "$(id --user)" -v "${PWD}:${PWD}" -v "${HOME}/.valestyles:/styles" -w "${PWD}" docker.io/wesleydeanflexion/jubliant-computing-machine'