nus-cs2103-AY2122S2 / forum

13 stars 1 forks source link

Checkstyle does not seem to check the docs folder locally #257

Open yongler opened 2 years ago

yongler commented 2 years ago

As above, example would be passing checkstyle in my local repo, but failing in the github CI due to no new line at the end of the UserGuide.md

charmainehly commented 2 years ago

Not sure if the closed issue #101 might be helpful! - the replies suggest how to modify the settings in Intellij to help with automatically adding the line break at the EOF.

Though I'm not sure if changes will need to be made to your checkstyle.xml file to account for the discrepancy on checkstyle passing locally - i think the relevant code chunk for the configuration is at <module name="NewlineAtEndOfFile">

Have also linked the screenshot below on the section with options to check/uncheck 'removing trailing spaces' and 'ensuring the saved file ends with a line break'! :)

Screenshot 2022-04-07 at 5 28 37 PM

ddx-510 commented 2 years ago

Not too sure whether this is due to the Line separator issue, for the line separator, you could find more details on the issue #192