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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotless-plugin-gradle Show documentation

Spotless - keep your code spotless with Gradle

The newest version!

/*
 * Copyright 2016-2024 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 static com.diffplug.gradle.spotless.PluginGradlePreconditions.requireElementsNonNull;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.TreeMap;

import javax.inject.Inject;

import org.gradle.api.Action;

import com.diffplug.spotless.FormatterProperties;
import com.diffplug.spotless.markdown.FreshMarkStep;

public class FreshMarkExtension extends FormatExtension {
	static final String NAME = "freshmark";

	public final List>> propertyActions = new ArrayList<>();

	@Inject
	public FreshMarkExtension(SpotlessExtension spotless) {
		super(spotless);
		addStep(FreshMarkStep.create(Map.of(), provisioner()));
	}

	public void properties(Action> action) {
		propertyActions.add(Objects.requireNonNull(action));
	}

	public void propertiesFile(Object... files) {
		requireElementsNonNull(files);
		propertyActions.add(map -> {
			FormatterProperties preferences = FormatterProperties.from(getProject().files(files));
			/* FreshMarkStep.State serializes the properties and not the files.
			 * Therefore they must be stored in a hash-map like used by Properties.*/
			preferences.getProperties().forEach((key, value) -> map.put(key.toString(), value));
		});
	}

	@Override
	protected void setupTask(SpotlessTask task) {
		// defaults to all markdown files
		if (target == null) {
			throw noDefaultTargetException();
		}
		// replace the step
		TreeMap props = new TreeMap<>();
		propertyActions.forEach(action -> action.execute(props));
		replaceStep(FreshMarkStep.create(props, provisioner()));
		super.setupTask(task);
	}
}