Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valentinvignal/action-dart-analyze
This action analyzes dart code
https://github.com/valentinvignal/action-dart-analyze
Last synced: about 10 hours ago
JSON representation
This action analyzes dart code
- Host: GitHub
- URL: https://github.com/valentinvignal/action-dart-analyze
- Owner: ValentinVignal
- License: mit
- Created: 2021-03-28T09:16:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T03:16:58.000Z (7 months ago)
- Last Synced: 2024-10-14T13:05:01.835Z (about 1 month ago)
- Language: TypeScript
- Size: 2.17 MB
- Stars: 15
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/ValentinVignal/action-dart-analyze)
[](https://wakatime.com/badge/github/ValentinVignal/action-dart-analyze)
# action-dart-analyze
This action analyzes the modified lines dart code of the PR by running `dart analyze` and `dart format`.
## How to use it
Create a `.yml` file in `./github/workflows/` in your project.
## Inputs
- `fail-on`: Specifies when the action should fail.
- Options:
- `'error'`: Fails only on analyze error.
- `'warning'`: Fails on warnings and errors.
- `'info'`: Fails on info, warnings and errors from `dart analyze`.
- `'format'`: Fails on everything, including bad formatting.
- `'nothing'`: Fails on nothing.
- Optional.
- Default: `'error'`.
- `working-directory`: The working directory.
- Optional.
- Default: `'./'`.
- `token`: Github token
- Optional.
- Default: Secret token provided by Github
- `check-renamed-files`: If set to `'true'`, it will checks an entire renamed file even if there is no change in it.
- Options: `'false'`, `'true'`.
- Optional.
- Default: `'false'`.
- `emojis`: `'false'` will remove the emojis from the comment.
- Options: `'true'`, `'false'`.
- Optional.
- Default: `'true'`.
- `format`: `'false'` will remove the check on the format.
- Options: `'true'`, `'false'`.
- Optional.
- Default: `'true'`.
- `line-length`: The line length for dart format command.
- Optional.
- Default: The default value used in `dart format`
## Outputs
No output.
## Result
It will fail the checks on your Pull Requests if any issue is found:
It will leave a comment explaining why it failed and what issues it found:
In the code change, it will display errors and warnings where the issues are found:
## Example usage
```yml
on: [pull_request]
jobs:
linter:
runs-on: ubuntu-latest
name: Lint flutter code
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Flutter
uses: subosito/flutter-action@v2
- run: flutter pub get
- name: Analyze Flutter
uses: ValentinVignal/[email protected]
with:
fail-on: "warning"
```
## Using the `GITHUB_TOKEN` in a workflow
In order to write comments, your `GITHUB_TOKEN` might need the `pull_request: write` permission.