mapstruct / mapstruct/mapstruct.org

Add comment for other annotation processors for the installation

Open
#72 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
71
Forks
40
PR merge metrics
No merged PRs in 30d

Description

A lot of users are having problems, because they don't quite understand the maven compiler annotationProcessorPaths. @alexis-puska suggested that we extend the installation instructions with something like:

<configuration>
    <source>1.6</source> <!-- or higher, depending on your project -->
    <target>1.6</target> <!-- or higher, depending on your project -->
    <annotationProcessorPaths>
        <path>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>${org.mapstruct.version}</version>
        </path>
        <!-- If you use other annotations processor add them here -->
    </annotationProcessorPaths>
</configuration>

I think that this is a good suggestion and would help other developers in issues when MapStruct and Lombok are not working well together due to wrong setup

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the installation page linked in the issue and review its Maven compiler setup. Done means the installation instructions explain annotationProcessorPaths for additional annotation processors and include the proposed configuration example, with the MapStruct/Lombok setup context covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.