https://github.com/zendesk/scalastyle_config
The Scalastyle configuration we use for our in-house Scala projects
https://github.com/zendesk/scalastyle_config
code-style compile-time linter scala scalastyle tools
Last synced: 10 months ago
JSON representation
The Scalastyle configuration we use for our in-house Scala projects
- Host: GitHub
- URL: https://github.com/zendesk/scalastyle_config
- Owner: zendesk
- License: mit
- Created: 2018-07-02T18:23:28.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-16T22:45:27.000Z (almost 7 years ago)
- Last Synced: 2025-04-11T20:52:25.424Z (about 1 year ago)
- Topics: code-style, compile-time, linter, scala, scalastyle, tools
- Size: 16.6 KB
- Stars: 3
- Watchers: 294
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scalastyle_config
The [Scalastyle](http://www.scalastyle.org/sbt.html) configuration we use for our in-house Scala projects.
# Using with the Scalastyle SBT plugin
Assuming your project already has the [plugin](http://www.scalastyle.org/sbt.html) setup, update your `build.sbt` to include the following settings:
```scala
scalastyleConfigUrl := Some("https://raw.githubusercontent.com/zendesk/scalastyle_config/master/scalastyle-config.xml"),
scalastyleConfigUrlCacheFile := "scalastyle-config.xml",
scalastyleConfigRefreshHours := 168 // Weekly instead of daily.
```
NOTE: if you're using a recent version of Zendesk's (internal) `zendesk_sbt_base_settings` plugin, then these settings are already setup for you.
The `scalastyleConfigUrlCacheFile` setting puts the downloaded file into the root of your repository, which is where IntelliJ expects it to be.
To ensure that the download config is *not* part of your Git repository, add a line containing `scalastyle-config.xml` to `.gitignore` (which can be in the root of your repository, or the global one).