How to exclude certain packages

[TomBeckett]

Hi all! 👋

We're using JOOQ in our project to generate sources as a package for example com.example.db. We love how JOOQ lets us write typesafe SQL and don't want to drop it.

Unfortunately it also flags as a cyclic dependency when running a basic test with spring-modulith:

    @Test
    void writeDocumentationSnippets() {
        final var modules = ApplicationModules.of(Application.class).verify();

        new Documenter(modules)
                .writeModulesAsPlantUml()
                .writeIndividualModulesAsPlantUml();
    }

Output

org.springframework.modulith.core.Violations: - Cycle detected: Slice auth ->   // Our code
                Slice tables ->  // JOOQ generated tables
                Slice auth // Our code

Is there a way we can ignore the com.example.db package entirely?

[odrotbohm]

ApplicationModules.of(…) has an overload that takes a DescribedPredicate<JavaClass> to filter types to ignore. Thus, an ApplicationModules.of(Application.class, JavaClass.Predicates.resideInAPackage("com.example.db")) should do the trick.

[humoyun-norboboev]

We have been experiencing the same problem, but the exclusion did not help. The version we use is spring-modulith-bom:1.0.0. Any ideas on what can be wrong?

[AquaGenLive]

@humoyun-norboboev I had a similar problem. I forgot to add the wildcard for all packages within the excluded package. Maybe instead of "com.example.db" you should try com.example.db...

The full documentation on how the matching works can be found in the PackageMatcher class.

[odrotbohm]

That's a helpful observation. Would you mind creating a ticket to ask for that to be clarified in the documentation?

[AquaGenLive]

Instead of describing that in a ticket, I thought it may be faster to open a PR for the doc: #550

[humoyun-norboboev]

@AquaGenLive com.example.db.. this one helped. Thanks!

[humoyun-norboboev]

@TomBeckett Could you please provide some details on how it solved the problem?