Skip to content

Fix line numbers in checkstyle output #3694

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.

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

Merged
merged 2 commits into from
Aug 19, 2019

Conversation

calebcartwright
Copy link
Member

@calebcartwright calebcartwright commented Jul 18, 2019

Resolves #1386

@calebcartwright calebcartwright changed the title Include both original and new line numbers in checkstyle output WIP: Include both original and new line numbers in checkstyle output Jul 18, 2019
@calebcartwright
Copy link
Member Author

Actually there's more going wrong here than I realized 🤔

The current checkstyle output generated from formatting tests/writemode/source/fn-single-line.rs is way off on the calcs for both the line_number and line_number_orig values in the Mismatch :

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
  <file name="tests/writemode/source/fn-single-line.rs">
    <error line="2" original_line="2" severity="warning" message="Should be `fn foo_expr() { 1 }`" />
    <error line="2" original_line="2" severity="warning" message="Should be `fn foo_stmt() { foo(); }`" />
    <error line="2" original_line="2" severity="warning" message="Should be `fn foo_decl_local() { let z = 5; }`" />
    <error line="2" original_line="2" severity="warning" message="Should be `fn foo_decl_item(x: &amp;mut i32) { x = 3; }`" />
    <error line="2" original_line="2" severity="warning" message="Should be `fn empty() {}`" />
    <error line="2" original_line="2" severity="warning" message="Should be `fn foo_return() -&gt; String { &quot;yay&quot; }`" />
    <error line="2" original_line="2" severity="warning" message="Should be `fn foo_where() -&gt; T`" />
    <error line="2" original_line="2" severity="warning" message="Should be `where`" />
    <error line="2" original_line="2" severity="warning" message="Should be `    T: Sync,`" />
    <error line="2" original_line="2" severity="warning" message="Should be `{`" />
    <error line="52" original_line="61" severity="warning" message="Should be `fn lots_of_space() { 1 }`" />
    <error line="59" original_line="70" severity="warning" message="Should be `    fn dummy(&amp;self) {}`" />
    <error line="59" original_line="70" severity="warning" message="Should be `trait CoolerTypes {`" />
    <error line="59" original_line="70" severity="warning" message="Should be `    fn dummy(&amp;self) {}`" />
    <error line="59" original_line="70" severity="warning" message="Should be `fn Foo&lt;T&gt;()`" />
    <error line="59" original_line="70" severity="warning" message="Should be `where`" />
    <error line="59" original_line="70" severity="warning" message="Should be `    T: Bar,`" />
    <error line="59" original_line="70" severity="warning" message="Should be `{`" />
  </file>
</checkstyle>

@calebcartwright calebcartwright changed the title WIP: Include both original and new line numbers in checkstyle output WIP: Fix line numbers in checkstyle output Jul 19, 2019
@calebcartwright calebcartwright force-pushed the checkstyle-line-numbers branch from b7aaa56 to 3caa157 Compare August 16, 2019 18:34
@calebcartwright calebcartwright changed the title WIP: Fix line numbers in checkstyle output Fix line numbers in checkstyle output Aug 16, 2019
@calebcartwright
Copy link
Member Author

calebcartwright commented Aug 16, 2019

I decided to keep things simple here, and just fix the offset line numbers. Below is an example of the checkstyle output that is now emitted (pretty printed for ease of view). See above for what this same output looked like before.

My recommendation is that anyone wanting a more complex output (line numbers from the before/after versions of the file, start/end line numbers, etc.) should instead use the new json emit mode added in #3735 as the json format should be easier to work with.

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
  <file name="tests/writemode/source/fn-single-line.rs">
    <error line="5" severity="warning" message="Should be `fn foo_expr() { 1 }`" />
    <error line="7" severity="warning" message="Should be `fn foo_stmt() { foo(); }`" />
    <error line="9" severity="warning" message="Should be `fn foo_decl_local() { let z = 5; }`" />
    <error line="11" severity="warning" message="Should be `fn foo_decl_item(x: &amp;mut i32) { x = 3; }`" />
    <error line="13" severity="warning" message="Should be `fn empty() {}`" />
    <error line="15" severity="warning" message="Should be `fn foo_return() -&gt; String { &quot;yay&quot; }`" />
    <error line="17" severity="warning" message="Should be `fn foo_where() -&gt; T`" />
    <error line="18" severity="warning" message="Should be `where`" />
    <error line="19" severity="warning" message="Should be `    T: Sync,`" />
    <error line="20" severity="warning" message="Should be `{`" />
    <error line="55" severity="warning" message="Should be `fn lots_of_space() { 1 }`" />
    <error line="60" severity="warning" message="Should be `    fn dummy(&amp;self) {}`" />
    <error line="63" severity="warning" message="Should be `trait CoolerTypes {`" />
    <error line="64" severity="warning" message="Should be `    fn dummy(&amp;self) {}`" />
    <error line="67" severity="warning" message="Should be `fn Foo&lt;T&gt;()`" />
    <error line="68" severity="warning" message="Should be `where`" />
    <error line="69" severity="warning" message="Should be `    T: Bar,`" />
    <error line="70" severity="warning" message="Should be `{`" />
  </file>
</checkstyle>

@topecongiro topecongiro added this to the 1.4.6 milestone Aug 19, 2019
@topecongiro topecongiro merged commit 9792ff0 into rust-lang:master Aug 19, 2019
@topecongiro
Copy link
Contributor

Sorry for the late review on this one. Thank you for your works!

@calebcartwright calebcartwright deleted the checkstyle-line-numbers branch August 19, 2019 02:28
@calebcartwright
Copy link
Member Author

Sorry for the late review on this one. Thank you for your works!

No worries, and my pleasure! I'm still pretty new to Rust but I find working with rustfmt is both fun and helping me learn. I'm keeping an eye out for any issues I think I can help with, but please also let me know if there's anything in particular I can do to help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

checkstyle line numbers are offset
2 participants