Repository navigation
Have a way to pass the plugin/id and an error code #57
Description
Currently one can pass a message but then it is not possible to identify the message in the IDE.
For that purpose it would be good if a caller cann pass the pligin/id and an error code, that way an IDE could map error messages to quick-fix actions. To complement this, a plugin might also want to pass additional context. So a generic way would be to have a context-map of <String, Object> that can be passed along.
Activity
kwin commentedon Mar 3, 2024
This would be also useful to extend the error message with a plugin id prefix. Currently all messages from
BuildContextappear out of context (if not logged with SLF4J), i.e. the mojo which has emitted the message cannot be identified.kwin commentedon Mar 3, 2024
@laeubi WDYT about a new component
BuildContextFactorywhich creates build contexts per plugin coordinate? That way the context would be part of theBuildContextobject (which is then no longer a singleton obviously).laeubi commentedon Mar 3, 2024
@kwin I'm not sure if we are having the same in min,d but the mojo /execution is already tracked, so if this is useful it should already be possible to do so.
My plan would be to have a dedicated
MarkerContextin a new package that is only dedicated to marker support, this then should also include for example:kwin commentedon Mar 3, 2024
How does this work if currently the context is a singleton and there is multithreading going on (i.e. multiple modules are built in parallel) or are you only talking about the m2e implementation?
Update: In m2e this is achieved with https://github.com/eclipse-m2e/m2e-core/blob/112488c013ba85ea43ad104296e391e68bd9fb50/org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/builder/MavenBuilderImpl.java#L145, which only works in a single-threaded build.
laeubi commentedon Mar 3, 2024
In general you need to register a
MojoExecutionListener(or similar) then there you just have aThreadLocalwhere you put the current execution for example.The in your
BuildContextimplementation you reference that mojo and can get the current active execution for the thread and extract whatever information you need.One example can be seen at Tycho here:
https://github.com/eclipse-tycho/tycho/blob/main/tycho-spi/src/main/java/org/eclipse/tycho/helper/MojoExecutionHelper.java
laeubi commentedon Mar 3, 2024
Another option would be to make implementation
@MojoExecutionScoped.