com.diffplug.spotless.maven.generic.Prettier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotless-maven-plugin Show documentation
Spotless - keep your code spotless with Gradle
There is a newer version: 2.44.0.BETA4
Show newest version
/*
 * Copyright 2016-2023 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.spotless.maven.generic;

import java.io.File;
import java.util.*;
import java.util.stream.Collectors;

import org.apache.maven.plugins.annotations.Parameter;

import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.maven.FormatterStepConfig;
import com.diffplug.spotless.maven.npm.AbstractNpmFormatterStepFactory;
import com.diffplug.spotless.npm.NpmPathResolver;
import com.diffplug.spotless.npm.PrettierConfig;
import com.diffplug.spotless.npm.PrettierFormatterStep;

public class Prettier extends AbstractNpmFormatterStepFactory {

	public static final String ERROR_MESSAGE_ONLY_ONE_CONFIG = "must specify exactly one prettierVersion, devDependencies or devDependencyProperties";

	@Parameter
	private String prettierVersion;

	@Parameter
	private Map devDependencies;

	@Parameter
	private Properties devDependencyProperties;

	@Parameter
	private Map config;

	@Parameter
	private String configFile;

	@Override
	public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {

		// check if config is only setup in one way
		if (moreThanOneNonNull(this.prettierVersion, this.devDependencies, this.devDependencyProperties)) {
			throw onlyOneConfig();
		}
		if (devDependencies == null) {
			devDependencies = PrettierFormatterStep.defaultDevDependencies(); // fallback
		}

		if (prettierVersion != null && !prettierVersion.isEmpty()) {
			this.devDependencies = PrettierFormatterStep.defaultDevDependenciesWithPrettier(prettierVersion);
		} else if (devDependencyProperties != null) {
			this.devDependencies = propertiesAsMap(this.devDependencyProperties);
		}

		// process config file or inline config
		File configFileHandler;
		if (this.configFile != null) {
			configFileHandler = stepConfig.getFileLocator().locateFile(this.configFile);
		} else {
			configFileHandler = null;
		}

		Map configInline;
		if (config != null) {
			configInline = config.entrySet().stream()
					.map(entry -> {
						try {
							Integer value = Integer.parseInt(entry.getValue());
							return new AbstractMap.SimpleEntry<>(entry.getKey(), value);
						} catch (NumberFormatException ignore) {
							// ignored
						}
						if (Boolean.TRUE.toString().equalsIgnoreCase(entry.getValue()) || Boolean.FALSE.toString().equalsIgnoreCase(entry.getValue())) {
							return new AbstractMap.SimpleEntry<>(entry.getKey(), Boolean.parseBoolean(entry.getValue()));
						}
						// Prettier v3 - plugins config will be a comma delimited list of plugins
						if (entry.getKey().equals("plugins")) {
							List values = entry.getValue().isEmpty() ? List.of() : Arrays.asList(entry.getValue().split(","));
							return new AbstractMap.SimpleEntry<>(entry.getKey(), values);
						}
						return entry;
					})
					.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> a, LinkedHashMap::new));
		} else {
			configInline = null;
		}

		// create the format step
		File baseDir = baseDir(stepConfig);
		File buildDir = buildDir(stepConfig);
		File cacheDir = cacheDir(stepConfig);
		PrettierConfig prettierConfig = new PrettierConfig(configFileHandler, configInline);
		NpmPathResolver npmPathResolver = npmPathResolver(stepConfig);
		return PrettierFormatterStep.create(devDependencies, stepConfig.getProvisioner(), baseDir, buildDir, cacheDir, npmPathResolver, prettierConfig);
	}

	private static IllegalArgumentException onlyOneConfig() {
		return new IllegalArgumentException(ERROR_MESSAGE_ONLY_ONE_CONFIG);
	}
}