Skip to content
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

Minor improvements for the HTML report #385

Open
zspitzer opened this issue Jul 30, 2017 · 7 comments
Open

Minor improvements for the HTML report #385

zspitzer opened this issue Jul 30, 2017 · 7 comments
Assignees
Milestone

Comments

@zspitzer
Copy link

zspitzer commented Jul 30, 2017

The HTML report is a bit more verbose than it needs to be

Variable user_id is not declared with a var statement. Use var or the local scope, or otherwise clarify the scope

In file C:\Users\zac\Documents\GitHub\CFLint\build\libs.\linenumber.cfm, line 2

At line: 2, at column: 2

In function test()

Expression: user_id

  • line number is repeated twice, may add the column number to the file reference and remove the At line: 2, at column: 2 line and extra new line?
  • the variable user_id could be made bold for clarity
  • expression (i.e. code snippets) could be wrapped in <pre></pre>
  • 'In file' is kind redundant before to the file path
  • does the warning need to be repeated in the details section, it's already the warning column?

Variable user_id is not declared with a var statement. Use var or the local scope, or otherwise clarify the scope

C:\Users\zac\Documents\GitHub\CFLint\build\libs.\linenumber.cfm, line 2, column 2

In function test()

Expression: user_id

@TheRealAgentK TheRealAgentK self-assigned this Jul 30, 2017
@TheRealAgentK TheRealAgentK added this to the 1.2.1 milestone Jul 30, 2017
@TheRealAgentK
Copy link
Collaborator

Ha, nothing is easy sometimes.

So, the HTML report gets created by XSLT from Findbugs XML which itself comes out of CFLint XML by XSLT. sigh :-)

In a nutshell - some of the blurbs I get to get into the HTML report can't be easily changed.

I made two small fixes:

  • does the warning need to be repeated in the details section, it's already the warning column?
  • 'In file' is kind redundant before to the file path

The other items I'll get back to in the output/report rewrite for 2.0.

TheRealAgentK added a commit to TheRealAgentK/CFLint that referenced this issue Jul 30, 2017
@TheRealAgentK
Copy link
Collaborator

@zspitzer Can you please try with the recent changes and check that I didn't break anything essential along the way? :)

Sorry, not idea fix, it's just deferred for a bit.

@TheRealAgentK TheRealAgentK modified the milestones: 2.0, 1.2.1 Jul 30, 2017
@TheRealAgentK
Copy link
Collaborator

Changed milestone to 2.0 for the remaining bits of @zspitzer's suggestion

@zspitzer
Copy link
Author

just tried it, all working fine, thanks!

one last thing which would be good is to omit the full path when a relative path is defined

so C:\Users\zac\Documents\GitHub\CFLint\build\libs.\linenumber.cfm, line 2
becomes .\linenumber.cfm, line 2

@zspitzer
Copy link
Author

also, shouldn't summary break down warnings by type? rather than just a single row for CFLint Warnings

@TheRealAgentK
Copy link
Collaborator

Yes, it should. That's kind of a default behaviour because the XSL templates for the HTML reports are pretty much 1:1 taken from the Findbugs project, but they manage the underlying data differently. I'll have a quick look if there's an easy fix for that we can throw in now.

@TheRealAgentK
Copy link
Collaborator

Fixed that @zspitzer

TheRealAgentK added a commit to TheRealAgentK/CFLint that referenced this issue Jul 31, 2017
TheRealAgentK added a commit that referenced this issue Jul 31, 2017
#385 - Further HTML report improvements
ryaneberly added a commit that referenced this issue Aug 10, 2017
* Remove dependency copying (#376)

There doesn't seem to be a reason to have this phase. Perhaps there was
one before? All the required dependencies are added to the final JAR by
the `maven-shade-plugin` in the `package` phase anyway. This dependency
copying just seems like a waste of time.

* Add .editorconfig

Provides common whitespace settings for all editors. Supported out of
the box in some IDE's (like IntelliJ IDEA) and all others have
appropriate plugins.

*  Added .cflintrc schema and output schemas for JSON and XML. Tweaked README. (#377)

Added .cflintrc schema and output schemas for JSON and XML. Tweaked README.

* support autochange

* #382

* Align Gradle dependencies with Maven ones (#378)

Define the same set (and scopes) of dependencies for Gradle builds as we
have now in Maven's `pom.xml`.

* Added some context to the changelog for 1.2.0 and removed a lot of "##### no issues" items that were added to the list.

* Changed setting for auto-adding a final new line, that screws up expected files for tests.

* #383 Changed code, test, README with the output sample and JSON schema.

* Update timestamp type in result schemas

* #385 Two small modifications to HTML report

* Changed build versions to 1.2.1-SNAPSHOT in dev branch and change documentation to 1.2.1 in dev branch.

* 390 Add Implementation-Version to MANIFEST

Configures the Maven and Gradle builds to include
`Implementation-Version` in the MANIFEST.MF file, which can then be read
by the application and displayed to the user.

* #385 - Further HTML report improvements

* #390 - Adapting new way to grab version string

* #390 - Hopefully fixing Gradle build

* #390 - Review changes

* #396 fixed

* Update README.md

Explains how to pass multiple arguments in the command line in Windows Powershell and fixes a typo.

Fixes #400

* Update CODE_OF_CONDUCT.md

* #380 fixed

* Added VS Code info. Some cleanup.

* use cfparser 2.4.11

* #408

* #373

* #367

* #367

* add sonatype repo

* merged master

* cfparser 2.5.0

* Added test for #359 showing parsing error gone with cfparser 2.5.0

* #359 use parseCFMLExpression

* fix tests

* test for #346

* #413

* fix test

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

No branches or pull requests

3 participants