CONTRIBUTING.md

Contributing

Want to contribute?

Please contact the authors.

CI

Sonar

# install
docker pull library/sonarqube:10.4.0-community
docker pull sonarsource/sonar-scanner-cli:5.0.1
docker run -d --name sonarqube -p 9000:9000 sonarqube
# security
# (http://localhost:9000 > sonar menu > 'Administration' > 'Configuration' > 'Security' > 'Force user authentication':off)

# usage: scan with docker
docker run -it --rm --net=host -e SONAR_SCANNER_OPTS="-Dsonar.projectKey=mapstruct-doc" -v ".:/usr/src" sonarsource/sonar-scanner-cli

# result
# http://localhost:9000/dashboard?id=mapstruct-doc

Debug

# security
# (http://localhost:9000 > sonar menu > 'my account' > 'security' > 'type:globa'l > 'generate' > copy token value)

# usage:scan with maven
$Env:JAVA_HOME='C:\Program Files\Java\jdk-17.0.9+9\'
$env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")
mvn clean verify sonar:sonar -Pcoverage -Dsonar.projectKey=mapstruct-doc -Dsonar.projectName='mapstruct-doc' -Dsonar.host.url=http://localhost:9000 -Dsonar.token=...

Resources

• mapstruct.org
  • ide-support
• stackoverflow.com
  • "Generate documentation from Mapstruct code ?"
• other
  • maven-plugin (README layout)
  • mojo-executor (project layout)
  • maven-compiler (tests layout)
  • enunciate (gradle plugin)
• hannesdorfmann.com
  • Annotation Processing 101: post
  • Annotation Processing 101: github
• baeldung.com
  • Java Annotation Processing and Creating a Builder