Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@jdkato
jdkato committed Oct 21, 2024
1 parent e553080 commit 18ca075
Showing 1 changed file with 27 additions and 13 deletions.
40 changes: 27 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,20 @@ jobs:
> If you're using a markup format other than Markdown, you may need to install
> an external parser.
>
> For example, to use it with AsciiDoc add the following step to your workflow before calling `vale-action`:
> To use it with AsciiDoc, for example, add the following step to your workflow
> before calling `vale-action`:
>
> ```yaml
> - name: Install Asciidoctor
> run: sudo apt-get install -y asciidoctor
> ```
>
> For more information, see the [Vale documentation][2].
> See the [Vale documentation][2] for more information.

## Repository Structure

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

Check warning on line 44 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L44 

[write-good.TooWordy] 'all of' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'all of' is too wordy.", "location": {"path": "README.md", "range": {"start": {"line": 44, "column": 19}}}, "severity": "WARNING"}

```text
.github
Expand All @@ -50,7 +53,8 @@ The recommended repository structure makes use of the existing `.github` directo
...
```

Where `styles` represents your [`StylesPath`](https://docs.errata.ai/vale/styles). The top-level `.vale.ini` file should reference this directory:
Where `styles` represents your [`StylesPath`][3]. The top-level `.vale.ini`
file should reference this directory:

```ini
StylesPath = .github/styles
Expand All @@ -62,9 +66,11 @@ BasedOnStyles = Vale

## Inputs

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

To add an input, edit your workflow file and add the `with` key to the `uses` block. For example:
To add an input, edit your workflow file and add the `with` key to the `uses`
block. For example:

```yaml
- uses: errata-ai/[email protected]
Expand Down Expand Up @@ -94,13 +100,17 @@ with:

You can supply this value one of four ways:

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

Check warning on line 103 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L103 

[write-good.TooWordy] 'equivalent' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'equivalent' is too wordy.", "location": {"path": "README.md", "range": {"start": {"line": 103, "column": 54}}}, "severity": "WARNING"}
`vale .`.

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

Check warning on line 106 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L106 

[write-good.TooWordy] 'equivalent' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'equivalent' is too wordy.", "location": {"path": "README.md", "range": {"start": {"line": 106, "column": 54}}}, "severity": "WARNING"}
`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 JSON-formatted list of file or directory
arguments; equivalent to calling `vale input1 input2`.

Check warning on line 110 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L110 

[write-good.TooWordy] 'equivalent' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'equivalent' is too wordy.", "location": {"path": "README.md", "range": {"start": {"line": 110, "column": 12}}}, "severity": "WARNING"}

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

Check warning on line 113 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L113 

[write-good.Passive] 'is determined' may be passive voice. Use active voice if you can.
Raw output 
{"message": "[write-good.Passive] 'is determined' may be passive voice. Use active voice if you can.", "location": {"path": "README.md", "range": {"start": {"line": 113, "column": 1}}}, "severity": "WARNING"}

```yaml
with:
Expand All @@ -119,7 +129,8 @@ with:

### `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
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

Check warning on line 133 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L133 

[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
Raw output 
{"message": "[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.", "location": {"path": "README.md", "range": {"start": {"line": 133, "column": 17}}}, "severity": "WARNING"}
was reported.

Check warning on line 134 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L134 

[write-good.Passive] 'was reported' may be passive voice. Use active voice if you can.
Raw output 
{"message": "[write-good.Passive] 'was reported' may be passive voice. Use active voice if you can.", "location": {"path": "README.md", "range": {"start": {"line": 134, "column": 1}}}, "severity": "WARNING"}

```yaml
Expand All @@ -140,7 +151,8 @@ with:

### `vale_flags` (default: "")

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

Note that flags should not include quotes.
So while `--glob='*.txt'` works with Vale, it does not work with this action.

Check warning on line 158 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L158 

[write-good.So] Don't start a sentence with 'So '.
Raw output 
{"message": "[write-good.So] Don't start a sentence with 'So '.", "location": {"path": "README.md", "range": {"start": {"line": 158, "column": 1}}}, "severity": "WARNING"}
Expand All @@ -151,7 +163,7 @@ with:
vale_flags: "--glob=*.txt"
```

### `token` (default: [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication))
### `token` (default: [`secrets.GITHUB_TOKEN`][4])

The GitHub token to use.

Expand All @@ -162,3 +174,5 @@ with:

[1]: https://help.github.com/en/github/automating-your-workflow-with-github-actions/configuring-a-workflow
[2]: https://vale.sh/docs/topics/scoping/#formats
[3]: https://vale.sh/docs/topics/styles/
[4]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication

0 comments on commit 18ca075

Please sign in to comment.