Skip to content

Commit 1c6c22a

Browse files
committed
docs: Add GEMINI.md for project context
1 parent 9a17037 commit 1c6c22a

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

GEMINI.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Gemini Code Assistant Project Context
2+
3+
This document provides context for the `embulk-input-randomj` project to help Gemini Code Assistant understand the project and assist more effectively.
4+
5+
## Project Overview
6+
7+
`embulk-input-randomj` is an Embulk input plugin for generating dummy records, written in Java. It is a fork of the original `embulk-input-random` plugin, with added features and enhancements.
8+
9+
The plugin allows users to define a schema for generating random data, with options to control the number of rows, threads, and specific characteristics of the generated data, such as data types, lengths, value ranges, and null rates. It also supports generating JSON data and provides fine-grained control over timestamp generation.
10+
11+
## Key Technologies
12+
13+
- **Language:** Java 8
14+
- **Build Tool:** Gradle
15+
- **Dependency Management:** Gradle
16+
- **Testing Framework:** JUnit 5
17+
- **Code Analysis:** Checkstyle, SpotBugs
18+
19+
## Directory Structure
20+
21+
```
22+
.
23+
├── build.gradle # Gradle build script
24+
├── src
25+
│ ├── main
26+
│ │ └── java # Main application source code
27+
│ │ └── io/github/yuokada/embulk/input/randomj
28+
│ │ ├── RandomjInputPlugin.java # Main plugin class
29+
│ │ ├── PluginTask.java # Plugin configuration
30+
│ │ └── visitor # Column visitors
31+
│ └── test
32+
│ └── java # Test source code
33+
│ └── io/github/yuokada/embulk/input/randomj
34+
│ └── TestRandomjInputPlugin.java # Plugin tests
35+
├── example
36+
│ └── config.yml # Example configuration file
37+
└── README.md # Project documentation
38+
```
39+
40+
## Common Commands
41+
42+
- **Build the project:** `./gradlew build`
43+
- **Run tests:** `./gradlew test`
44+
- **Run the plugin with an example configuration:** `embulk run -I lib example/config.yml`
45+
- **Create the gem:** `./gradlew gem`

0 commit comments

Comments
 (0)