com.diffplug.gradle.spotless.ProtobufExtension 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 2022-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.gradle.spotless;

import static com.diffplug.spotless.protobuf.ProtobufConstants.LICENSE_HEADER_DELIMITER;

import java.util.Objects;

import javax.inject.Inject;

import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.protobuf.BufStep;

public class ProtobufExtension extends FormatExtension implements HasBuiltinDelimiterForLicense {
	static final String NAME = "protobuf";

	@Inject
	public ProtobufExtension(SpotlessExtension spotless) {
		super(spotless);
	}

	@Override
	public LicenseHeaderConfig licenseHeader(String licenseHeader) {
		return licenseHeader(licenseHeader, LICENSE_HEADER_DELIMITER);
	}

	@Override
	public LicenseHeaderConfig licenseHeaderFile(Object licenseHeaderFile) {
		return licenseHeaderFile(licenseHeaderFile, LICENSE_HEADER_DELIMITER);
	}

	/** If the user hasn't specified files, assume all protobuf files should be checked. */
	@Override
	protected void setupTask(SpotlessTask task) {
		if (target == null) {
			target = parseTarget("**/*.proto");
		}
		super.setupTask(task);
	}

	/** Adds the specified version of buf. */
	public BufFormatExtension buf(String version) {
		Objects.requireNonNull(version);
		return new BufFormatExtension(version);
	}

	public BufFormatExtension buf() {
		return buf(BufStep.defaultVersion());
	}

	public class BufFormatExtension {
		BufStep step;

		BufFormatExtension(String version) {
			this.step = BufStep.withVersion(version);
			if (!steps.isEmpty()) {
				throw new IllegalArgumentException("buf() must be the first step, move other steps after it. Thumbs up [this issue](https://github.com/bufbuild/buf/issues/1035) for a resolution, see [here](https://github.com/diffplug/spotless/pull/1208#discussion_r1264439669) for more details on the problem.");
			}
			addStep(createStep());
		}

		/**
		 * When used in conjunction with the {@code buf-gradle-plugin},
		 * the {@code buf} executable can be resolved from its {@code bufTool} configuration:
		 *
		 * 		 * {@code
		 * spotless {
		 *   protobuf {
		 *     buf().pathToExe(configurations.getByName(BUF_BINARY_CONFIGURATION_NAME).getSingleFile().getAbsolutePath())
		 *   }
		 * }
		 * }
		 * 
		 *
		 * Be sure to disable the {@code buf-gradle-plugin}'s execution of {@code buf format}:
		 *
		 * 		 * {@code
		 * buf {
		 *   enforceFormat = false
		 * }
		 * }
		 * 
		 */
		public BufFormatExtension pathToExe(String pathToExe) {
			step = step.withPathToExe(pathToExe);
			replaceStep(createStep());
			return this;
		}

		private FormatterStep createStep() {
			return step.create();
		}
	}
}