https://github.com/blendthink/elixir

Tool for commenting `dart analyze` results to GitHub PullRequest.
https://github.com/blendthink/elixir

Last synced: 20 days ago
JSON representation

Tool for commenting `dart analyze` results to GitHub PullRequest.

• Host: GitHub
• URL: https://github.com/blendthink/elixir
• Owner: blendthink
• License: bsd-3-clause
• Created: 2022-06-22T15:24:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T18:58:52.000Z (9 months ago)
• Last Synced: 2024-08-09T01:11:08.024Z (5 months ago)
• Language: Dart
• Homepage: https://pub.dev/packages/elixir
• Size: 383 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Pub Version](https://badgen.net/pub/v/elixir)](https://pub.dev/packages/elixir/)

[![Dart SDK Version](https://badgen.net/pub/sdk-version/elixir)](https://pub.dev/packages/elixir/)

[![Pub popularity](https://badgen.net/pub/popularity/elixir)](https://pub.dev/packages/elixir/score)

# Elixir

A command-line tool for commenting `dart analyze --format=machine $dir` results to GitHub PullRequest.

![Demo](docs/assets/demo.png)

## Required

- Dart SDK version >=2.15.0 <3.0.0

## Usage

### GitHub Action

```yaml

name: "analyze"

on:

  pull_request:

jobs:

  dart:

    runs-on: ubuntu-latest

    steps:

      # https://github.com/actions/checkout

      - uses: actions/checkout@v3

      # https://github.com/dart-lang/setup-dart

      - uses: dart-lang/setup-dart@v1

      # https://github.com/blendthink/elixir

      - uses: blendthink/elixir@v2

        with:

          # (Optional) GITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT).

          # Default: ${{ github.token }}

          token: ''

          # (Optional) Directory to run the `dart analyze`.

          # Default: ./

          dir: ''

```

### CLI

This package uses Git internally.

If you are using GitHub Actions, you can skip steps 1.

#### 1. Install Git

https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

#### 2. Active package

```shell

dart pub global activate elixir

```

#### 3. Run package

```shell

cd {git-repository-path}

elixir run \

  --repo={repo} \

  --num={num} \

  --base={base} \

  --head={head} \

  --dir={dir}

```

## How to contribute

You should follow our [Code of Conduct].

See [Contributor Guide] for contributing conventions.

### Contributors

    

        

            

            


            blendthink

        

    

[Code of Conduct]: docs/CODE_OF_CONDUCT.md

[Contributor Guide]: docs/contributing/CONTRIBUTING.md