Nothing Special   »   [go: up one dir, main page]

Skip to content

juancarlospaco/nimpretty-action

Repository files navigation

Nimpretty-Action

Examples

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.