-
Notifications
You must be signed in to change notification settings - Fork 29k
[WIP][SPARK-14629][SPARK-14630][Build] Add support for custom scala style rules & Add rule PublicAbstractMethodsHaveTypeChecker #12396
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
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 hidden or 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 |
|---|---|---|
|
|
@@ -98,3 +98,4 @@ LZ4BlockInputStream.java | |
| spark-deps-.* | ||
| .*csv | ||
| .*tsv | ||
| reference.conf | ||
3 changes: 3 additions & 0 deletions
3
dev/spark_scala_style_checker/src/main/resources/reference.conf
This file contains hidden or 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,3 @@ | ||
| public.abstract.methods.have.type.message = "Public abstract methods must have explicit return types" | ||
| public.abstract.methods.have.type.label = "PulicAbstractMethod" | ||
| public.abstract.methods.have.type.description = "Check that a pulic abstract method has an explicit return type, it is not inferred" |
43 changes: 43 additions & 0 deletions
43
...er/src/main/scala/org/apache/spark/scala_style/PublicAbstractMethodsHaveTypeChecker.scala
This file contains hidden or 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,43 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 org.apache.spark.scala_style | ||
|
|
||
| import org.scalastyle.scalariform.AbstractSingleMethodChecker | ||
|
|
||
| import scalariform.parser.ProcFunBody | ||
|
|
||
| class PublicAbstractMethodsHaveTypeChecker extends AbstractSingleMethodChecker[Unit] { | ||
|
|
||
| val errorKey = "public.abstract.methods.have.type" | ||
|
|
||
| protected def matchParameters() = Unit | ||
|
|
||
| protected def matches(t: FullDefOrDclVisit, p: Unit) = { | ||
|
|
||
| t.funDefOrDcl.funBodyOpt match { | ||
| case Some(ProcFunBody(newlineOpt, bodyBlock)) => false | ||
| case _ => // None or Some(ExprFunBody) | ||
| t.funDefOrDcl.returnTypeOpt.isEmpty && | ||
| !isConstructor(t.fullDefOrDcl.defOrDcl) && | ||
| !privateOrProtected(t.fullDefOrDcl.modifiers) && | ||
| !t.insideDefOrValOrVar && | ||
| !t.funDefOrDcl.nameToken.text.equals("main") // public static void main(...) is OK | ||
| } | ||
|
|
||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
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.
Yikes, do we have to maintain and publish this as a module to use it? it may not be worth it
Uh oh!
There was an error while loading. Please reload this page.
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.
@srowen yeah I think you're right -- doing that is heavy and not worth it. :-)
I'm working on a light-weight manner to do this, after all all we need is to install the custom rules jar locally in the dev & build environment, other than publishing that into run-time environment or maven-central.
Thanks for the review!