https://github.com/jiro4989/nimlint-action
NIm lint GitHub Actions.
https://github.com/jiro4989/nimlint-action
bash ci dockerfile github-actions nim
Last synced: about 1 month ago
JSON representation
NIm lint GitHub Actions.
- Host: GitHub
- URL: https://github.com/jiro4989/nimlint-action
- Owner: jiro4989
- License: mit
- Created: 2020-01-13T07:56:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-21T16:03:16.000Z (over 3 years ago)
- Last Synced: 2025-03-22T11:48:54.098Z (about 2 months ago)
- Topics: bash, ci, dockerfile, github-actions, nim
- Language: Shell
- Homepage:
- Size: 68.4 KB
- Stars: 10
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nimlint-action
**INFO:** This repository moved to [reviewdog/action-nimlint](https://github.com/reviewdog/action-nimlint).
I will continue to maintenance that, and i will not maintenance this repository.
Please you use that too.
---
This action lints Nim codes.
nimlint-action is inspired by [reviewdog/action-eslint](https://github.com/reviewdog/action-eslint).
This action runs `nim check` with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve
code review experience.
[](https://github.com/jiro4989/nimlint-action/pull/5)
## Inputs
### `github_token`
**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`'.
### `level`
Optional. Report level for reviewdog [info,warning,error].
It's same as `-level` flag of reviewdog.
### `reporter`
Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].
Default is github-pr-check.
It's same as `-reporter` flag of reviewdog.
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
### `src`
Optional. Nim source code path glob. Default: 'src/*.nim'
### `ignore_regexp`
Optional. Ignore message pattern. Default: ''
## Example usage
You also need to install [nim](https://github.com/nim-lang/Nim).
### [.github/workflows/nimlint-action.yml](.github/workflows/nimlint-action.yml)
```yml
name: nimlint
on: [pull_request]
jobs:
nimlint:
name: runner / nimlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: nimlint-github-pr-review
uses: jiro4989/[email protected]
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter.
src: 'src/*.nim'
```
## License
MIT