Giter Site home page Giter Site logo

jubilant-computing-machine's Introduction

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

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/wesley-dean-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'

jubilant-computing-machine's People

Contributors

dependabot[bot] avatar wesley-dean-flexion avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.