Decode headers as latin1/UTF-8, show real reason phrase #377
Conversation
External changes: - We now print the actual reason phrase sent by the server instead of guessing it from the status code. That is, if servers reply with "200 Wonderful" instead of "200 OK" then we show that. This is especially useful for status codes that xh doesn't recognize. - Header values are now decoded as latin1, with the UTF-8 decoding also shown if applicable. - A new FAQ file with an entry that explains header value encoding. Header output now hyperlinks to this entry when relevant and if supported by the terminal. Under the hood we now color headers manually. It's still hooked up to the `.tmTheme` files but not to the `.sublime-syntax` file. This lets us highlight the latin1 header values differently. In the future we could use the same approach to optimize JSON highlighting. I'm unsure about the position of the hyperlink. Currently it's the text "UTF-8" in `<latin1 value> (UTF-8: <utf-8 value>)`. But that means it's only shown if the value can be decoded as UTF-8. An alternative is to turn the latin1 value itself into a hyperlink, but that's confusing if the value itself is already a URL (which is a common case for the `Location` header). I also don't feel that our text is quite distinct enough from the header value in the default `ansi` theme. Though the hyperlink does help to set it apart.
|
(Sorry for the big diff for such a small feature! I'm hoping it'll be useful for other things in the future.) |
|
Apologies for taking so long to review this 😬. I’ll make sure to leave a review by this weekend. |
There was a problem hiding this comment.
Looks good! Loving the new FAQ.md file
I'm unsure about the position of the hyperlink. Currently it's the text "UTF-8" in (UTF-8: ). But that means it's only shown if the value can be decoded as UTF-8.
I think linking the FAQ file is only necessary when xh prints extra information that wasn't part of the request/response, e.g (UTF-8: <utf-8 value>)
| <key>settings</key> | ||
| <dict> | ||
| <key>foreground</key> | ||
| <string>#01000000</string> |
There was a problem hiding this comment.
I'm not sure what color would work best. But since this is rarely shown, defaulting to Ansi-red sound good 👍
src/formatting.rs
Outdated
There was a problem hiding this comment.
Could we rename this file to formatting/mod.rs?
External changes:
We now print the actual reason phrase sent by the server instead of guessing it from the status code. That is, if servers reply with "200 Wonderful" instead of "200 OK" then we show that. This is especially useful for status codes that xh doesn't recognize.
Header values are now decoded as latin1, with the UTF-8 decoding also shown if applicable. (Resolves IRI output #323.)
A new FAQ file with an entry that explains header value encoding. Header output now hyperlinks to this entry when relevant and if supported by the terminal.
Under the hood we now color headers manually. It's still hooked up to the
.tmThemefiles but not to the.sublime-syntaxfile. This lets us highlight the latin1 header values differently. In the future we could use the same approach to optimize JSON highlighting.I'm unsure about the position of the hyperlink. Currently it's the text "UTF-8" in
<latin1 value> (UTF-8: <utf-8 value>). But that means it's only shown if the value can be decoded as UTF-8. An alternative is to turn the latin1 value itself into a hyperlink, but that's confusing if the value itself is already a URL (which is a common case for theLocationheader).I also don't feel that our text is quite distinct enough from the header value in the default
ansitheme. Though the hyperlink does help to set it apart.We should use a stable URL that keeps working in the future. I linked to
FAQ.mdon this repo's master branch (https://github.com/ducaale/xh/blob/master/FAQ.md#header-value-encoding, won't work until it's merged) but maybe there's a better option?