juancarlospaco / nimpretty-action

Nimpretty GitHub Action

Nimpretty-Action

• GitHub Action to auto-prettify all your Nim source code files using nimpretty.

Examples

• https://github.com/juancarlospaco/nimpretty-action/blob/main/.github/workflows/main.yml
• https://github.com/juancarlospaco/nimpretty-action/runs/1355541879?check_suite_focus=true#step:4:8

Use

on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: jiro4989/setup-nim-action@v1
      - uses: juancarlospaco/nimpretty-action@main

Options

• indent Optional, positive integer, defaults to 2, recommended value 2.
• folders Optional, comma separated list of folders, defaults to ".".
• maxLineLen Optional, positive integer, recommended value >= 80.

Examples:

- uses: juancarlospaco/nimpretty-action@main
  with:
    indent: 2
    folders: "src,docs,examples"
    maxLineLen: 420

- uses: juancarlospaco/nimpretty-action@main
  with:
    indent: 2
    folders: "src"
    maxLineLen: 100

Requisites

• jiro4989/setup-nim-action to setup Nim with nimpretty.
• EndBug/add-and-commit to commit all nimpretty fixes back to the Git repo.

FAQ

• Why not take care of setting up Nim by itself?.

Because some people already do it with just Git or Gitnim or Choosenim or setup-nim-action.

• Why not take care of commiting the files by itself?.

Because some people already do it with EndBug/add-and-commit or stefanzweifel/git-auto-commit-action or github-actions/auto-commit.