com.diffplug.gradle.spotless.SpotlessExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotless Show documentation
Spotless - keep your code spotless with Gradle
There is a newer version: 2.4.1
/*
 * Copyright 2015 DiffPlug
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.diffplug.gradle.spotless;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.function.Consumer;

import org.gradle.api.GradleException;
import org.gradle.api.Project;

import com.diffplug.gradle.spotless.freshmark.FreshMarkExtension;
import com.diffplug.gradle.spotless.java.JavaExtension;
import groovy.lang.Closure;

public class SpotlessExtension {
	final Project project;

	public SpotlessExtension(Project project) {
		this.project = project;
	}

	/** Line endings (if any). */
	LineEnding lineEndings = LineEnding.PLATFORM_NATIVE;

	public LineEnding getLineEndings() {
		return lineEndings;
	}

	public void setLineEndings(LineEnding lineEndings) {
		this.lineEndings = lineEndings;
	}

	Map formats = new LinkedHashMap<>();

	/** Configures the special java-specific extension. */
	public void java(Closure closure) {
		JavaExtension java = new JavaExtension(this);
		closure.setDelegate(java);
		closure.call();
	}

	/** Configures the special java-specific extension. */
	public void java(Consumer closure) {
		JavaExtension java = new JavaExtension(this);
		closure.accept(java);
	}

	/** Configures the special freshmark-specific extension. */
	public void freshmark(Closure closure) {
		FreshMarkExtension freshmark = new FreshMarkExtension(this);
		closure.setDelegate(freshmark);
		closure.call();
	}

	/** Configures the special freshmark-specific extension. */
	public void freshmark(Consumer closure) {
		FreshMarkExtension freshmark = new FreshMarkExtension(this);
		closure.accept(freshmark);
	}

	/** Configures a custom extension. */
	public void format(String name, Closure closure) {
		FormatExtension extension = new FormatExtension(name, this);
		closure.setDelegate(extension);
		closure.call();
	}

	/** Configures a custom extension. */
	public void format(String name, Consumer closure) {
		FormatExtension extension = new FormatExtension(name, this);
		closure.accept(extension);
	}

	/** Called by the FormatExtension constructor. */
	void addFormatExtension(FormatExtension extension) {
		FormatExtension former = formats.put(extension.name, extension);
		if (former != null) {
			throw new GradleException("Multiple spotless extensions with name '" + extension.name + "'");
		}
	}
}