Skip to content
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.

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

sort module-info #643

Open
xenoterracide opened this issue Feb 13, 2024 · 0 comments
Open

sort module-info #643

xenoterracide opened this issue Feb 13, 2024 · 0 comments

Comments

@xenoterracide
Copy link

xenoterracide commented Feb 13, 2024

Prettier-Java 2.5.0

Input:

module com.xenoterracide.tools.java {
  exports com.xenoterracide.tools0.java.function;
  exports com.xenoterracide.tools0.java.annotation;
  requires java.base;
  requires jakarta.annotation;
}

Output:

module com.xenoterracide.tools.java {
  exports com.xenoterracide.tools0.java.function;
  exports com.xenoterracide.tools0.java.annotation;
  requires java.base;
  requires jakarta.annotation;
}

Expected behavior:

some kind of sorting, for convienience, like sorting imports. Note: I don't think functionally the order matters, but I've linked the JLS spec in case it defines it. It does seem to show an order (that's not alphabetic only). Also I don't have an opinion other than it should sort and should conform to JLS.

I'll be honest, I haven't really read this spec, so please verify my output conforms.. but it looks like it should be as follows. Obviously my example is not comprehensive https://docs.oracle.com/javase/specs/jls/se9/html/jls-7.html#jls-7.7

module com.xenoterracide.tools.java {
  requires jakarta.annotation;
  requires java.base;
  exports com.xenoterracide.tools0.java.annotation;
  exports com.xenoterracide.tools0.java.function;
}

note: I think it's acceptable just to make this an alpha sort with some grouping, e.g. requires and requires static and requires transient are different groups. requires stuff shouldn't be mixed next to requires static. This is currently one of my most complex examples.

import org.jspecify.annotations.NullMarked;

/**
 * JPA utilities.
 */
@NullMarked module com.xenoterracide.commons.jpa {
  exports com.xenoterracide.commons.jpa;
  exports com.xenoterracide.commons.jpa.annotation;
  exports com.xenoterracide.commons.jpa.util;
  exports com.xenoterracide.commons.jpa.transaction to spring.beans, spring.context;

  opens com.xenoterracide.commons.jpa to org.hibernate.orm.core, spring.core, org.hibernate.validator;
  opens com.xenoterracide.commons.jpa.transaction to spring.core;

  requires org.apache.commons.lang3;
  requires spring.data.commons;
  requires spring.beans;
  requires spring.context;
  requires spring.tx;
  requires org.hibernate.orm.envers;

  requires static org.jspecify;
  requires static com.xenoterracide.tools.java;
  requires static jakarta.annotation;
  requires static org.jmolecules.architecture.layered;

  requires transitive jakarta.persistence;
  requires transitive jakarta.validation;
  requires transitive com.xenoterracide.model;
  requires org.jmolecules.ddd;
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant