Skip to content

Provide guidance links in mix tasks' Logger.error output #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vanderhoop wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Provide guidance links in mix tasks' Logger.error output #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion lib/message_generator.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@ defmodule ExcellentMigrations.MessageGenerator do
@moduledoc false

def build_message(%{type: type, path: path, line: line}) do
"#{build_message(type)} in #{path}:#{line}"
"""
#{build_message(type)} in #{path}:#{line}

For more info:
* https://github.com/Artur-Sulej/excellent_migrations#checks
* https://github.com/Artur-Sulej/excellent_migrations#assuring-safety
Comment on lines +9 to +10
Copy link
Author

@vanderhoop vanderhoop Mar 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link fragments here are inherently brittle, but if the README headings change without the appropriate fragment updates here, the user will still end-up on the README document, which is still a net UX win.

"""
end

def build_message(type) do
Expand Down