Skip to content

Commit b9be117

Browse files
philwebbphilwebb
committed
Update checkstyle import-control.xml following restructure
Closes gh-47218
1 parent 8651e97 commit b9be117

File tree

1 file changed

+66
-87
lines changed

1 file changed

+66
-87
lines changed

‎config/checkstyle/import-control.xml‎

Lines changed: 66 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,40 @@
11
<?xml version="1.0"?>
22
<!DOCTYPE import-control PUBLIC "-//Checkstyle//DTD ImportControl Configuration 1.4//EN" "https://checkstyle.org/dtds/import_control_1_4.dtd">
33
<import-control pkg="org.springframework.boot">
4+
5+
<!-- Only use Micrometer Observation -->
46
<allow pkg="io.micrometer.observation" />
57
<disallow pkg="io.micrometer" />
8+
9+
<!-- Use JSpecify for nullability (not Spring) -->
610
<allow class="org.springframework.lang.Contract" />
711
<disallow pkg="org.springframework.lang" />
8-
<allow pkg=".*" regex="true" />
912

10-
<subpackage name="autoconfigure">
11-
<disallow class="org.springframework.boot.autoconfigure.jdbc.DataSourceProperties"/>
12-
<subpackage name="web">
13-
<allow pkg="org.springframework.boot.web.server" />
14-
<allow pkg="org.springframework.boot.web.servlet.server" />
15-
<disallow pkg="org.springframework.boot.web" />
16-
<disallow pkg="org.springframework.web.servlet" />
17-
<disallow pkg="org.springframework.web.reactive" />
18-
<disallow pkg="jakarta.servlet" />
19-
<subpackage name="client">
20-
<allow pkg="org.springframework.boot.web.client" />
21-
</subpackage>
22-
<subpackage name="server">
23-
<allow pkg="org.springframework.boot.web.server" />
24-
<subpackage name="reactive">
25-
<allow pkg="org.springframework.boot.web.reactive.server" />
26-
</subpackage>
27-
<subpackage name="servlet">
28-
<allow pkg="jakarta.servlet" />
29-
<allow pkg="org.springframework.boot.web.servlet" />
30-
<allow pkg="org.springframework.boot.web.error" />
31-
<allow pkg="org.springframework.web.servlet" />
32-
</subpackage>
33-
</subpackage>
34-
<subpackage name="servlet">
35-
<allow pkg="jakarta.servlet" />
36-
<allow pkg="org.springframework.boot.web.servlet" />
37-
<allow pkg="org.springframework.web.servlet" />
38-
<subpackage name="error">
39-
<allow pkg="org.springframework.boot.web.error" />
40-
</subpackage>
41-
</subpackage>
42-
<subpackage name="reactive">
43-
<allow pkg="org.springframework.boot.web.codec" />
44-
<allow pkg="org.springframework.boot.web.reactive" />
45-
<allow pkg="org.springframework.web.reactive" />
46-
<subpackage name="error">
47-
<allow pkg="org.springframework.boot.web.error" />
48-
</subpackage>
49-
</subpackage>
50-
</subpackage>
51-
</subpackage>
13+
<!-- Allow other imports -->
14+
<allow pkg=".*" regex="true" />
5215

16+
<!-- Open direct use of micrometer to specific subpackages -->
5317
<subpackage name="metrics">
5418
<allow pkg="io.micrometer" />
5519
</subpackage>
56-
5720
<subpackage name=".*\.metrics" regex="true">
5821
<allow pkg="io.micrometer" />
5922
</subpackage>
60-
6123
<subpackage name=".*\.autoconfigure" regex="true">
6224
<allow pkg="io.micrometer" />
6325
</subpackage>
64-
65-
<subpackage name="[^.]+\.actuate" regex="true">
66-
<subpackage name="endpoint">
67-
<file name=".*Endpoint(WebExtension)?" regex="true">
68-
<allow pkg="org.springframework.lang"/>
69-
</file>
70-
</subpackage>
26+
<subpackage name="docs">
27+
<allow pkg="io.micrometer" />
7128
</subpackage>
72-
73-
<subpackage name="actuate">
74-
<!-- Endpoint infrastructure -->
75-
<subpackage name="endpoint">
76-
<disallow pkg="org.springframework.http" />
77-
<disallow pkg="org.springframework.web" />
78-
<subpackage name="invoke">
79-
<subpackage name="reflect">
80-
<file name="OperationMethodParameter">
81-
<allow pkg="org.springframework.lang"/>
82-
</file>
83-
</subpackage>
84-
</subpackage>
85-
<subpackage name="web">
86-
<allow pkg="org.springframework.http" />
87-
<allow pkg="org.springframework.web" />
88-
<subpackage name="servlet">
89-
<disallow pkg="org.springframework.web.reactive" />
90-
</subpackage>
91-
<subpackage name="reactive">
92-
<disallow pkg="org.springframework.web.servlet" />
93-
</subpackage>
29+
<subpackage name="test">
30+
<subpackage name="autoconfigure">
31+
<subpackage name="actuate">
32+
<allow pkg="io.micrometer" />
9433
</subpackage>
9534
</subpackage>
9635
</subpackage>
9736

