Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juancarlospaco/nimlint-action
Nimlint GitHub Action
https://github.com/juancarlospaco/nimlint-action
actions github-actions linter nim nim-lang
Last synced: about 1 month ago
JSON representation
Nimlint GitHub Action
- Host: GitHub
- URL: https://github.com/juancarlospaco/nimlint-action
- Owner: juancarlospaco
- License: mit
- Created: 2020-12-09T23:16:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-10T00:18:06.000Z (almost 4 years ago)
- Last Synced: 2024-09-17T07:07:44.577Z (2 months ago)
- Topics: actions, github-actions, linter, nim, nim-lang
- Language: JavaScript
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nimlint-Action
- [GitHub Action](https://github.com/features/actions) to auto-lint all your Nim source code files using [nimlint](https://github.com/nim-compiler-dev/nimlint).
# Examples
- https://github.com/juancarlospaco/nimlint-action/runs/1527448356?check_suite_focus=true#step:4:9
- https://github.com/juancarlospaco/nimlint-action/runs/1527464129?check_suite_focus=true#step:4:9
# Use
```yaml
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: jiro4989/setup-nim-action@v1
with:
nim-version: 'devel'
- uses: juancarlospaco/nimlint-action@main
```
# Options
- `folders` Comma separated list of folders, optional, defaults to `"."`.
- `verbose` Verbose, optional, boolean, defaults to `false`.
Examples:
```yml
- uses: juancarlospaco/nimlint-action@main
with:
folders: "src,examples,tutorial,lib"
```
```yml
- uses: juancarlospaco/nimlint-action@main
with:
folders: "src"
```
# Requisites
- `jiro4989/setup-nim-action` to setup Nim.
- `EndBug/add-and-commit` to commit all nimlint 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`.