Configuration reference

This reference is based on the 0.2.0 Mojo annotations/Javadocs and was verified with:

./mvnw -B -ntp help:describe \
  -Dplugin=io.github.quietly-official:quietly-maven-plugin:0.2.0 \
  -Ddetail

All parameters below are optional user parameters. Maven injects an additional required, read-only MavenProject internally; it is not user-configurable.

Parameter matrix

Package and naming parameters

basePackage

Use it as the stable root for package patterns:

<basePackage>com.acme.quietlydemo</basePackage>

If omitted, Quietly derives a legacy root per entity: it removes a trailing .model, otherwise it uses the entity package. basePackage does not itself restrict scanning.

entityPackagePattern

Exact package:

<entityPackagePattern>${basePackage}.model</entityPackagePattern>

Package and subpackages:

<entityPackagePattern>${basePackage}.model.*</entityPackagePattern>

Without this parameter, all compiled application @Entity classes visible in the current module output are eligible. ${basePackage} requires basePackage to be configured; otherwise Quietly rejects the configuration. An incorrect pattern commonly produces zero discovered entities.

servicePackagePattern

<servicePackagePattern>${basePackage}.services.rs</servicePackagePattern>

Without it, an entity in a package ending in .model maps to the corresponding .services.rs package. Other entity packages map to a nested .services.rs package. Configure this explicitly when the project does not follow that convention.

serviceNamePattern

<serviceNamePattern>${entitySimpleName}ServiceRs</serviceNamePattern>

${entitySimpleName} is replaced with the entity class name. The default uses the same pattern. Quietly loads the resulting class; it does not search for arbitrary REST resources.

Output parameters

testOutputDirectory

<testOutputDirectory>${project.build.directory}/generated-test-sources/quietly</testOutputDirectory>

Relative paths resolve from the current module base directory. Generation goals register this directory only when dryRun=false. Keep the lifecycle binding in the same Maven invocation that compiles tests.

reportFile

<reportFile>${project.build.directory}/quietly/filters-report.md</reportFile>

Relative paths resolve from the current module. A .json sibling is always derived from the Markdown path. If the configured name does not end in .md, Quietly appends .json to that name for the JSON report. CRUD uses a separate default report but will use a configured reportFile verbatim.

Generation controls

disabledByDefault

<disabledByDefault>true</disabledByDefault>

Adds @Disabled to generated methods. This is useful for onboarding, but it also means Maven will not execute those tests until they are enabled. The default is active tests (false).

failOnMissingService

<failOnMissingService>false</failOnMissingService>

With the default true, generation fails when a matching REST service is absent. With false, the entity/filter is skipped and reported. Relaxing this setting can make a build green while leaving generation incomplete.

failOnUnresolvedField

<failOnUnresolvedField>false</failOnUnresolvedField>

Only filter-tests uses this parameter. With false, unresolved filters are skipped and reported instead of failing the build. Prefer fixing metadata while keeping the default true.

dryRun

<dryRun>true</dryRun>

Generation goals still discover and report but do not write test files or register the test source directory. A dry-run therefore cannot prove compilation or runtime success. For filter generation, candidate methods use WOULD_GENERATE; CRUD report event wording is currently less specific, so use the absence of written source plus the logs/report details as the authority.

Diagnostic controls

fieldResolutionMode

<fieldResolutionMode>STRICT</fieldResolutionMode>

• STRICT requires one exact field name across the entity class hierarchy.
• FUZZY uses the closest name only when there is a unique best match and emits a warning.

Ambiguous exact or fuzzy matches remain unresolved. FUZZY is intended for diagnosing legacy naming, not as a default for new projects.

failOnProblems

<failOnProblems>true</failOnProblems>

Only doctor uses this parameter. Doctor writes its Markdown/JSON reports first, then fails Maven if the report has problem statuses. Use it when diagnostic readiness should gate CI.

Complete example

<configuration>
    <basePackage>com.acme.quietlydemo</basePackage>
    <entityPackagePattern>${basePackage}.model</entityPackagePattern>
    <servicePackagePattern>${basePackage}.services.rs</servicePackagePattern>
    <serviceNamePattern>${entitySimpleName}ServiceRs</serviceNamePattern>
    <testOutputDirectory>${project.build.directory}/generated-test-sources/quietly</testOutputDirectory>
    <reportFile>${project.build.directory}/quietly/filters-report.md</reportFile>
    <disabledByDefault>false</disabledByDefault>
    <failOnMissingService>true</failOnMissingService>
    <failOnUnresolvedField>true</failOnUnresolvedField>
    <fieldResolutionMode>STRICT</fieldResolutionMode>
    <dryRun>false</dryRun>
</configuration>

Do not copy every option without a reason. Start with explicit package conventions and keep safety defaults enabled.