98-
<subpackage name="docs">
99-
<allow pkg="io.micrometer" />
100-
</subpackage>
101-
102-
<!-- Logging -->
37+
<!-- Keep logging focused on lower level packages (binding and AOT) -->
10338
<subpackage name="logging">
10439
<allow pkg="org.springframework.boot.context.properties" />
10540
<allow pkg="org.springframework.boot.context.properties.bind" />
@@ -108,14 +43,6 @@
10843
<disallow pkg="org.springframework.boot.context" />
10944
</subpackage>
11045

111-
<subpackage name="test">
112-
<subpackage name="autoconfigure">
113-
<subpackage name="actuate">
114-
<allow pkg="io.micrometer" />
115-
</subpackage>
116-
</subpackage>
117-
</subpackage>
118-
11946
<!-- Web related concerns -->
12047
<subpackage name="web">
12148

@@ -208,4 +135,56 @@
208135

209136
</subpackage>
210137

138+
<!-- Actuator endpoint infrastructure -->
139+
<subpackage name="actuate">
140+
<subpackage name="endpoint">
141+
<disallow pkg="org.springframework.http" />
142+
<disallow pkg="org.springframework.web" />
143+
<subpackage name="web">
144+
<allow pkg="org.springframework.http" />
145+
<allow pkg="org.springframework.web" />
146+
<subpackage name="servlet">
147+
<disallow pkg="org.springframework.web.reactive" />
148+
</subpackage>
149+
<subpackage name="reactive">
150+
<disallow pkg="org.springframework.web.servlet" />
151+
</subpackage>
152+
</subpackage>
153+
</subpackage>
154+
</subpackage>
155+
156+
<!-- Web Servers -->
157+
<subpackage name="tomcat|undertow|jetty|reactor" regex="true">
158+
<allow pkg="org.springframework.boot.web.server" />
159+
<disallow pkg="org.springframework.boot.web" />
160+
<disallow pkg="org.springframework.web.servlet" />
161+
<disallow pkg="org.springframework.web.reactive" />
162+
<subpackage name="servlet">
163+
<allow pkg="jakarta.servlet" />
164+
<allow pkg="org.springframework.boot.web.server" />
165+
<allow pkg="org.springframework.boot.web.servlet" />
166+
<allow pkg="org.springframework.boot.web.error" />
167+
<allow pkg="org.springframework.web.servlet" />
168+
</subpackage>
169+
<subpackage name="reactive">
170+
<allow pkg="org.springframework.boot.web.server" />
171+
<allow pkg="org.springframework.boot.web.codec" />
172+
<allow pkg="org.springframework.boot.web.reactive" />
173+
<allow pkg="org.springframework.web.reactive" />
174+
</subpackage>
175+
<subpackage name="autoconfigure">
176+
<subpackage name="servlet">
177+
<allow pkg="jakarta.servlet" />
178+
<allow pkg="org.springframework.boot.web.servlet" />
179+
<allow pkg="org.springframework.boot.web.error" />
180+
<allow pkg="org.springframework.web.servlet" />
181+
</subpackage>
182+
<subpackage name="reactive">
183+
<allow pkg="org.springframework.boot.web.codec" />
184+
<allow pkg="org.springframework.boot.web.reactive" />
185+
<allow pkg="org.springframework.web.reactive" />
186+
</subpackage>
187+
</subpackage>
188+
</subpackage>
189+
211190
</import-control>

0 commit comments

Comments
 (0)