sparksp/elm-format-action
1
1
Fork 0
mirror of https://github.com/sparksp/elm-format-action.git synced 2024-11-24 05:30:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve README for marketplace

Browse Source 
Make it clear that we're using `elm-format --validate` (not automatically accepting the formatting)
This commit is contained in:
Phill Sparks 2020-04-22 16:21:33 +01:00 committed by GitHub
parent 30b23ed00c
commit 3355e62957
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,6 +1,13 @@
[![elm-format-action status](https://github.com/sparksp/elm-format-action/workflows/build-test/badge.svg)](https://github.com/sparksp/elm-format-action/actions)
# Elm Format Action for GitHub Workflows
# elm-format --validate
Validate your [Elm] files using [elm-format] - any unformatted files will cause the check to fail and a note will be added to each failing file.
[Elm]: https://elm-lang.org/
[elm-format]: https://github.com/avh4/elm-format
## Finding elm-format
You must have `elm-format` available in your build, here is an example where elm-format is in `package.json`.
@ -46,4 +53,4 @@ This action supports file globs using [@actions/glob]. elm-format will process
elm_glob: true
```
[@actions/glob]: https://github.com/actions/toolkit/tree/master/packages/glob#patterns
[@actions/glob]: https://github.com/actions/toolkit/tree/master/packages/glob#patterns