-
Notifications
You must be signed in to change notification settings - Fork 441
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reuse configs for GroovyExtension and GroovyGradleExtension
#1892
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
75 changes: 75 additions & 0 deletions
75
plugin-gradle/src/main/java/com/diffplug/gradle/spotless/BaseGroovyExtension.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright 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.gradle.spotless.PluginGradlePreconditions.requireElementsNonNull; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| import org.gradle.api.Project; | ||
|
|
||
| import com.diffplug.spotless.extra.EquoBasedStepBuilder; | ||
| import com.diffplug.spotless.extra.groovy.GrEclipseFormatterStep; | ||
| import com.diffplug.spotless.java.ImportOrderStep; | ||
|
|
||
| abstract class BaseGroovyExtension extends FormatExtension { | ||
| protected BaseGroovyExtension(SpotlessExtension spotless) { | ||
| super(spotless); | ||
| } | ||
|
|
||
| public void importOrder(String... importOrder) { | ||
| addStep(ImportOrderStep.forGroovy().createFrom(importOrder)); | ||
| } | ||
|
|
||
| public void importOrderFile(Object importOrderFile) { | ||
| Objects.requireNonNull(importOrderFile); | ||
| addStep(ImportOrderStep.forGroovy().createFrom(getProject().file(importOrderFile))); | ||
| } | ||
|
|
||
| public GrEclipseConfig greclipse() { | ||
| return greclipse(GrEclipseFormatterStep.defaultVersion()); | ||
| } | ||
|
|
||
| public GrEclipseConfig greclipse(String version) { | ||
| return new GrEclipseConfig(version, this); | ||
| } | ||
|
|
||
| public static class GrEclipseConfig { | ||
| private final EquoBasedStepBuilder builder; | ||
| private final FormatExtension extension; | ||
|
|
||
| private GrEclipseConfig(String version, FormatExtension extension) { | ||
| this.extension = extension; | ||
| builder = GrEclipseFormatterStep.createBuilder(extension.provisioner()); | ||
| builder.setVersion(version); | ||
| extension.addStep(builder.build()); | ||
| } | ||
|
|
||
| public void configFile(Object... configFiles) { | ||
| requireElementsNonNull(configFiles); | ||
| Project project = extension.getProject(); | ||
| builder.setPreferences(project.files(configFiles).getFiles()); | ||
| extension.replaceStep(builder.build()); | ||
| } | ||
|
|
||
| public GrEclipseConfig withP2Mirrors(Map<String, String> mirrors) { | ||
| builder.setP2Mirrors(mirrors); | ||
| extension.replaceStep(builder.build()); | ||
| return this; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we implement
HasBuiltinDelimiterForLicenseforGroovyGradleExtension? If so we can move this intoBaseGroovyExtensionas well.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's pretty hard to find the regex for
Groovy, I think it's really hard to find it for GroovyGradle, as anything could be at the top. IMO hiding this regex from the user is counterproductive because too likely that they will end up needing to change something about it.