Skip to content

Commit

Permalink
Reinstate checkstyle for reference docs code snippets
Browse files Browse the repository at this point in the history
This commit also ensures that checks are performed before the
application is rendered to get early feedback on errors.
  • Loading branch information
bclozel committed Nov 25, 2022
1 parent 21d3a75 commit 8b110c9
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 2 additions & 4 deletions framework-docs/framework-docs.gradle
Expand Up @@ -18,10 +18,6 @@ dependencies {
implementation("org.assertj:assertj-core")
}

checkstyle {
sourceSets = []
}

jar {
enabled = false
}
Expand Down Expand Up @@ -128,6 +124,8 @@ asciidoctor {
}
}

asciidoctor.mustRunAfter "check"

/**
* Generate the Spring Framework Reference documentation from "src/docs/asciidoc"
* in "build/docs/ref-docs/pdf".
Expand Down
Expand Up @@ -39,9 +39,8 @@ class SampleReflectionRuntimeHintsTests {
void shouldRegisterReflectionHints() {
RuntimeHints runtimeHints = new RuntimeHints();
// Call a RuntimeHintsRegistrar that contributes hints like:
runtimeHints.reflection().registerType(SpringVersion.class, typeHint -> {
typeHint.withMethod("getVersion", List.of(), ExecutableMode.INVOKE);
});
runtimeHints.reflection().registerType(SpringVersion.class, typeHint ->
typeHint.withMethod("getVersion", List.of(), ExecutableMode.INVOKE));

// Invoke the relevant piece of code we want to test within a recording lambda
RuntimeHintsInvocations invocations = RuntimeHintsRecorder.record(() -> {
Expand Down
3 changes: 3 additions & 0 deletions src/checkstyle/checkstyle-suppressions.xml
Expand Up @@ -12,6 +12,9 @@
<!-- JMH benchmarks -->
<suppress files="[\\/]src[\\/]jmh[\\/]java[\\/]org[\\/]springframework[\\/]" checks="JavadocVariable|JavadocStyle|InnerTypeLast"/>

<!-- Framework docs -->
<suppress files="org[\\/]springframework[\\/]docs[\\/].+" checks="IllegalImport" id="bannedJUnitJupiterImports" />

<!-- spring-aop -->
<suppress files="[\\/]src[\\/]main[\\/]java[\\/]org[\\/]aopalliance[\\/]" checks="IllegalImport" id="bannedImports" message="javax"/>

Expand Down

0 comments on commit 8b110c9

Please sign in to comment.