Conversation
Start an mdBook under docs/, laid out as in coreutils, and move the list of extensions and incompatibilities out of the README into it. The README keeps a pointer.
sed already knows exactly where a script error is -- every message carries input:line:column -- but a one-line message has nowhere to show it. Quote the offending script line back and underline the character at fault, gated on uucore::diagnostics::enabled() so that UUTILS_DIAG behaves as in every other utility, and drawn with ariadne, the renderer uucore uses. uucore's own Snapshot renders argument lists, so it would label the excerpt sed:1:N and could name neither a -f script nor the line within it. The excerpt is drawn only when stderr is a terminal, so a pipe, a script or the test suite still sees the single line it parses: the ~21 exact stderr assertions in the suite needed no change, and UUTILS_DIAG=always is how the new tests ask for a report down a pipe. Everything flows through the two existing constructors, so no call site changes: compilation_error covers the ~66 sites in compiler.rs and delimited_parser.rs, and location_error covers semantic errors. Semantic errors are raised once the whole script is compiled, long after the line was consumed -- the line provider streams and keeps no history -- so ScriptLocation now carries the line text along with the position. It is only captured when diagnostics are on, otherwise every compiled command would pay for a copy nobody reads, and even then the commands compiled from one line share a single copy of it -- a generated one-line script of 20,000 commands would otherwise hold 20,000 copies of itself. Only the offending line is still in hand, so it is padded with the newlines that came before it; that way the gutter shows the line number the message quotes rather than always 1. Errors that run off the end of the line report the column just past the last character, so the line gets a trailing space for the caret to sit on and the drawn column matches the one the message names. Anything that cannot be drawn -- a script that is not valid UTF-8, an empty line, a location with no line recorded, an error hit once the whole script has been read (whose message names line 0) -- leaves the message alone rather than guessing.
Contributor
Author
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #574 +/- ##
==========================================
- Coverage 83.88% 83.20% -0.68%
==========================================
Files 14 14
Lines 6974 7062 +88
Branches 406 412 +6
==========================================
+ Hits 5850 5876 +26
- Misses 1121 1182 +61
- Partials 3 4 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merging this PR will degrade performance by 4.27%
|
| Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|
| ❌ | number_fix |
1.1 s | 1.3 s | -11.32% |
| ⚡ | access_log_subst |
2.4 s | 2.3 s | +3.33% |
Tip
Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.
Comparing sylvestre:sed-diagnostics (46b0c68) with main (76086c8)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.