https://github.com/jradtilbrook/spell-check-buildkite-plugin

https://github.com/jradtilbrook/spell-check-buildkite-plugin

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jradtilbrook/spell-check-buildkite-plugin
• Owner: jradtilbrook
• Created: 2021-07-18T23:58:48.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-02T07:35:06.000Z (over 3 years ago)
• Last Synced: 2024-05-02T05:49:51.642Z (8 months ago)
• Language: Shell
• Size: 24.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Spell Check Buildkite Plugin

This is a plugin to check spelling of input files.

You can provide a glob pattern to check against.

## Example

Add the following to you `pipeline.yml`:

```yml

steps:

  - command: ls

    plugins:

      - jradtilbrook/spell-check#v1.0.0:

          pattern: ‘*.md’

```

## Configuration

### `pattern` (Required, string)

The pattern of files to check for spelling, for example `*.txt`. Supports any pattern supported by [find -name](http://man7.org/linux/man-pages/man1/find.1.html).

## Developing

To run the tests:

```shell

docker-compose run --rm tests

```

## Attribution

Thanks to [starefossen/aspell](starefossen/aspell) for use of the docker image to perform spell checking.