https://github.com/hhru/checkstyle

https://github.com/hhru/checkstyle

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hhru/checkstyle
• Owner: hhru
• Created: 2018-10-01T09:32:45.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-26T08:20:48.000Z (10 months ago)
• Last Synced: 2024-06-26T09:42:46.451Z (10 months ago)
• Language: Java
• Size: 169 KB
• Stars: 2
• Watchers: 62
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.MD
  • Changelog: changelog.yaml
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Checkstyle

> Официально checkstyle не умеет наследовать конфиги: [issue](https://github.com/checkstyle/checkstyle/issues/2873)  

> Но мы запилили свой тулсет, который позволяет наследовать конфиги один от другого  

> [Как работает merge](merge-description.md)

Пример стандартного использования: 

![example](./example)

## Как собрать

1. `merge --no-ff`

2. `mvn release:prepare mvn release:perform` 

> Сервис использует практику dogfood, поэтому после релиза полезно поднять версию плагина в помнике

## Тулы для работы с checkstyle

- ![hh-maven-checkstyle-plugin](./hh-maven-checkstyle-plugin) - maven-plugin, обертка над [maven-checkstyle-plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/), который включает в себя наши кастомные чеки, конфиги и механизм наследования.  

**При сборке своих конфигов можно использовать ``**,  

(см. ![hhru-checkstyle.xml](./checkstyle-config-plugin/src/main/resources/hhru/hhru-checkstyle.xml))

Если нет никаких причин, то лучше просто использовать этот плагин

### Еще

- ![checks](./checks) - наши кастомные checkstyle проверки.  

Можно использовать отдельно (см. ![shared-checkstyle.xml](./checkstyle-config-plugin/src/main/resources/shared-checkstyle.xml))

- ![checkstyle-config-plugin](./checkstyle-config-plugin) - артефакт, который поставляет конфиги  

его можно использовать с оригинальным checkstyle, но потребуются зависимости на `com.puppycrawl.tools`, наши чеки и не будет работать наследование конфигов:

```xml

    

    ...

        

            org.apache.maven.plugins

            maven-checkstyle-plugin

            3.0.0

            

                

                    ru.hh.checkstyle

                    checkstyle-config-plugin

                    ${project.version}

                

            

            

                

                    validate

                    validate

                    

                        shared-checkstyle.xml

                    

                    

                        check

                    

                

            

        

        ...

    

```

- ![checkstyle-config-compilation-maven-plugin](./checkstyle-config-compilation-maven-plugin) - maven-plugin, который разрешает использование наследования при сборке ![checkstyle-config-plugin](./checkstyle-config-plugin)