se-edu/addressbook-level2

Set up checkstyle

pyokagan opened this issue · 4 comments

To ensure we do not get any code style violations in master.

Probably should be done after #112 is done.

A PR will also need to resolve all the current errors I get from master: (I copied over the checkstyle config from addressbook-level4)

[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/Main.java:0: File does not end with a newline. [NewlineAtEndOfFile]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/Main.java:102: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/commands/IncorrectCommand.java:7:46: '{' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/commands/IncorrectCommand.java:11:51: '{' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/data/person/Address.java:0: File does not end with a newline. [NewlineAtEndOfFile]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/data/person/Email.java:0: File does not end with a newline. [NewlineAtEndOfFile]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/data/person/Name.java:16: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/data/person/Name.java:21: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/data/person/ReadOnlyPerson.java:24: Line is longer than 120 characters (found 125). [LineLength]
[ant:checkstyle] [WARN] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/data/tag/UniqueTagList.java:137:23: Name 'TagFoundAndDeleted' must match pattern '^[a-z][a-zA-Z0-9]*$'. [LocalFinalVariableName]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:0: File does not end with a newline. [NewlineAtEndOfFile]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:67: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:68: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:70: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:71: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:73: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:74: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:76: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:77: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:79: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:80: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:82: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:83: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:85: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:86: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:88: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:89: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:91: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:92: 'case' child have incorrect indentation level 12, expected level should be 8. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:93: 'block' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/parser/Parser.java:103:44: '{' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/ui/TextUi.java:41:20: '{' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/src/seedu/addressbook/ui/TextUi.java:125:11: 'if' is not followed by whitespace. [WhitespaceAround]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:49: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:85: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:92: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:115: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:119: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:121: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:123: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:124: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:127: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:132: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:134: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:136: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:137: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:140: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:143: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:145: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:148: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:152: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:154: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:158: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/commands/DeleteCommandTest.java:159: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:49: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:55: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:77: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:91: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:113: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:153: 'array initialization' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:154: 'array initialization' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:187: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:191: 'array initialization' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:192: 'array initialization' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/parser/ParserTest.java:193: 'array initialization' child have incorrect indentation level 16, expected level should be 12. [Indentation]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/util/TestUtil.java:18: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/util/TestUtil.java:22: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/util/TestUtil.java:25: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/util/TestUtil.java:31: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/util/TestUtil.java:35: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]
[ant:checkstyle] [ERROR] /home/pyokagan/pyk/addressbook-level2/test/java/seedu/addressbook/util/TestUtil.java:38: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]

May I do this issue? (I will also be doing #112 since this issue depends on that)

Just a thought -- do we actually need to set up Gradle just to use checkstyle? Can't we just run checkstyle from the shell scripts instead?

do we actually need to set up Gradle just to use checkstyle? Can't we just run checkstyle from the shell scripts instead

That's true. But Gradle can run tests as well, saving the reviewer the trouble of downloading PR code and running tests?