[
https://issues.apache.org/jira/browse/S2GRAPH-107?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15731285#comment-15731285
]
ASF GitHub Bot commented on S2GRAPH-107:
----------------------------------------
GitHub user ijsong opened a pull request:
https://github.com/apache/incubator-s2graph/pull/109
[S2GRAPH-107] Improve code readability by using code formatter and code
style inspector like Scalafmt and Scalastyle
Issue: https://issues.apache.org/jira/browse/S2GRAPH-107
This PR has really big changes, but those are mostly related to code
styles. In this PR, I changed level of some rules in scalastyle from warning to
error. Many projects raise error rather than warning when scalastyle checker
fails. In near future, we are able to change warning rule to raise error by do
refactoring codebase. (I will create another issue to do refactoring our
codebase according to some published scala best practice and design pattern.)
Tools related to code style which we use:
- Scalafmt
- Scalastyle
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ijsong/incubator-s2graph S2GRAPH-107
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-s2graph/pull/109.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #109
----
commit ef834d343d5ac63d38413c9b51e92d229de0846e
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-05T10:45:04Z
Add scalafmt configuration
commit 066d2b652e654176f815005fd7f86dc3b5ed34d0
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-05T10:46:38Z
Apply scalafmt and scalastyle rule to source files
commit 7f93a4ad7db97d9c692369cfd7ff1c4d4af824df
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-07T05:22:23Z
fix by scalafmt
commit 1670d6a0b973d0cbe9aac684bff8c7f7e08e14cc
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-08T02:23:26Z
fix scalastyle error
commit adf7dcf6d60b57e4a88296e2125479720d002938
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-08T02:58:02Z
Add commit hook of scalastyle and fix erroneous codes according to
scalastyle settings
commit e9cfb043ed89a6280ae170573445178ee8ca38a1
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-08T03:05:36Z
add scalastyle
commit 92c8f9efa5f0759a932dc31eeeb9593cfe053643
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-08T03:08:33Z
overcommit
commit c853b01819208e6d867ca89a62b5b7bdf3c8afb2
Author: Injun Song <ijs...@gmail.com>
Date: 2016-12-08T06:03:47Z
fix compile error caused by change lines due to scalafmt
----
> Improve code readability by using code formatter and code style inspector
> like Scalafmt and Scalastyle
> ------------------------------------------------------------------------------------------------------
>
> Key: S2GRAPH-107
> URL: https://issues.apache.org/jira/browse/S2GRAPH-107
> Project: S2Graph
> Issue Type: Wish
> Reporter: Injun Song
> Priority: Minor
>
> Readability of S2Graph can be improved by using code formatter.
> There are known code formatters for Scala.
> - https://olafurpg.github.io/scalafmt
> - https://github.com/scala-ide/scalariform
> Moreover, to improve readability and code styles, we can modify several
> settings in Scalastyle.
> Code formatter and Scalastyle can be used together.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
