https://github.com/emilio2hd/pronto-annotations_formatter

Pronto gem to print the warnings in json formmated to be consumed by https://github.com/emilio2hd/pronto-annotate-action
https://github.com/emilio2hd/pronto-annotations_formatter

annotations formatter github pronto ruby

Last synced: about 1 month ago
JSON representation

Pronto gem to print the warnings in json formmated to be consumed by https://github.com/emilio2hd/pronto-annotate-action

• Host: GitHub
• URL: https://github.com/emilio2hd/pronto-annotations_formatter
• Owner: emilio2hd
• License: mit
• Created: 2023-10-17T04:07:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-27T11:52:34.000Z (6 months ago)
• Last Synced: 2024-09-29T21:01:41.868Z (about 2 months ago)
• Topics: annotations, formatter, github, pronto, ruby
• Language: Ruby
• Homepage:
• Size: 27.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Pronto::AnnotationsFormatter

Welcome!

[prontolabs/pronto](https://github.com/prontolabs/pronto) is a great tool for code review, but it post the warnings as comments,

which can be a bit of a mess and create many comments on the PR causing a huge noise for developers discussion.

In a combination with [pronto-annotate-action](https://github.com/emilio2hd/pronto-annotate-action), it's possible to write annotations to the code, like this:

![Annotation Warning on Code](https://raw.githubusercontent.com/emilio2hd/pronto-annotate-action/main/docs/annotation-warning-on-code.png)

Leaving the comments just for the developers.

Check the [.github/workflows/pr_linter.yml](.github/workflows/pr_linter.yml) and [this pull-request](https://github.com/emilio2hd/pronto-annotations_formatter/pull/1/files).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'pronto-annotations_formatter'

```

And then execute:

```shell

  bundle install

```

Or install it yourself as:

```shell

  gem install pronto-annotations_formatter

```

> [!NOTE]

>

> If you are using pronto `<= v0.11.1`, please use

> [v0.1](https://github.com/emilio2hd/pronto-annotations_formatter/releases/tag/v0.1.0)

## Usage

```shell

bundle exec pronto run -f annotations -c origin/main

```

The command above, will print some json like this:

```json

[

  {

    "message": "Migration file detected, but no changes in schema.rb",

    "level": "warning",

    "file": "db/migrate/20231013225210_create_products.rb",

    "line": {

      "start": 1,

      "end": 1

    },

    "title": "Pronto::RailsSchema"

  }

]

```

## Development

Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at .

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).