-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
20 additions
and
8 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 |
---|---|---|
@@ -1,27 +1,39 @@ | ||
# Bouffier Java | ||
This convert Java source to AST representation. | ||
This is a tool for converting Java source to AST representation. | ||
|
||
AST file support the follow formats. | ||
- yaml | ||
- xml | ||
|
||
## Usage | ||
`BOUFFIER_JAVA_PROJECT_PATH`: This contains Java sources and output AST files (default is `/bouffier-java`) | ||
### `BOUFFIER_JAVA_PROJECT_PATH` | ||
The specified directory contains Java sources and output AST files (default is `/bouffier-java-project`) | ||
|
||
This directory should have the following composition. | ||
|
||
```bash | ||
projects/ | ||
├── out | ||
│ └── {{AST file is output here}} | ||
│ └── {{AST files will be outputed here}} | ||
└── source | ||
└── {{There is Java sources}} | ||
└── {{Java sources}} | ||
``` | ||
|
||
So, you need to create a directory in this format and mount it. | ||
|
||
`BOUFFIER_JAVA_FORMAT`: the format of output AST file. (default is `yaml`) | ||
### `BOUFFIER_JAVA_FORMAT` | ||
The format of output AST file. (default is `yaml`) | ||
|
||
You can choose the following format. | ||
|
||
- yaml | ||
- xml | ||
|
||
### Quick Start | ||
Clone this repository and put java sources in `/tests/resources/source`. | ||
|
||
Run by docker-compose. | ||
|
||
### Example | ||
```bash | ||
$ docker run -e BOUFFIER_JAVA_FORMAT=xml -v {{your dir path}}:/bouffier-java taxio/bouffier-java | ||
$ docker-compose -f docker-compose.sample.yml up | ||
``` |
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