GitHub Action to validate Elm code is formatted correctly
Go to file
2020-07-23 10:31:19 +01:00
__tests__ Add support for file glob 2020-04-22 15:43:29 +01:00
.github/workflows Add support for file glob 2020-04-22 15:43:29 +01:00
dist Add support for file glob 2020-04-22 15:43:29 +01:00
src Add support for file glob 2020-04-22 15:43:29 +01:00
.eslintignore Initial commit 2020-04-20 18:11:39 +01:00
.eslintrc.json Run elm-format and turn results into warnings 2020-04-22 09:25:37 +01:00
.gitignore Initial commit 2020-04-20 18:11:39 +01:00
.prettierignore Initial commit 2020-04-20 18:11:39 +01:00
.prettierrc.json Initial commit 2020-04-20 18:11:39 +01:00
action.yml Add support for file glob 2020-04-22 15:43:29 +01:00
jest.config.js Initial commit 2020-04-20 18:11:39 +01:00
LICENSE Update package and author details 2020-05-30 10:07:23 +01:00
package.json Update package and author details 2020-05-30 10:07:23 +01:00
README.md Improve README for marketplace 2020-04-22 16:21:33 +01:00
tsconfig.eslint.json Run elm-format and turn results into warnings 2020-04-22 09:25:37 +01:00
tsconfig.json Initial commit 2020-04-20 18:11:39 +01:00
yarn.lock Upgrade more dependencies 2020-07-23 10:31:19 +01:00

elm-format-action status

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.

Finding elm-format

You must have elm-format available in your build, here is an example where elm-format is in package.json.

jobs:
  lint:
    steps:
    - uses: actions/checkout@v2
    - run: yarn
    - name: Add elm-format to path
      run: echo ::add-path::$(yarn bin)
    - uses: sparksp/elm-format-action@v1
      with: 
        # elm_format: elm-format
        # elm_files: src/
        # elm_glob: false

Multiple Files

To match multiple files or directories, list each on a new line...

    - uses: sparksp/elm-format-action@v1
      with: 
        elm_files: |
          src/Main.elm
          src/Wait.elm
          tests/          

File Glob

This action supports file globs using @actions/glob. elm-format will process each file or directory it is given, so take care to match only elm files OR directories with your globs.

    - uses: sparksp/elm-format-action@v1
      with: 
        # Match all elm files except any TW.elm
        elm_files: |
          src/**/*.elm
          !**/TW.elm          
        elm_glob: true