Skip to content

Commit 0722e92

Browse files
authored
chore(docs): Add FAQs section to docs with information about Lombok support. (#680)
* chore(docs): Add FAQs section to docs with information about Lombok support. * chore(docs): Fix highlighting of code snipped in FAQ
1 parent 2a6b4a3 commit 0722e92

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/FAQs.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: FAQs
3+
description: Frequently Asked Questions
4+
---
5+
6+
7+
## How can I use Powertools with Lombok?
8+
9+
Poweretools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into the project. In case you want to use `Lombok` or other compile-time preprocessor for your project, it is required to change `aspectj-maven-plugin` configuration to enable in-place weaving feature. Otherwise the plugin will ignore changes introduced by `Lombok` and will use `.java` files as a source.
10+
11+
To enable in-place weaving feature you need to use following `aspectj-maven-plugin` configuration:
12+
13+
```xml hl_lines="2-6"
14+
<configuration>
15+
<forceAjcCompile>true</forceAjcCompile>
16+
<sources/>
17+
<weaveDirectories>
18+
<weaveDirectory>${project.build.directory}/classes</weaveDirectory>
19+
</weaveDirectories>
20+
...
21+
<aspectLibraries>
22+
<aspectLibrary>
23+
<groupId>software.amazon.lambda</groupId>
24+
<artifactId>powertools-logging</artifactId>
25+
</aspectLibrary>
26+
</aspectLibraries>
27+
</configuration>
28+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ site_author: Amazon Web Services
44
nav:
55
- Homepage: index.md
66
- Changelog: changelog.md
7+
- FAQs: FAQs.md
78
- Core utilities:
89
- core/logging.md
910
- core/tracing.md

0 commit comments

Comments
 (0)