Skip to content

Commit

Permalink
Merge pull request #24 from deemp/master
Browse files Browse the repository at this point in the history
refactor: extend docs
  • Loading branch information
cdepillabout authored Jan 14, 2024
2 parents 6cccc69 + b451d12 commit 1aa06a7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,11 @@ Here's a more complicated example that shows more options being used:
# release of fourmolu will be used.
version: "0.13.0.0"
# Only check the format of .hs in the src/ directory.
# Only check the format of .hs in the src/ directory
# except src/Main.hs.
pattern: |
src/**/*.hs
!src/Main.hs
# Don't follow symbolic links to .hs files.
follow-symbolic-links: false
Expand All @@ -86,6 +88,8 @@ Here's a more complicated example that shows more options being used:
extra-args: "--indent-wheres true"
```

See [docs](https://github.com/actions/toolkit/tree/main/packages/glob#patterns) on pattern syntax.

### Example usage with build matrix

If you are using a build matrix, then it is more efficient to have a
Expand Down
16 changes: 13 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,19 @@ description: 'Check formatting of Haskell code with Fourmolu'
inputs:
pattern:
required: false
description: >
Glob pattern that are used to find source files to format. It is
possible to specify several patterns by putting each on a new line.
description: |
Glob pattern that is used to find source files to format.
See [docs](https://github.com/actions/toolkit/tree/main/packages/glob#patterns) on pattern syntax.
It is possible to specify several patterns by putting each one on a new line.
```yaml
src/**/*.hs
!src/Main.hs
```
`src/Main.hs` will be skipped.
default: |
**/*.hs
**/*.hs-boot
Expand Down

0 comments on commit 1aa06a7

Please sign in to comment.