• Stars
    star
    198
  • Rank 196,898 (Top 4 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 5 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

:octocat: The official GitHub Action for Vale -- install, manage, and run Vale with ease.

GitHub Actions + Vale

:octocat: The official GitHub Action for Vale -- install, manage, and run Vale with ease.

A demo screenshot.

Usage

Add the following (or similar) to one of your .github/workflows files:

name: reviewdog
on: [pull_request]

jobs:
  vale:
    name: runner / vale
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: errata-ai/vale-action@reviewdog

Repository Structure

The recommended repository structure makes use of the existing .github directory to hold all of our Vale-related resources:

.github
├── styles
│   └── vocab.txt
└── workflows
    └── main.yml
.vale.ini
...

Where styles represents your StylesPath. The top-level .vale.ini file should reference this directory:

StylesPath = .github/styles
MinAlertLevel = suggestion

[*.md]
BasedOnStyles = Vale

Inputs

You can further customize the linting processing by providing one of the following optional inputs.

version (default: latest)

NOTE: The provided version must be >= 2.16.0.

Specify the Vale CLI version to use.

with:
  version: 2.17.0

files (default: all)

files specifies where Vale will look for files to lint.

with:
  files: path/to/lint

You can supply this value one of four ways:

  • files: all (default): The repo's root directory; equivalent to calling vale ..

  • files: path/to/lint: A single file or directory; equivalent to calling vale path/to/lint.

  • files: '["input1", "input2"]': A JSON-formatted list of file or directory arguments; equivalent to calling vale input1 input2.

  • files: 'input1,input2': A character-delimited list of files. The character is determined by the input value separator:

    with:
      separator: ","

reporter (default: github-pr-check)

Set the reporter type.

with:
  # github-pr-check, github-pr-review, github-check
  reporter: github-pr-check

fail_on_error (default: false)

By default, reviewdog will return exit code 0 even if it finds errors. If fail_on_error is enabled, reviewdog exits with 1 when at least one error was reported.

with:
  fail_on_error: true

filter_mode (default: added)

Set the filter mode for reviewdog.

with:
  # added, diff_context, file, nofilter
  filter_mode: nofilter

vale_flags (default: "")

Space-delimited list of flags for the Vale CLI. To see a full list of available flags, run vale -h.

with:
  vale_flags: "--glob=*.txt"

token (default: secrets.GITHUB_TOKEN)

The GitHub token to use.

with:
  token: ${{secrets.VALE_GITHUB_TOKEN}}

More Repositories

1

vale

📝 A markup-aware linter for prose built with speed and extensibility in mind.
Go
4,468
star
2

packages

📦 A collection of pre-packaged, Vale-compatible style guides and configurations.
Go
101
star
3

Microsoft

A Vale-compatible implementation of the Microsoft Writing Style Guide.
Gherkin
84
star
4

Google

A Vale-compatible implementation of the Google Developer Documentation Style Guide.
Gherkin
68
star
5

vale-ls

⚡ An implementation of the Language Server Protocol (LSP) for the Vale command-line tool.
Rust
64
star
6

vale-vscode

A Visual Studio Code extension for the Vale CLI.
TypeScript
53
star
7

write-good

A Vale-compatible implementation of the write-good linter.
Gherkin
32
star
8

vale-boilerplate

An example repository showcasing how to use Vale.
28
star
9

IBM

A Vale-compatible implementation of IBM's Developer Editorial Style Guide.
Gherkin
23
star
10

proselint

A Vale-compatible implementation of Python's proselint linter.
Gherkin
20
star
11

vale.sh

💡 Website and documentation for the Vale CLI and related projects.
HTML
16
star
12

readability

Vale-compatible implementations of many popular "readability" metrics.
Go
15
star
13

alex

A Vale-compatible implementation of the guidelines enforced by the alex linter: catch insensitive, inconsiderate writing.
Gherkin
15
star
14

static-school

🏫 Discover, explore, and compare static site generators.
CSS
11
star
15

SubVale

A Sublime Text 3 client for Vale Server.
Python
10
star
16

Joblint

A Vale-compatible implementation of the Joblint linter
Gherkin
8
star
17

vale-atom

An Atom client for Vale Server.
CoffeeScript
5
star
18

Hugo

A Vale configuration for Hugo-generated static sites.
Go
5
star
19

vale-web

A browser extension for the Vale CLI.
Svelte
3
star
20

nlpapi

A language-agnostic API for basic NLP tasks.
Python
3
star
21

en_US-web

A modern, up-to-date Hunspell UTF-8 dictionary for American English.
Python
2
star
22

vale-snap

1
star
23

vale-native

🌐 A native messaging host for the Vale CLI: Use your local configurations in Chrome, Firefox, Opera, and Edge.
Go
1
star
24

LSP-vale-ls

A vale-ls client for Sublime Text.
Python
1
star
25

MediaWiki

A Vale-compatible implementation of the MediaWiki Documentation Style Guide.
Go
1
star
26

library

🔍 A unified (and indexed) library of Vale-related resources.
Go
1
star