-
Notifications
You must be signed in to change notification settings - Fork 458
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
Kotlin support in Maven plugin #223
Merged
Merged
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d2e311f
Cleanup Format and FormatterFactory
lutovich 0bcf53b
Moved Kotlin test resources from plugin-gradle to testlib
lutovich ca64af9
Support for Kotlin and Ktlint in maven plugin
lutovich 60ecd22
Common constant for Kotlin's license header delimiter
lutovich 8085880
Update maven plugin changelog
lutovich b761c4b
Update main changelog about Ktlint support in maven plugin
lutovich c058ed7
Use ImmutableSet for default includes
lutovich 4d7536d
Readme entries for Scala and Kotlin in Maven plugin
lutovich 178ffad
Renamed test to match main source
lutovich 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
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
45 changes: 45 additions & 0 deletions
45
plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Kotlin.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,45 @@ | ||
/* | ||
* Copyright 2016 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.kotlin; | ||
|
||
import static com.diffplug.common.collect.Sets.newHashSet; | ||
import static java.util.Collections.unmodifiableSet; | ||
|
||
import java.util.Set; | ||
|
||
import com.diffplug.spotless.maven.FormatterFactory; | ||
|
||
public class Kotlin extends FormatterFactory { | ||
|
||
private static final Set<String> DEFAULT_INCLUDES = unmodifiableSet(newHashSet("src/main/kotlin/**/*.kt", | ||
"src/test/kotlin/**/*.kt")); | ||
|
||
private static final String LICENSE_HEADER_DELIMITER = "(package |@file)"; | ||
|
||
@Override | ||
public Set<String> defaultIncludes() { | ||
return DEFAULT_INCLUDES; | ||
} | ||
|
||
@Override | ||
public String licenseHeaderDelimiter() { | ||
return LICENSE_HEADER_DELIMITER; | ||
} | ||
|
||
public void addKtlint(Ktlint ktlint) { | ||
addStepFactory(ktlint); | ||
} | ||
} |
35 changes: 35 additions & 0 deletions
35
plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktlint.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,35 @@ | ||
/* | ||
* Copyright 2016 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.kotlin; | ||
|
||
import org.apache.maven.plugins.annotations.Parameter; | ||
|
||
import com.diffplug.spotless.FormatterStep; | ||
import com.diffplug.spotless.kotlin.KtLintStep; | ||
import com.diffplug.spotless.maven.FormatterStepConfig; | ||
import com.diffplug.spotless.maven.FormatterStepFactory; | ||
|
||
public class Ktlint implements FormatterStepFactory { | ||
|
||
@Parameter | ||
private String version; | ||
|
||
@Override | ||
public FormatterStep newFormatterStep(FormatterStepConfig config) { | ||
String ktlintVersion = version != null ? version : KtLintStep.defaultVersion(); | ||
return KtLintStep.create(ktlintVersion, config.getProvisioner()); | ||
} | ||
} |
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
39 changes: 39 additions & 0 deletions
39
plugin-maven/src/test/java/com/diffplug/spotless/maven/kotlin/KtLintTest.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,39 @@ | ||
/* | ||
* Copyright 2016 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.kotlin; | ||
|
||
import org.junit.Test; | ||
|
||
import com.diffplug.spotless.maven.MavenIntegrationTest; | ||
|
||
public class KtLintTest extends MavenIntegrationTest { | ||
|
||
@Test | ||
public void testKtlint() throws Exception { | ||
writePomWithKotlinSteps("<ktlint/>"); | ||
|
||
String path1 = "src/main/kotlin/main1.kt"; | ||
String path2 = "src/main/kotlin/main2.kt"; | ||
|
||
setFile(path1).toResource("kotlin/ktlint/basic.dirty"); | ||
setFile(path2).toResource("kotlin/ktlint/basic.dirty"); | ||
|
||
mavenRunner().withArguments("spotless:apply").runNoError(); | ||
|
||
assertFile(path1).sameAsResource("kotlin/ktlint/basic.clean"); | ||
assertFile(path2).sameAsResource("kotlin/ktlint/basic.clean"); | ||
} | ||
} |
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.
Feel free to ignore this, but I would've written as
ImmutableSet.of("src/main/...
. ImmutableSet gives compile-warnings if you accidentally call modifier-methods likeput
, and it's a little faster since it doesn't have to worry about the modification usecase.