Skip to content

Commit 3261eb1

Browse files
docs(readme): add explicit plugin activation steps
1 parent 3f014c7 commit 3261eb1

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,58 @@ dependencies {
120120

121121
Legacy `buildscript` mode is still supported. See docs below.
122122

123+
## Plugin Activation (Exact Steps)
124+
125+
Use this section if you want one-argument BPJ calls like:
126+
127+
```java
128+
BPJ.println("Hello {name}");
129+
```
130+
131+
to resolve values automatically.
132+
133+
### Maven activation in 3 steps
134+
135+
1. Add BPJ runtime dependency in `pom.xml`.
136+
2. Activate one Maven option:
137+
- Parent option: `bpj-starter-parent` or `bpj-spring-boot-parent`.
138+
- Manual option: add `bpj-maven-plugin` with goal `prepare`.
139+
3. Build through Maven:
140+
141+
```bash
142+
mvn clean compile
143+
```
144+
145+
Then verify generated files exist in:
146+
- `target/generated-sources/bpj`
147+
148+
### Gradle activation in 4 steps
149+
150+
1. Add BPJ runtime dependency in `build.gradle`.
151+
2. Add BPJ plugin id in `build.gradle`:
152+
153+
```groovy
154+
plugins {
155+
id "java"
156+
id "io.github.oriontheprogrammer.bpj" version "0.3.0"
157+
}
158+
```
159+
160+
3. Ensure `pluginManagement` includes `gradlePluginPortal()` and `mavenCentral()` in `settings.gradle`.
161+
4. Build through Gradle:
162+
163+
```bash
164+
./gradlew clean compileJava
165+
```
166+
167+
Then verify generated files exist in:
168+
- `build/generated/sources/bpj/main`
169+
170+
### IDE note (important)
171+
172+
If you run `main()` directly from IDE without delegated Maven/Gradle build, transformation may be skipped.
173+
Run from terminal or enable delegated build/run in your IDE.
174+
123175
## Usage: Plugin OFF vs Plugin ON
124176

125177
| Mode | Example | Notes |

0 commit comments

Comments
 (0)