Scalor Maven Plugin 2.12 – scalor:eclipse-format

scalor:eclipse-format

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:eclipse-format

Description:

Transfer source format settings from Maven to Eclipse. Requires goal=eclipse-config.

Attributes:

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

Optional Parameters

Name	Type	Since	Description
`<eclipseDetectPresent>`	`boolean`	`-`	Invoke Eclipse executions only when runnting inside Eclipse/M2E. When `false`, force executions regardless of the Eclipse detection state. Default value is: `true`. User property is: `scalor.eclipseDetectPresent`.
`<eclipseFormatEnable>`	`boolean`	`-`	Enable to transfer source format settings from Maven to Eclipse. Default value is: `true`. User property is: `scalor.eclipseFormatEnable`.
`<eclipseFormatLogParameters>`	`boolean`	`-`	Enable to log in Eclipse/M2E effective configuration parameters for this Maven execution. Default value is: `false`. User property is: `scalor.eclipseFormatLogParameters`.
`<formatJavaEnable>`	`boolean`	`-`	Java formatter enablement parameter. Enable formatter invocation in Maven. Enable formatter settings transfer in Eclipse. Default value is: `true`. User property is: `scalor.formatJavaEnable`.
`<formatJavaSettings>`	`String`	`-`	Java formatter (org.eclipse.jdt.core) configuration file. Relative path to `${project.basedir}`. Settings reference. Normally located in Maven project configuration folder `.mvn`. Applied to Eclipse JDT with goal=eclipse-format. Default value is: `.mvn/format-java.xml`. User property is: `scalor.formatJavaSettings`.
`<formatParentLookup>`	`boolean`	`-`	Enable format configuration file lookup in parents of multi-module projects. In each project canditate, plugin will check for existence of relevant files: formatJavaSettings, formatScalaSettings. Default value is: `true`. User property is: `scalor.formatParentLookup`.
`<formatScalaEnable>`	`boolean`	`-`	Scala formatter enablement parameter. Enable formatter invocation in Maven. Enable formatter settings transfer in Eclipse. Default value is: `true`. User property is: `scalor.formatScalaEnable`.
`<formatScalaSettings>`	`String`	`-`	Scala formatter (scala-ide/scalariform) configuration file. Relative path to `${project.basedir}`. Settings reference. Normally located in Maven project configuration folder `.mvn`. Applied to Scala IDE with goal=eclipse-format. Default value is: `.mvn/format-scala.props`. User property is: `scalor.formatScalaSettings`.
`<formatSourceEncoding>`	`String`	`-`	Charset for source file reading and writing. Default value is: `UTF-8`. User property is: `scalor.formatSourceEncoding`.
`<skip>`	`boolean`	`-`	Force to skip all executions of this plugin. Default value is: `false`. User property is: `scalor.skip`.
`<skipEclipse>`	`boolean`	`-`	Flag to skip goal execution: `eclipse-`. Default value is: `false`. User property is*: `scalor.skipEclipse`.
`<skipLogReason>`	`boolean`	`-`	Enable logging of reason for skipping an execution. Default value is: `true`. User property is: `scalor.skipLogReason`.
`<skipPackagingList>`	`String[]`	`-`	List of packaging types, which are skipped by this plugin. Default value is: `pom`. User property is: `scalor.skipPackagingList`.

Parameter Details

<eclipseDetectPresent>

Invoke Eclipse executions only when runnting inside Eclipse/M2E. When false, force executions regardless of the Eclipse detection state.

Type: boolean
Required: No
User Property: scalor.eclipseDetectPresent
Default: true

<eclipseFormatEnable>

Enable to transfer source format settings from Maven to Eclipse.

Type: boolean
Required: No
User Property: scalor.eclipseFormatEnable
Default: true

<eclipseFormatLogParameters>

Enable to log in Eclipse/M2E effective configuration parameters for this Maven execution.

Type: boolean
Required: No
User Property: scalor.eclipseFormatLogParameters
Default: false

<formatJavaEnable>

Java formatter enablement parameter. Enable formatter invocation in Maven. Enable formatter settings transfer in Eclipse.

Type: boolean
Required: No
User Property: scalor.formatJavaEnable
Default: true

Java formatter (org.eclipse.jdt.core) configuration file. Relative path to ${project.basedir}. Settings reference. Normally located in Maven project configuration folder .mvn. Applied to Eclipse JDT with goal=eclipse-format.

Type: java.lang.String
Required: No
User Property: scalor.formatJavaSettings
Default: .mvn/format-java.xml

<formatParentLookup>

Enable format configuration file lookup in parents of multi-module projects. In each project canditate, plugin will check for existence of relevant files: formatJavaSettings, formatScalaSettings.

Type: boolean
Required: No
User Property: scalor.formatParentLookup
Default: true

<formatScalaEnable>

Scala formatter enablement parameter. Enable formatter invocation in Maven. Enable formatter settings transfer in Eclipse.

Type: boolean
Required: No
User Property: scalor.formatScalaEnable
Default: true

<formatScalaSettings>

Scala formatter (scala-ide/scalariform) configuration file. Relative path to ${project.basedir}. Settings reference. Normally located in Maven project configuration folder .mvn. Applied to Scala IDE with goal=eclipse-format.

Type: java.lang.String
Required: No
User Property: scalor.formatScalaSettings
Default: .mvn/format-scala.props

<formatSourceEncoding>

Charset for source file reading and writing.

Type: java.lang.String
Required: No
User Property: scalor.formatSourceEncoding
Default: UTF-8

<skip>

Force to skip all executions of this plugin.

Type: boolean
Required: No
User Property: scalor.skip
Default: false

<skipEclipse>

Flag to skip goal execution: eclipse-*.

Type: boolean
Required: No
User Property: scalor.skipEclipse
Default: false

<skipLogReason>

Enable logging of reason for skipping an execution.

Type: boolean
Required: No
User Property: scalor.skipLogReason
Default: true

<skipPackagingList>

List of packaging types, which are skipped by this plugin.

Type: java.lang.String[]
Required: No
User Property: scalor.skipPackagingList
Default: pom