-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
dos: move jte-extension-api to /docs
- Loading branch information
1 parent
fce7903
commit ed7d2e8
Showing
3 changed files
with
30 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: jte-extension-api | ||
description: A jte module that defines the interface to add extensions to jte generation. | ||
--- | ||
|
||
# jte-extension-api | ||
|
||
This module defines the interface to add extensions to jte generation. Extensions can generate additional files based on metadata about jte templates. | ||
|
||
## Writing an Extension | ||
|
||
Extension authors must implement the `gg.jte.extension.api.JteExtension` interface. | ||
The implementing class must have a no-argument constructor so that it can be instantiated by name. | ||
|
||
## Testing | ||
|
||
The companion module `jte-extension-api-mocks` provides mock implementations of the API interfaces to help with writing unit tests. | ||
|
||
## Usage | ||
|
||
The jte Maven and Gradle plugins allow configuring extensions. | ||
|
||
## Examples | ||
|
||
* [jte-models](jte-models.md) module is an extension that generates typesafe facades for templates. | ||
* [test/jte-runtime-cp-test-models](https://github.com/casid/jte/tree/{{ POM_VERSION }}/test/jte-runtime-cp-test-models) uses the Maven plugin to apply the jte-models extension. | ||
* [test/jte-runtime-cp-test-models-gradle](https://github.com/casid/jte/tree/{{ POM_VERSION }}/test/jte-runtime-cp-test-models-gradle) uses the Gradle plugin to apply the jte-models extension. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,3 @@ | ||
# jte-extension-api | ||
|
||
This module defines the interface to add extensions to jte generation. | ||
Extensions can generate additional files based on metadata about jte templates. | ||
|
||
## Writing an Extension | ||
|
||
Extension authors must implement the `JteExtension` interface. | ||
The implementing class must have a no-argument constructor so that it can be instantiated by name. | ||
|
||
## Testing | ||
|
||
The companion module jte-extension-api-mocks provides mock implementations of the API interfaces to help with writing unit tests. | ||
|
||
## Usage | ||
|
||
The jte Maven and Gradle plugins allow configuring extensions. | ||
|
||
## Examples | ||
|
||
* jte-models module is an extension that generates typesafe facades for templates. | ||
* test/jte-runtime-cp-test-models uses the Maven plugin to apply the jte-models extension. | ||
* test/jte-runtime-cp-test-models-gradle uses the Gradle plugin to apply the jte-models extension. | ||
See official docs: <https://jte.gg/latest/jte-extension-api/>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters