Skip to content
GitLab

More readable warnings

Merged Pablo Brasero requested to merge github/fork/pablobm/better-generator-warnings into master

During normal operation, the routes generator can print a few warnings. When there's more than one reason to trigger a warning for a given resource, these are printed out separately, often with other warnings intereleaved.

For example, these are 8 warning about 4 different resources:

WARNING: Unable to generate a dashboard for ActionText::RichText.
         Administrate does not yet support namespaced models.
WARNING: Unable to generate a dashboard for ActionMailbox::InboundEmail.
         Administrate does not yet support namespaced models.
WARNING: Unable to generate a dashboard for ActiveStorage::Blob.
         Administrate does not yet support namespaced models.
WARNING: Unable to generate a dashboard for ActiveStorage::Attachment.
         Administrate does not yet support namespaced models.
WARNING: Unable to generate a dashboard for ActionText::RichText.
         It is not connected to a database table.
         Make sure your database migrations are up to date.
WARNING: Unable to generate a dashboard for ActionMailbox::InboundEmail.
         It is not connected to a database table.
         Make sure your database migrations are up to date.
WARNING: Unable to generate a dashboard for ActiveStorage::Blob.
         It is not connected to a database table.
         Make sure your database migrations are up to date.
WARNING: Unable to generate a dashboard for ActiveStorage::Attachment.
         It is not connected to a database table.
         Make sure your database migrations are up to date.

This is a bit difficult to read and can be confusing. Instead, I propose that we group together the warnings related to each given resource, like so:

WARNING: Unable to generate a dashboard for ActionText::RichText.
       - Administrate does not yet support namespaced models.
       - It is not connected to a database table.
         Make sure your database migrations are up to date.
WARNING: Unable to generate a dashboard for ActionMailbox::InboundEmail.
       - Administrate does not yet support namespaced models.
       - It is not connected to a database table.
         Make sure your database migrations are up to date.
WARNING: Unable to generate a dashboard for ActiveStorage::Blob.
       - Administrate does not yet support namespaced models.
       - It is not connected to a database table.
         Make sure your database migrations are up to date.
WARNING: Unable to generate a dashboard for ActiveStorage::Attachment.
       - Administrate does not yet support namespaced models.
       - It is not connected to a database table.
         Make sure your database migrations are up to date.

This PR implements this behaviour.