feat(#174660): add new code conventions rules by kirill-pyatunin · Pull Request #1 · clutcher/spring-modulith-module-archunit

kirill-pyatunin · 2026-03-18T10:00:45Z

No description provided.

kirill-pyatunin · 2026-04-23T10:18:22Z


    String getApplicationRoot();
+
+    default String getDomainModelPackageMatcher() {


check. it should already exists in configs

kirill-pyatunin · 2026-04-23T10:24:10Z

+                .allowEmptyShould(true);
+    }
+
+    public static ArchRule ruleForCrossModuleDomainIsolation(String moduleBasePackage, HexagonalArchitectureSettings properties) {


kirill-pyatunin · 2026-04-23T10:28:16Z

+                .allowEmptyShould(true);
+    }
+
+    public static ArchRule ruleForDomainModelNotExposedInDrivingAdapters(String moduleBasePackage, HexagonalArchitectureSettings properties) {


Check rule *Test that domain.model is not used to be returned from in rest controller - only for controllers

*Mapper class
mappers package?

kirill-pyatunin · 2026-04-23T10:31:14Z

+                .allowEmptyShould(true);
+    }
+
+    static DescribedPredicate<JavaClass> areNotAnnotatedWithAnyOf(String[] annotationNames) {


not arch rule - move

kirill-pyatunin · 2026-04-23T10:34:25Z

+                moduleBasePackage + properties.getDomainModelPackageMatcher(),
+                "java..",
+                "lombok..",
+                "org.springframework.stereotype..",


too wide. component and service

kirill-pyatunin · 2026-04-23T10:36:42Z

+        };
+    }
+
+    public static ArchRule ruleForNoAutowiredInDomain(String moduleBasePackage, HexagonalArchitectureSettings properties) {


kirill-pyatunin · 2026-04-23T10:37:11Z

+                .allowEmptyShould(true);
+    }
+
+    public static ArchRule ruleForNoAutowiredFieldsInDomain(String moduleBasePackage, HexagonalArchitectureSettings properties) {


kirill-pyatunin · 2026-04-23T10:38:54Z

+                .allowEmptyShould(true);
+    }
+
+    public static ArchRule ruleForDomainModelOnlyRecordsOrPojos(String moduleBasePackage, HexagonalArchitectureSettings properties) {


should check records or pojos

kirill-pyatunin · 2026-04-23T10:49:33Z

+                .allowEmptyShould(true);
+    }
+
+    public static ArchRule ruleForSpringAdapterNaming(String moduleBasePackage, HexagonalArchitectureSettings properties) {


kirill-pyatunin · 2026-04-23T10:54:40Z

+    }
+
+
+    // --- Custom ArchConditions ---


move ArchConditions

kirill-pyatunin · 2026-04-23T10:56:39Z

+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.fields;
+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;
+
+public class CodeConventionsRulesLibrary {


create interface.
Create property to allow on/off or redefine rules, add rule

id rule = true / false, true by default (exmpl)

kirill-pyatunin · 2026-04-23T10:58:23Z

@@ -0,0 +1,24 @@
+dev:


kirill-pyatunin · 2026-04-23T11:01:28Z

-extra["springBootVersion"] = "3.5.3"
+extra["springModulithVersion"] = "2.0.3"
+extra["springBootVersion"] = "4.0.2"
 extra["archUnitVersion"] = "1.4.1"


clutcher · 2026-06-26T12:11:52Z

+    public static ArchRule ruleForNoDtoInClassNames(String domainPackage) {
+        return noClasses()
+                .that().resideInAPackage(domainPackage)
+                .should().haveSimpleNameContaining("Dto")


Is it case sensitive? Suppose we should check DTO also? And what about Data? Suppose we should exclued that also.

clutcher · 2026-06-26T12:17:57Z

+        return classes()
+                .that().resideInAPackage(moduleBasePackage + properties.getDomainModelPackageMatcher())
+                .should().onlyDependOnClassesThat()
+                .resideInAnyPackage(allPackages)


Is it working properly? Does it allow to use domain classes inside domain itself?

clutcher · 2026-06-26T12:18:48Z

+        String domainModelPackage = moduleBasePackage + properties.getDomainModelPackageMatcher();
+        return classes()
+                .that().areAnnotatedWith("org.springframework.web.bind.annotation.RestController")
+                .or().areAnnotatedWith("org.springframework.stereotype.Controller")


Does it also covers graphql controllers?

clutcher · 2026-06-26T12:20:00Z

+    public static ArchRule ruleForDomainModelOnlyRecordsOrPojos(String moduleBasePackage, HexagonalArchitectureSettings properties) {
+        return classes()
+                .that().resideInAPackage(moduleBasePackage + properties.getDomainModelPackageMatcher())
+                .should().notBeInterfaces()


It is wrongly working. Pojo is a specific class with fields and getter/setter naming convention. Checkin on not interface is not enough.

clutcher · 2026-06-26T12:24:50Z


    ApiForCustomizingArchRuleCreation withDevStandardsRule(RuleProvider provider);

+    ApiForCustomizingArchRuleCreation withCodeConventionsRule(ApiForArchRuleCreation apiForArchRuleCreation);


Can you remind me difference between dev standards rules and code convetion rules? Looks same for me.

Also we need to update both readme and claude with all new changes.

feat(#174660): add new code conventions rules

119dc57

kirill-pyatunin commented Apr 23, 2026

View reviewed changes

Kirill Pyatunin added 4 commits May 14, 2026 22:09

refactor(#174660): simplify rules

aa57225

refactor(#174660): simplify rules

94d2c74

refactor(#174660): change rules toggling

c58071e

refactor(#174660): simplify rules

5d41d3a

kirill-pyatunin force-pushed the 174660 branch from fe549ec to 5d41d3a Compare May 26, 2026 01:40

clutcher reviewed Jun 26, 2026

View reviewed changes

refactor(#174660): resolve comments

1f7bbcd


		String getApplicationRoot();

		default String getDomainModelPackageMatcher() {


		ApiForCustomizingArchRuleCreation withDevStandardsRule(RuleProvider provider);

		ApiForCustomizingArchRuleCreation withCodeConventionsRule(ApiForArchRuleCreation apiForArchRuleCreation);

Conversation

kirill-pyatunin commented Mar 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirill-pyatunin Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirill-pyatunin Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirill-pyatunin Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirill-pyatunin Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kirill-pyatunin Apr 23, 2026 •

edited

Loading

kirill-pyatunin Apr 23, 2026 •

edited

Loading

kirill-pyatunin Apr 23, 2026 •

edited

Loading

kirill-pyatunin Apr 23, 2026 •

edited

Loading