11 Commits (bc31dbc179b04b277ca268dedd5f30fa83af90da)

Author	SHA1	Message	Date
Martin Atkins	05caff2ca3	Move tfdiags/ to internal/tfdiags/ ... This is part of a general effort to move all of Terraform's non-library package surface under internal in order to reinforce that these are for internal use within Terraform only. If you were previously importing packages under this prefix into an external codebase, you could pin to an earlier release tag as an interim solution until you've make a plan to achieve the same functionality some other way.	5 years ago
Alisdair McDiarmid	25f99857cf	cli: Fix crash with invalid JSON diagnostics ... If a JSON diagnostic value has a highlight end offset which is before the highlight start offset, this would previously panic. This commit adds a normalization step to prevent the crash.	5 years ago
Katy Moe	51c687c2db	command: no visual warning hierarchy in -no-color ... Commit e865faf adds visual indentation for diagnostic messages using various vertical line characters. The present commit disables this behaviour when running with colourised output disabled. While the contents of stderr are not intended to be part of the Terraform API, this is currently how the hashicorp/terraform-exec library detects certain error types in order to present them as well-known Go errors to the user. Such detection is complicated when vertical lines are added to the CLI output at unpredictable points. I expect this change will also be helpful for screen reader users.	5 years ago
Martin Atkins	e865faf318	command: Better visual hierarchy for diagnostics ... I frequently see people attempting to ask questions about Terraform's error and warning messages but either only copying part of the message or accidentally copying a surrounding paragraph that isn't part of the message. While I'm sure some of these are just "careless" mistakes, I've also noticed that this has sometimes overlapped with someone asking a question whose answer is written directly in the part of the message they didn't include when copying, and so I have a theory that our current output doesn't create a good enough visual hierarchy for sighted users to understand where the diagnostic messages start and end when we show them in close proximity to other content, or to other diagnostic messages. As a result, some folks fail to notice the relevant message that might've answered their question. I tried a few different experiments for different approaches here, such as adding more horizontal rules to the output and coloring the detail text differently, but the approach that felt like the nicest compromise to me was what's implemented here, which is to add a vertical line along the left edge of each diagnostic message, colored to match with the typical color we use for each diagnostic severity. This means that the diagnostics end up slightly indented from what's around them, and the vertical line seems to help subtly signal how we intended the content to be grouped together.	5 years ago
Martin Atkins	1f1af87dea	command/format: Don't try to fill the last terminal column ... In some terminal emulators, writing a character into the last column on a row causes the terminal to immediately wrap to the beginning of the next line, even if the very next character in the stream is a hard newline. That can then lead to errant blank lines in the final output which make it harder to navigate the visual hierarchy. As a compromise to avoid this, we'll format our horizontal rules and paragraphs to one column less than the terminal width. That does mean that our horizontal rules won't _quite_ cover the whole terminal width, but it seems like a good compromise in order to get consistent behavior across a wider variety of terminal implementations.	5 years ago
Martin Atkins	0c84a56700	command/format: Use box drawing chars for rules in diagnostics ... We were previously using some ASCII art to create some visual divisions between parts of the diagnostic output. Now that we are requiring a UTF-8 terminal we can print out box drawing characters instead.	5 years ago
Martin Atkins	d24fdce5b8	command/format: Include unknown values in diagnostics ... Previously when printing the relevant variables involved in a failed expression evaluation we would just skip over unknown values entirely. There are some errors, though, which are _caused by_ a value being unknown, in which case it's helpful to show which of the inputs to that expression were known vs. unknown so that the user can limit their further investigation only to the unknown ones. While here I also added a special case for sensitive values that overrides all other display, because we don't know what about a value is sensitive and so better to give nothing away at the expense of a slightly less helpful error message.	6 years ago
Alisdair McDiarmid	3547f9e368	format: Don't wrap space-prefixed diag details ... Diagnostic detail lines sometimes contain lines which include commands suggested for the user to execute. By convention, these start with leading whitespace to indicate that they are not prose. This commit changes the diagnostic formatter to wrap each line of the detail separately, and skips word wrapping for lines prefixed with space. This prevents ugly and confusing wrapping of long command lines.	6 years ago
Alisdair McDiarmid	c87c0a9d2a	command/format: Fix empty overlap diagnostics ... Diagnostics where the highlight range has an empty overlap with a line would skip lines of the output. This is because if two ranges abut each other, they can be considered to overlap, but that overlap is empty. This results in an edge case in the diagnostic printer which causes the line not to be printed.	6 years ago
Alisdair McDiarmid	a23c3e3c81	command/format: Fix multi-line diagnostic output ... Previously, if a diagnostic context spanned multiple lines, any lines which did not overlap with the highlight range would be displayed as blank. This commit fixes the bug. The problem was caused by the unconditional use of `PartitionAround` to split the line into before/highlighted/after ranges. When two ranges don't overlap, this method returns empty ranges, which results in a blank line. Instead, we first check if the ranges do overlap, and if not we print the entire line from the context.	6 years ago
Martin Atkins	c06675c616	command: New -compact-warnings option ... When warnings appear in isolation (not accompanied by an error) it's reasonable to want to defer resolving them for a while because they are not actually blocking immediate work. However, our warning messages tend to be long by default in order to include all of the necessary context to understand the implications of the warning, and that can make them overwhelming when combined with other output. As a compromise, this adds a new CLI option -compact-warnings which is supported for all the main operation commands and which uses a more compact format to print out warnings as long as they aren't also accompanied by errors. The default remains unchanged except that the threshold for consolidating warning messages is reduced to one so that we'll now only show one of each distinct warning summary. Full warning messages are always shown if there's at least one error included in the diagnostic set too, because in that case the warning message could contain additional context to help understand the error.	6 years ago