Scripting Bundle Maven Plugin – scriptingbundle:metadata

scriptingbundle:metadata

Full name:

org.apache.sling:scriptingbundle-maven-plugin:0.5.0:metadata

Description:

The metadata goal will generate two Maven project properties, namely org.apache.sling.scriptingbundle.maven.plugin.Require-Capability and org.apache.sling.scriptingbundle.maven.plugin.Provide-Capability which can be used to generate the corresponding OSGi bundle headers for bundles providing scripts executable by a ScriptEngine.

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: prepare-package.

Optional Parameters

Name	Type	Since	Description
`<excludes>`	`String[]`	`0.2.0`	Allows defining a list of excluded files and folders or patterns to filter which files should be excluded in the analysis for generating capabilities. The following list provides the default excluded files and patterns: Miscellaneous typical temporary files */~, */##, */.#, */%%, */._ CVS /CVS, /CVS/, /.cvsignore Subversion /.svn, /.svn/ Bazaar /.bzr, /.bzr/ Mac /.DS_Store Mercurial /.hg, /.hg/ git /.git, /.git/ User property is**: `scriptingbundle.excludes`.
`<includes>`	`String[]`	`0.2.0`	Allows defining a list of included files and folders or patterns to filter which files should be included in the analysis for generating capabilities. By default all files are included. Default value is: ``. User property is**: `scriptingbundle.includes`.
`<missingRequirementsOptional>`	`boolean`	`0.5.0`	When set to "true", the requirements which are not satisfied directly by this project will be marked as optional. Default value is: `true`. User property is: `scriptingbundle.missingRequirementsOptional`.
`<scriptEngineMappings>`	`Map`	`0.2.0`	Allows overriding the default extension to script engine mapping, in order to correctly generate the `sling.resourceType;scriptEngine` `Provide-Capability` attribute value. When configuring this mapping, please make sure to use the script extension as the key and one of the Script Engine's names (obtained from `ScriptEngineFactory.getNames()`) as the value. The following list represents the default extension to Script Engine mapping: ftl freemarker gst gstring html htl java java esp, ecma rhino jsp, jspf, jspx jsp
`<searchPaths>`	`Set`	`0.2.0`	Allows overriding the default search paths (`/apps` and `/libs`). When scripts are organised in folders which follow the search path structure, the Mojo will generate two resource types for each resource type folder. For example: src/main/scripts/apps/org/apache/sling/example/example.html will generate the following two resource types org/apache/sling/example /apps/org/apache/sling/example However, the following script src/main/scripts/org/apache/sling/example/example.html will generate only one resource type org/apache/sling/example User property is: `scriptingbundle.searchPaths`.
`<sourceDirectories>`	`Set`	`0.2.0`	Defines where this goal will look for scripts in the project. By default the `src/main/scripts` and `src/main/resources/javax.script` folders will be considered. User property is: `scriptingbundle.sourceDirectories`.

Parameter Details

<excludes>

Allows defining a list of excluded files and folders or patterns to filter which files should be excluded in the analysis for generating capabilities.

The following list provides the default excluded files and patterns:

Miscellaneous typical temporary files: **/*~, **/#*#, **/.#*, **/%*%, **/._*
CVS: **/CVS, **/CVS/**, **/.cvsignore
Subversion: **/.svn, **/.svn/**
Bazaar: **/.bzr, **/.bzr/**
Mac: **/.DS_Store
Mercurial: **/.hg, **/.hg/**
git: **/.git, **/.git/**

Type: java.lang.String[]
Since: 0.2.0
Required: No
User Property: scriptingbundle.excludes

<includes>

Allows defining a list of included files and folders or patterns to filter which files should be included in the analysis for generating capabilities. By default all files are included.

Type: java.lang.String[]
Since: 0.2.0
Required: No
User Property: scriptingbundle.includes
Default: **

<missingRequirementsOptional>

When set to "true", the requirements which are not satisfied directly by this project will be marked as optional.

Type: boolean
Since: 0.5.0
Required: No
User Property: scriptingbundle.missingRequirementsOptional
Default: true

<scriptEngineMappings>

Allows overriding the default extension to script engine mapping, in order to correctly generate the sling.resourceType;scriptEngine Provide-Capability attribute value. When configuring this mapping, please make sure to use the script extension as the key and one of the Script Engine's names (obtained from ScriptEngineFactory.getNames()) as the value.

The following list represents the default extension to Script Engine mapping:

ftl: freemarker
gst: gstring
html: htl
java: java
esp, ecma: rhino
jsp, jspf, jspx: jsp

Type: java.util.Map
Since: 0.2.0
Required: No

<searchPaths>

Allows overriding the default search paths (/apps and /libs). When scripts are organised in folders which follow the search path structure, the Mojo will generate two resource types for each resource type folder. For example:

    src/main/scripts/apps/org/apache/sling/example/example.html

will generate the following two resource types

    org/apache/sling/example
    /apps/org/apache/sling/example

However, the following script

    src/main/scripts/org/apache/sling/example/example.html

will generate only one resource type

    org/apache/sling/example

Type: java.util.Set
Since: 0.2.0
Required: No
User Property: scriptingbundle.searchPaths

<sourceDirectories>

Defines where this goal will look for scripts in the project. By default the src/main/scripts and src/main/resources/javax.script folders will be considered.

Type: java.util.Set
Since: 0.2.0
Required: No
User Property: scriptingbundle.sourceDirectories