Code style

[kulvait]

Hi,

thank you for this library — I’m currently building an ImageJ plugin for Zarr on top of it.

While working on ReadOnlyZipStore, I focused on performance improvements. I rewrote the directory listing logic and avoided apache IO logic which provide a substantial speedup. However, chunk reading is still inefficient because it relies on sequential streaming via Apache Commons, so there is more room for improvement there.

On a separate note, I noticed that the repository does not seem to include an actual code style configuration (the .idea/codeStyles is empty). It would be very helpful to have a defined formatter. I experimented with Spotless + Eclipse formatter, but the result still introduces many formatting changes compared to the current codebase.

Before opening a PR, I’d like to avoid large formatting-only diffs. If you could share or export your code style, it would help keep contributions consistent.

Thanks!

Please have a look if it is possible to edit files in https://github.com/kulvait/zarr-java/tree/zip/styles so that it is possible to format by maven spotless like:

<plugin>
  <groupId>com.diffplug.spotless</groupId>
  <artifactId>spotless-maven-plugin</artifactId>
  <version>3.4.0</version>
  <configuration>
    <java>
      <eclipse>
        <file>${project.basedir}/styles/eclipseStyle.xml</file>
      </eclipse>
    </java>
    <formats>
      <format>
        <includes>
          <include>**/*.xml</include>
        </includes>
        <eclipseWtp>
          <type>XML</type>
          <files>
            <file>${project.basedir}/styles/org.eclipse.wst.xml.core.prefs</file>
          </files>
        </eclipseWtp>
      </format>
    </formats>
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>apply</goal>
      </goals>
    </execution>
  </executions>
</plugin>

[normanrz]

Hi, thanks for creating this issue. I think it would would make sense to have stricter formatting styles that are independent of IntelliJ's styles. If you are interested, please create a PR with the new styles and the maven configuration. Ideally, also add a step to the CI to check the styles.

[kulvait]

Thanks for the reply. If you can share your IDEA code style at .idea/codeStyles/Project.xml, I can try to convert it into a compatible eclipseStyle.xml and use that with Spotless. Alternatively, if IDEA allows you to export an eclipseStyle.xml directly, that would be even better since it should reflect your current setup more accurately.

For context, in my previous PR (zip store), I ended up limiting the changes to just the two files I modified. Due to limitations in my setup, I had to apply formatting as a post-processing step only on those files, using IDEA, to keep stylistic changes to a minimum.

Once the formatting is aligned, the downstream integration should be straightforward. However, some changes will likely be unavoidable, as the Eclipse stylesheet export is not fully precise and these formatting tools do not operate on a tokenized representation of the source. This can lead to inconsistencies in more complex constructs, such as nested lambda expressions or heavily structured code. As a result, the PR could touch a large portion of the codebase, even if the actual changes are minor e.g. a few whitespace or indentation adjustments per file.

Let me know what you think.