https://github.com/jetruby/graphql-rails_logger

Display GraphQL queries in a more readable format
https://github.com/jetruby/graphql-rails_logger

gem graphql logger ruby ruby-on-rails

Last synced: 11 days ago
JSON representation

Display GraphQL queries in a more readable format

• Host: GitHub
• URL: https://github.com/jetruby/graphql-rails_logger
• Owner: jetruby
• License: mit
• Created: 2017-12-20T17:39:35.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-13T12:20:09.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T00:20:53.325Z (28 days ago)
• Topics: gem, graphql, logger, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 26.4 KB
• Stars: 116
• Watchers: 4
• Forks: 21
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# GraphQL::RailsLogger

## About

This gem allows you to inspect graphql queries in a more readable format.

This...

![screenshot_before](misc/screenshot_before.png)

becomes this ...

![screenshot_after](misc/screenshot_after.png)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'graphql-rails_logger'

```

And then execute:

    $ bundle

## Configuration

By default this gem formats params only for `GraphqlController#execute`.

If you want to change this behaviour, add `config/initializers/graphql_rails_logger.rb` file and set proper controller and actions like this:

```ruby

GraphQL::RailsLogger.configure do |config|

  config.white_list = {

    'QueriesController' => %w(create)

  }

end

```

There is an option to suppress (hide) the GraphQL Introspection Query from the console output. This may be helpful to declutter the console during client testing as these can be rather lengthy.

```ruby

GraphQL::RailsLogger.configure do |config|

  config.skip_introspection_query = true

end

```

The theme can be configured as well.  The theme is applied using the [rouge](https://github.com/jneen/rouge) gem, where all available options can be found.  The default value is `Rouge::Themes::ThankfulEyes.new`.

```ruby

GraphQL::RailsLogger.configure do |config|

  config.theme = Rouge::Themes::Pastie.new

end

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jetruby/graphql-rails_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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

## Code of Conduct

Everyone interacting in the GraphQL::RailsLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jetruby/graphql-rails_logger/blob/master/CODE_OF_CONDUCT.md).

## About JetRuby

GraphQL::RailsLogger is maintained and founded by JetRuby Agency.

We love open source software!

See [our projects][portfolio] or

[contact us][contact] to design, develop, and grow your product.

[portfolio]: http://jetruby.com/portfolio/

[contact]: http://jetruby.com/#contactUs