Skip to content

chore: add formatter #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pankajEndee merged 1 commit into from
Mar 9, 2026
Merged

chore: add formatter #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,9 +363,8 @@ import io.endee.client.types.IndexDescription;

IndexDescription info = index.describe();
System.out.println(info);
// IndexDescription{name='my_index', spaceType=COSINE, dimension=384,
// sparseDimension=0, isHybrid=false, count=1000,
// precision=INT16, m=16}
// {name='my_index', spaceType= COSINE, dimension=384, precision=INT16,
// count=1000, isHybrid=false, sparseDimension=0, M=16, efCon=128}
```

### Check if Index is Hybrid
Expand Down Expand Up @@ -608,6 +607,23 @@ VectorItem.builder(String id, double[] vector)
| `count` | `long` | Number of vectors |
| `precision` | `Precision` | Quantization precision |
| `m` | `int` | Graph connectivity |
| `efCon` | `int` | Construction-time quality parameter |

## Code Formatting

This project uses [Spotless](https://github.com/diffplug/spotless) with [Google Java Format](https://github.com/google/google-java-format) to enforce consistent code style.

**Format all source files:**
```bash
mvn spotless:apply
```

**Check formatting without modifying files:**
```bash
mvn spotless:check
```

Formatting is also checked automatically as part of `mvn verify` — CI will fail if any file is not properly formatted.

## Dependencies

Expand Down
25 changes: 25 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,31 @@
</executions>
</plugin>

<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<version>2.43.0</version>
<configuration>
<java>
<googleJavaFormat>
<version>1.22.0</version>
<style>GOOGLE</style>
</googleJavaFormat>
<removeUnusedImports/>
<trimTrailingWhitespace/>
<endWithNewline/>
</java>
</configuration>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
<phase>verify</phase>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
Expand Down
Loading