bom:strip

Full name:

org.kuali.maven.plugins:bom-maven-plugin:1.0.3:strip

Description:

Goal to detect and strip BOM's from files. Any file where the first bytes of the file match the byte sequences EFBBBF, FEFF, or FFFE will produce a positive match. The files will be re-written containing the exact same contents but without the BOM bytes.

Attributes:

  • Binds by default to the lifecycle phase: process-sources.

Optional Parameters

Name Type Since Description
directory File - The directory to recursively scan for files containing BOM's
Default value is: ${project.basedir}.
excludes String[] - Exclusion patterns. By default no files (other than those matching the default excludes) are excluded
failBuild boolean - If true, the Maven build will fail if a BOM is detected
Default value is: false.
includes String[] - Inclusion patterns. By default, all files are included
strip boolean - If true, any file where a BOM is detected has its BOM stripped out.
Default value is: true.
useDefaultExcludes boolean - Flag indicating whether or not to use the default exclude patterns. These are known patterns like **/.svn/* and **/*.jar See the DEFAULT_EXCLUDES field in the SimpleScanner class for the exact list of default excludes.
Default value is: true.
workingDir File - Directory where a backup copy of any file having its BOM removed is created
Default value is: ${project.build.directory}/bom.

Parameter Details

directory:

The directory to recursively scan for files containing BOM's
  • Type: java.io.File
  • Required: No
  • Expression: ${bom.directory}
  • Default: ${project.basedir}

excludes:

Exclusion patterns. By default no files (other than those matching the default excludes) are excluded
  • Type: java.lang.String[]
  • Required: No

failBuild:

If true, the Maven build will fail if a BOM is detected
  • Type: boolean
  • Required: No
  • Expression: ${bom.failBuild}
  • Default: false

includes:

Inclusion patterns. By default, all files are included
  • Type: java.lang.String[]
  • Required: No

strip:

If true, any file where a BOM is detected has its BOM stripped out.
  • Type: boolean
  • Required: No
  • Expression: ${bom.strip}
  • Default: true

useDefaultExcludes:

Flag indicating whether or not to use the default exclude patterns. These are known patterns like **/.svn/* and **/*.jar See the DEFAULT_EXCLUDES field in the SimpleScanner class for the exact list of default excludes.
  • Type: boolean
  • Required: No
  • Expression: ${bom.useDefaultExcludes}
  • Default: true

workingDir:

Directory where a backup copy of any file having its BOM removed is created
  • Type: java.io.File
  • Required: No
  • Expression: ${bom.workingDir}
  • Default: ${project.build.directory}/bom