Required Parameters

Name	Type	Since	Description
buildDirectory	File	-	Base directory for all operations. Defaults to ${project.build.directory}. Default value is: ${project.build.directory}. User property is: proguard.builddir.
proguardOutputDirectory	File	-	Output directory for ProGuard files, such as the mapping file. Defaults to ${project.build.directory}/proguard. Default value is: ${project.build.directory}/proguard. User property is: proguard.output.

Optional Parameters

Name	Type	Since	Description
defaultOutputArtifactClassifier	String	-	Specifies the default output artifact Classifier. The default value is "small". Default value is: small.
dontattach	boolean	-	Set this to 'true' to bypass attaching any resulting artifacts Default value is: false. User property is: proguard.dontattach.
dontwarn	boolean	-	Tells ProGuard not to error out if there are unresolved references to classes or interfaces. Defaults to false Default value is: false.
excludeLibraryArtifacts	List	-	Coordinates of project dependencies which should be explicitly excluded from libraryjars. Note that this parameter has no effect if the parameter includeDependencies is set to false
excludeManifests	boolean	-	Automatically exclude via ProGuard filter the manifests from any injars. Note that if this is set to false, such a filter may still be included explicitly on any injar entry Default value is: true.
excludeMavenDescriptor	boolean	-	Set to false to include META-INF/maven/** Default value is: true.
ignoreIncludeFile	boolean	-	Set this to 'true' to disable the parameter proguardInclude Default value is: false. User property is: proguard.ignoreincludefile.
includeDependencies	boolean	-	Specifies that project compile dependencies should be automatically added as libraryjars Default value is: true.
includeJreRuntimeJar	boolean	-	Automatically adds the java runtime jar ${java.home}/lib/rt.jar to the ProGuard libraryjars. Defaults to true. Default value is: true.
injarNotExistsSkip	boolean	-	Set this to 'true' to bypass ProGuard processing if any injars entries do not exists Default value is: false.
inputArtifacts	List	-	This parameter will generate additional injars input entries to ProGuard from the project artifacts. Set the artifact names in coordinate String form, e.g. com.idfconnect.someproject:SomeLibrary to pull it from the project dependencies. The version does not need to be included in the String. The artifact must already be a resolved dependency in the project - the plugin will not attempt to resolve the artifact.
inputFile	String	-	Specifies the primary input file name (e.g. classes folder, jar, war, ear, zip, etc.) to be processed. This defaults to the typical output of the packaging phase, which is ${project.build.finalName}.${project.packaging}. However, if you are obfuscating before the packaging phase, you would typically want to set this to ${project.build.outputDirectory} instead to indicate the classes directory. If a relative path is specified, it will be relative to the base directory. Default value is: ${project.build.finalName}.${project.packaging}.
inputFileFilter	String	-	Specifies the ProGuard-syntax input filter to apply to the input file. Note that this only applies to the input file. It does not apply to other jars specified via inputArtifacts or inputJarPaths.
inputJarPaths	List	-	Additional external (e.g. non-artifact) input to include to Proguard as injars parameters. Note that the preferred way to include input is referencing dependent artifacts with the inputArtifacts element. You may optionally specify a ProGuard input filter at the end of each path
libraryArtifacts	List	-	A list of additional project artifacts, specified by coordinate Strings, e.g. javax.servlet:javax.servlet-api:3.0.1, to be included as libraryjars parameters to ProGuard. The version must be included in the coordinates. The plugin will attempt to resolve the artifact, so the artifact need not be a dependency in the project. Also note that by default all project resolved dependencies are already automatically added by the plugin and do not need to be explicitly configured with this parameter.
libraryJarPaths	List	-	Additional external (e.g. non-artifact) libraries to include to Proguard as libraryjars parameters, e.g. ${java.home}/lib/jsse.jar. Note that the preferred way to specify jars is referencing dependent artifacts with the libraryArtifacts element.
obfuscate	boolean	-	Specifies to obfuscate the input class files. Setting this to false sets the ProGuard option -dontobfuscate Default value is: true.
options	Map	-	Other arbitrary ProGuard configuration options
outJars	List	-	Explicitly sets the ProGuard outjars parameter, in addition to those values generated by the outputArtifacts element. If not specified, the default for outputArtifacts will be used
outputArtifacts	List	-	Specifies the output artifacts that ProGuard will produce. These are specified in the form of artifacts. If no output artifacts are specified, then the plugin will create a single default output artifact of the form ${project.build.finalName}-${project.version}-small.${project.packaging}. Note the default classifier: "small"
printMapping	boolean	-	Indicates whether printmapping should be specified. Defaults to true. Default value is: true.
printMappingAttachAsArtifact	boolean	-	Indicates whether the ProGuard printmapping file should be attached to the project as an artifact. Defaults to true. Default value is: true.
printMappingFile	String	-	Filename to use with printmapping. Defaults to proguard.map Default value is: proguard.map.
printSeeds	boolean	-	Indicates whether printseeds should be specified. Defaults to false. Default value is: false.
printSeedsAttachAsArtifact	boolean	-	Indicates whether the ProGuard printseeds file should be attached to the project as an artifact. Defaults to false. Default value is: false.
printSeedsFile	String	-	Filename to use with printseeds. Defaults to proguard.seeds Default value is: proguard.seeds.
proguardIncludeFile	String	-	Includes additional ProGuard configuration options from the provided file. This defaults to ${basedir}/src/main/config/${project.artifactId}-maven.pro. If no such file exists, the parameter is ignored. This behavior can be disabled by the parameter ignoreIncludeFile Default value is: ${basedir}/src/main/config/${project.artifactId}-maven.pro.
shrink	boolean	-	Specifies not to shrink the input class files. Setting this to false sets the ProGuard option -dontshrink Default value is: true.
skip	boolean	-	Set this to 'true' to bypass ProGuard processing entirely. Default value is: false. User property is: proguard.skip.
test	boolean	-	Set this to 'true' to test the plug-in without launching ProGuard. This will simply show you how the plug-in builds the ProGuard invocation arguments Default value is: false. User property is: proguard.test.
useDefaultOutputArtifactClassifiers	boolean	-	Indicates whether the output artifacts should have the default classifier appended to their filenames if they don't explicity set a classifier value. Default value is true. Default value is: true.

Parameter Details

buildDirectory:

• Type: java.io.File
• Required: Yes
• User Property: proguard.builddir
• Default: ${project.build.directory}

---

defaultOutputArtifactClassifier:

• Type: java.lang.String
• Required: No
• Default: small

---

dontattach:

• Type: boolean
• Required: No
• User Property: proguard.dontattach
• Default: false

---

dontwarn:

• Type: boolean
• Required: No
• Default: false

---

excludeLibraryArtifacts:

• Type: java.util.List
• Required: No

---

excludeManifests:

• Type: boolean
• Required: No
• Default: true

---

excludeMavenDescriptor:

• Type: boolean
• Required: No
• Default: true

---

ignoreIncludeFile:

• Type: boolean
• Required: No
• User Property: proguard.ignoreincludefile
• Default: false

---

includeDependencies:

• Type: boolean
• Required: No
• Default: true

---

includeJreRuntimeJar:

• Type: boolean
• Required: No
• Default: true

---

injarNotExistsSkip:

• Type: boolean
• Required: No
• Default: false

---

inputArtifacts:

• Type: java.util.List
• Required: No

---

inputFile:

• Type: java.lang.String
• Required: No
• Default: ${project.build.finalName}.${project.packaging}

---

inputFileFilter:

• Type: java.lang.String
• Required: No

---

inputJarPaths:

• Type: java.util.List
• Required: No

---

libraryArtifacts:

• Type: java.util.List
• Required: No

---

libraryJarPaths:

• Type: java.util.List
• Required: No

---

obfuscate:

• Type: boolean
• Required: No
• Default: true

---

options:

• Type: java.util.Map
• Required: No

---

outJars:

• Type: java.util.List
• Required: No

---

outputArtifacts:

• Type: java.util.List
• Required: No

---

printMapping:

• Type: boolean
• Required: No
• Default: true

---

printMappingAttachAsArtifact:

• Type: boolean
• Required: No
• Default: true

---

printMappingFile:

• Type: java.lang.String
• Required: No
• Default: proguard.map

---

printSeeds:

• Type: boolean
• Required: No
• Default: false

---

printSeedsAttachAsArtifact:

• Type: boolean
• Required: No
• Default: false

---

printSeedsFile:

• Type: java.lang.String
• Required: No
• Default: proguard.seeds

---

proguardIncludeFile:

• Type: java.lang.String
• Required: No
• Default: ${basedir}/src/main/config/${project.artifactId}-maven.pro

---

proguardOutputDirectory:

• Type: java.io.File
• Required: Yes
• User Property: proguard.output
• Default: ${project.build.directory}/proguard

---

shrink:

• Type: boolean
• Required: No
• Default: true

---

skip:

• Type: boolean
• Required: No
• User Property: proguard.skip
• Default: false

---

test:

• Type: boolean
• Required: No
• User Property: proguard.test
• Default: false

---

useDefaultOutputArtifactClassifiers:

• Type: boolean
• Required: No
• Default: true