Skip to content

What files need to be changed or created in repository for new Check implementation

Jump to bottom
Roman Ivanov edited this page Dec 2, 2016 · 2 revisions

  1. your Check - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/YOUR_PACKAGE/YOUR_CHECK_NAME.java

  2. messages - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/src/main/resources/com/github/sevntu/checkstyle/checks/YOUR_PACKAGE/messages.properties

  3. Junit file - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/src/test/java/com/github/sevntu/checkstyle/checks/YOUR_PACKAGE/YOUR_CHECK_NAMETest.java

  4. input files - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/src/test/resources/com/github/sevntu/checkstyle/checks/YOUR_PACKAGE/InputYOUR_CHECK_NAME.java

  5. sonar config - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checkstyle-sonar-plugin/src/main/resources/com/github/sevntu/checkstyle/sonar/checkstyle-extensions.xml

  6. eclispecs config - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/eclipsecs-sevntu-plugin/src/com/github/sevntu/checkstyle/checks/YOUR_PACKAGE/checkstyle-metadata.properties

  7. eclispecs config - https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/eclipsecs-sevntu-plugin/src/com/github/sevntu/checkstyle/checks/YOUR_PACKAGE/checkstyle-metadata.xml

  8. new Check need to be applied to sevntu.checkstyle code and violations are fixed and provided as PR. Example: https://github.com/sevntu-checkstyle/sevntu.checkstyle/pull/423 File: https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/sevntu-checks.xml

  9. new Check need to be applied to checkstyle code and violations are fixed and provided as PR. Example: https://github.com/checkstyle/checkstyle/pull/2796 file: https://github.com/checkstyle/checkstyle/blob/master/config/checkstyle_sevntu_checks.xml

  10. default configuration with all default options https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/gh-pages/sevntu-checkstyle-default-configuration.xml

Clone this wiki locally