GitHub Action to validate Elm code is formatted correctly
Go to file
2024-06-28 19:49:17 +01:00
__tests__ Upgrade jest and typescript 2022-12-11 18:48:39 +00:00
.github/workflows Use new GITHUB_PATH file 2021-01-08 10:59:00 +00:00
dist Upgrade remaining packages 2022-12-11 18:58:46 +00:00
src Upgrade jest and typescript 2022-12-11 18:48:39 +00:00
.eslintignore Initial commit 2020-04-20 18:11:39 +01:00
.eslintrc.json Upgrade eslint 2022-12-11 17:58:12 +00:00
.gitignore Ignore .idea 2021-01-08 11:03:18 +00: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 missing 'working-directory' to action.yml 2021-01-08 11:21:40 +00:00
elm-tooling.json Switch elm-format to elm-tooling 2022-12-11 17:34:07 +00: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 ncc 2022-12-11 18:54:51 +00:00
README.md Use new GITHUB_PATH file 2021-01-08 10:59:00 +00:00
tsconfig.eslint.json Upgrade jest and typescript 2022-12-11 18:48:39 +00:00
tsconfig.json Initial commit 2020-04-20 18:11:39 +01:00
yarn.lock Bump braces from 3.0.2 to 3.0.3 2024-06-16 11:25:29 +00: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: yarn bin >> $GITHUB_PATH
    - uses: sparksp/elm-format-action@v1
      with: 
        # elm_format: elm-format
        # elm_files: src/
        # elm_glob: false
        # working-directory: ./

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