Skip to content
This repository has been archived by the owner on Mar 27, 2023. It is now read-only.

Commit

Permalink
Update website
Browse files Browse the repository at this point in the history
  • Loading branch information
kciesielski committed Jan 31, 2019
1 parent 23629c7 commit 9826dfa
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
2 changes: 1 addition & 1 deletion ui/app/views/index.scala.html
Expand Up @@ -39,7 +39,7 @@
<div>&nbsp;</div>
<div class="text-center">
Copyright 2016. Created & maintained by
<a href="http://softwaremill.com">Softwaremill</a>.
<a href="http://softwaremill.com">SoftwareMill</a>.
</div>
</footer>

Expand Down
34 changes: 29 additions & 5 deletions ui/app/views/use.scala.html
Expand Up @@ -29,7 +29,7 @@ <h2>Adding the plugin</h2>
</p>

<pre>
addSbtPlugin("com.softwaremill.clippy" % "plugin-sbt" % "0.5.3")
addSbtPlugin("com.softwaremill.clippy" % "plugin-sbt" % "0.6.0")
</pre>

<p>
Expand All @@ -52,6 +52,23 @@ <h2>Adding the plugin</h2>
as <code>scalacOptions += "-P:clippy:colors=true"</code>)</li>
</ul>

<h2>(NEW!) Turning selected compilation warnings into errors</h2>
<p>
From version 0.6.0 you can selectively define regexes for warnings which will be treated as fatal compilation errors. To do so with sbt,
use the <code>clippyFatalWarnings</code> setting, for example:
</p>
<pre>
settings(
clippyFatalWarnings ++= Seq(
"match may not be exhaustive[\\s\\S]*",
".*\\[wartremover:.*\\].*[\\s\\S]*"
)
)
</pre>
<p>
You can also define fatal warnings in your .clippy.json file (see further sections for examples).
</p>

<h2>Enabling syntax and type mismatch diffs highlighting</h2>

<p>
Expand Down Expand Up @@ -107,9 +124,9 @@ <h2>Contributing advice</h2>
<a href="https://github.com/softwaremill/scala-clippy">source code</a>.
</p>

<h2>Project-specific advices</h2>
<h2>Project-specific advices and fatal warnings</h2>

<p>If you have advice that you feel is too specific to be worth sharing publicly, you can add
<p>If you have advice that you feel is too specific to be worth sharing publicly, you can add
it to your project specific advice file. First set your project root:
</p>
<pre>
Expand All @@ -120,6 +137,7 @@ <h2>Project-specific advices</h2>

<pre>
{
"version": "1",
"advices": [
{
"error": {
Expand All @@ -134,6 +152,12 @@ <h2>Project-specific advices</h2>
"version": "1.0"
}
}
],
"fatalWarnings": [
{
"pattern": "match may not be exhaustive[\\s\\S]*",
"text": "Additional optional text to be displayed"
}
]
}
</pre>
Expand All @@ -151,15 +175,15 @@ <h2>Alternative ways to use Clippy</h2>
</p>

<pre>
addCompilerPlugin("com.softwaremill.clippy" %% "plugin" % "0.5.3" classifier "bundle")
addCompilerPlugin("com.softwaremill.clippy" %% "plugin" % "0.6.0" classifier "bundle")
</pre>

<p>
If you are using <code>scalac</code> directly, add the following option:
</p>

<pre>
-Xplugin:clippy-plugin_2.11-0.5.3-bundle.jar
-Xplugin:clippy-plugin_2.11-0.6.0-bundle.jar
</pre>

<p>
Expand Down

0 comments on commit 9826dfa

Please sign in to comment.