add support for missing generic steps (closes #207) #209
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
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
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
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,29 @@ | ||
| /* | ||
| * 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.generic; | ||
|
|
||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.generic.EndWithNewlineStep; | ||
| import com.diffplug.spotless.maven.FormatterStepConfig; | ||
| import com.diffplug.spotless.maven.FormatterStepFactory; | ||
|
|
||
| public class EndWithNewline implements FormatterStepFactory { | ||
|
|
||
| @Override | ||
| public FormatterStep newFormatterStep(FormatterStepConfig config) { | ||
| return EndWithNewlineStep.create(); | ||
| } | ||
| } |
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,55 @@ | ||
| /* | ||
| * 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.generic; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Set; | ||
|
|
||
| import com.diffplug.spotless.maven.FormatterFactory; | ||
|
|
||
| public class Format extends FormatterFactory { | ||
|
|
||
| @Override | ||
| public Set<String> defaultIncludes() { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public String licenseHeaderDelimiter() { | ||
| // do not specify a default delimiter | ||
| return null; | ||
| } | ||
|
|
||
| public void addEndWithNewline(EndWithNewline endWithNewline) { | ||
| addStepFactory(endWithNewline); | ||
| } | ||
|
|
||
| public void addIndent(Indent indent) { | ||
| addStepFactory(indent); | ||
| } | ||
|
|
||
| public void addTrimTrailingWhitespace(TrimTrailingWhitespace trimTrailingWhitespace) { | ||
| addStepFactory(trimTrailingWhitespace); | ||
| } | ||
|
|
||
| public void addReplace(Replace replace) { | ||
| addStepFactory(replace); | ||
| } | ||
|
|
||
| public void addReplaceRegex(ReplaceRegex replaceRegex) { | ||
| addStepFactory(replaceRegex); | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. So, There was a problem hiding this comment. Extending There was a problem hiding this comment. Keep them separate for now. Hopefully @lutovich will have a chance to take a look. There was a problem hiding this comment. Am I right that There was a problem hiding this comment. Would it make sense to keep There was a problem hiding this comment. The class Moreover IMHO the maven-plugin should support the same feature set as the gradle-plugin does. And the gradle-plugin supports it this way. So one could setup the formatting like this <configuration>
<!-- global defaults -->
<encoding>UTF-8</encoding>
<!-- custom format for properties -->
<format>
<inlcudes>
<include>src/**/resources/**/*.properties</include>
</includes>
<endWithNewline />
<encoding>ISO 8859-1</encoding>
</format>
<!-- custom format for java files -->
<java>
<endWithNewline />
<trimTrailingWhitespace />
</java>
</configuration> |
||
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,53 @@ | ||
| /* | ||
| * 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.generic; | ||
|
|
||
| import org.apache.maven.plugins.annotations.Parameter; | ||
|
|
||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.generic.IndentStep; | ||
| import com.diffplug.spotless.maven.FormatterStepConfig; | ||
| import com.diffplug.spotless.maven.FormatterStepFactory; | ||
|
|
||
| public class Indent implements FormatterStepFactory { | ||
|
|
||
| @Parameter | ||
| private boolean tabs; | ||
|
|
||
| @Parameter | ||
| private boolean spaces; | ||
|
|
||
| @Parameter | ||
| private Integer spacesPerTab; | ||
|
|
||
| @Override | ||
| public FormatterStep newFormatterStep(FormatterStepConfig config) { | ||
|
|
||
| if (spacesPerTab == null) { | ||
| spacesPerTab = IndentStep.defaultNumSpacesPerTab(); | ||
| } | ||
|
|
||
| if (spaces ^ tabs) { | ||
| if (spaces) { | ||
| return IndentStep.create(IndentStep.Type.SPACE, spacesPerTab); | ||
| } else { | ||
| return IndentStep.create(IndentStep.Type.TAB, spacesPerTab); | ||
| } | ||
| } else { | ||
| throw new IllegalArgumentException("Must specify exactly one of 'spaces' or 'tabs'."); | ||
| } | ||
| } | ||
| } |
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,44 @@ | ||
| /* | ||
| * 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.generic; | ||
|
|
||
| import org.apache.maven.plugins.annotations.Parameter; | ||
|
|
||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.generic.ReplaceStep; | ||
| import com.diffplug.spotless.maven.FormatterStepConfig; | ||
| import com.diffplug.spotless.maven.FormatterStepFactory; | ||
|
|
||
| public class Replace implements FormatterStepFactory { | ||
|
|
||
| @Parameter | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. I used the annotation parameter in my first iteration, but that leads to validation messages which are hard to understand for users: Where as a custom handling is shown like that: Thats why I prefer custom validation for required parameters and would like to keep it. |
||
| private String name; | ||
|
|
||
| @Parameter | ||
| private String search; | ||
|
|
||
| @Parameter | ||
| private String replacement; | ||
|
|
||
| @Override | ||
| public FormatterStep newFormatterStep(FormatterStepConfig config) { | ||
| if (name == null || search == null || replacement == null) { | ||
| throw new IllegalArgumentException("Must specify 'name', 'search' and 'replacement'."); | ||
| } | ||
|
|
||
| return ReplaceStep.create(name, search, replacement); | ||
| } | ||
| } | ||
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.
What do you think about not having
<format>element? Configuration could then look like:?
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.
I think the purpose of the
<format>element is to do specific formatting on specific kinds of files that aren't java or scala. e.g.:spotless/spotlessSelf.gradle
Lines 54 to 59 in 4d28488
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.
Aha, got it. This explains a lot :)
Please dismiss all my previous comments about
<format>.Maybe then we need an ability to configure multiple formats?
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.
The idea of the new format section is to provide the ability to define custom formats for e.g. property and sql files. Currently only one format section is allowed, but the gradle plugin allows unlimited format sections. This way you can define a format per source set. This comes in quite handy on larger projects.
I'm planing to extend the maven-plugin to provide unlimited format sections too.