Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juancarlospaco/nimpretty-action
Nimpretty GitHub Action
https://github.com/juancarlospaco/nimpretty-action
actions github-actions nim nim-lang
Last synced: 3 months ago
JSON representation
Nimpretty GitHub Action
- Host: GitHub
- URL: https://github.com/juancarlospaco/nimpretty-action
- Owner: juancarlospaco
- License: mit
- Created: 2020-11-04T18:21:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T22:45:37.000Z (about 1 year ago)
- Last Synced: 2023-10-24T23:28:31.094Z (about 1 year ago)
- Topics: actions, github-actions, nim, nim-lang
- Language: JavaScript
- Homepage:
- Size: 67.4 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nimpretty-Action
- [GitHub Action](https://github.com/features/actions) to auto-prettify all your Nim source code files using [nimpretty](https://nim-lang.github.io/Nim/tools.html).
# 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
```yaml
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:
```yml
- uses: juancarlospaco/nimpretty-action@main
with:
indent: 2
folders: "src,docs,examples"
maxLineLen: 420
```
```yml
- 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`.