formatter:format

Projects cache directory.

This file is a hash cache of the files in the project source. It can be preserved in source code such that it ensures builds are always fast by not unnecessarily writing files constantly. It can also be added to gitignore in case startup is not necessary. It further can be redirected to another location.

When stored in the repository, the cache if run on cross platforms will display the files multiple times due to line ending differences on the platform.

The cache itself has been part of formatter plugin for a long time but was hidden in target directory and did not survive clean phase when it should. This is not intended to be clean in that way as one would want as close to a no-op as possible when files are already all formatted and/or have not been otherwise touched. This is used based off the files in the project so it is as much part of the source as any other file is.

The cache can become invalid for any number of reasons that this plugin can't reasonably detect automatically. If you rely on the cache and make any changes to the project that could conceivably make the cache invalid, or if you notice that files aren't being reformatted when they should, just delete the cache and it will be rebuilt.

Java compiler compliance version.

Java compiler source version.

Java compiler target version.

File or classpath location of a properties file to use in css formatting.

File or classpath location of an Eclipse code formatter configuration xml file to use in formatting.

File or classpath location of a properties file to use in html formatting.

File or classpath location of an Eclipse code formatter configuration xml file to use in formatting.

File or classpath location of a properties file to use in json formatting.

File or classpath location of a properties file to use in xml formatting.

Location of the Java source files to format. Defaults to source main and test directories if not set. Deprecated in version 0.3. Reintroduced in 0.4.

The file encoding used to read and write source files. When not specified and sourceEncoding also not set, default is platform file encoding.

List of fileset patterns for Java source locations to exclude from formatting. Patterns are relative to the project source and test source directories. When not specified, there is no default exclude.

When set to true, the resources for the project are included in formatting. This includes both the main and test resources.

The included/excluded patterns for this plugin are honored as well as the included/excluded patterns from the resource itself.

List of fileset patterns for Java source locations to include in formatting. Patterns are relative to the project source and test source directories. When not specified, the default include is **/*.java

A java regular expression pattern that can be used to exclude some portions of the java code from being reformatted.

This can be useful when using DSL that embeds some kind of semantic hierarchy, where users can use various indentation level to increase the readability of the code. Those semantics are ignored by the formatter, so this regex pattern can be used to match certain portions of the code so that they will not be reformatted.

An example is the Apache Camel java DSL which can be used in the following way:

	from("seda:a").routeId("a")
			.log("routing at ${routeId}")
			.multicast()
				.to("seda:b")
				.to("seda:c")
			.end()
			.log("End of routing");

In the above example, the except can be skipped by the formatter by defining the following property in the formatter xml configuration:

  <javaExclusionPattern>\b(from\([^;]*\.end[^;]*?\)\));</javaExclusionPattern>

Sets the line-ending of files after formatting. Valid values are:

• "AUTO" - Use line endings of current system
• "KEEP" - Preserve line endings of files, default to AUTO if ambiguous
• "LF" - Use Unix and Mac style line endings
• "CRLF" - Use DOS and Windows style line endings
• "CR" - Use early Mac style line endings

When set to true, remove trailing whitespace on all lines after the formatter has finished.

Default to 'true' since 2.18.0

Whether the css formatting is skipped.

Whether the formatting is skipped.

Whether the formatting cache is skipped.

Whether the html formatting is skipped.

Whether the java formatting is skipped.

Whether the javascript formatting is skipped.

Whether the json formatting is skipped.

Whether the xml formatting is skipped.

Project's source directory as specified in the POM.

Project's test source directory as specified in the POM.

Use eclipse defaults when set to true for java and javascript.