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

Inconsistency in the phrasing of diagnostic messages in the output #19

Closed
gkapfham opened this issue Sep 5, 2018 · 1 comment
Closed

Comments

@gkapfham
Copy link
Contributor

gkapfham commented Sep 5, 2018

Currently, the Gradle plugin and the GatorGrader program produce diagnostic output that is slightly different. For instance, consider this output:

✔  The DisplayOutput.java in src/main/java/labone has at least 1 of the 'new Date(' fragment
✔  Repository has at least 10 commit(s)
✔  The DisplayOutput.java in src/main/java/labone has at least 2 single-line Java comment(s)
✔  The reflection.md in writing has at least 1 paragraph(s)
✔  The reflection.md in writing has at least 200 word(s) in every paragraph
✔  The file writing/reflection.md passes mdl
✔  The DisplayOutput.java in src/main/java/labone has at least 2 multiple-line Java comment(s)
✔  The DisplayOutput.java in src/main/java/labone has at least 4 of the 'println(' fragment
✔  The file writing/reflection.md passes proselint
✔  The content has at least 4 lines


        ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
        ┃ Passed 10/10 (100%) of checks for cmpsc-111-fall-2018-lab1! ┃
        ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

When the Gradle plugin runs a check with mdl it does not pass this through GatorGrader and rather runs the check on its own. However, the Gradle plugin using the phrase "The file" and the GatorGrader program simply writes "The ..." and gives the name of the file. Is there an easy way for the Gradle plugin to also use the format "entity in directory" and not use the word "the"? Otherwise, is there another approach that we can take to make the output as uniform as is possible? Okay, let me know what you think!

@Michionlion
Copy link
Member

If we wanted to use the "entity in directory" format, we would have to parse the file path ourselves. It would certainly be possible, and should be something on our todo list!

@gkapfham gkapfham changed the title Slight Inconsistency in the Phrasing of Diagnostic Messages in the Output Inconsistency in the Phrasing of Diagnostic Messages in the Output Jan 2, 2019
@gkapfham gkapfham changed the title Inconsistency in the Phrasing of Diagnostic Messages in the Output Inconsistency in the phrasing of diagnostic messages in the output Jan 2, 2019
@Michionlion Michionlion closed this as not planned Won't fix, can't repro, duplicate, stale Jul 18, 2022
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

2 participants