Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history 
Deploy website version based on 9c282a5
  • Loading branch information
Docusaurus bot committed Oct 4, 2024
1 parent 87b99eb commit d09c1e6
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 26 deletions.
44 changes: 22 additions & 22 deletions docs/developers/symbol-information.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,42 +334,42 @@ <h3><a class="anchor" aria-hidden="true" id="lookup-class-methods"></a><a href="
}
getClassMethods(<span class="hljs-type">Symbol</span>(<span class="hljs-string">"scala/Some#"</span>)).take(<span class="hljs-number">5</span>)
<span class="hljs-comment">// res29: Set[SymbolInformation] = HashSet(</span>
<span class="hljs-comment">// scala/Option#get(). =&gt; abstract method get: A,</span>
<span class="hljs-comment">// scala/AnyRef#eq(). =&gt; final method eq(that: AnyRef): Boolean,</span>
<span class="hljs-comment">// scala/Any#isInstanceOf(). =&gt; final method isInstanceOf[A](): Boolean,</span>
<span class="hljs-comment">// scala/Any#getClass(). =&gt; final method getClass(): Class,</span>
<span class="hljs-comment">// scala/Option#zip(). =&gt; final method zip[A1 &gt;: A, B](that: Option[B]): Option[Tuple2[A1, B]]</span>
<span class="hljs-comment">// scala/Option#filterNot(). =&gt; @inline final method filterNot(p: Function1[A, Boolean]): Option[A],</span>
<span class="hljs-comment">// scala/Product#productArity(). =&gt; abstract method productArity: Int,</span>
<span class="hljs-comment">// scala/Any#`##`(). =&gt; final method ##(): Int,</span>
<span class="hljs-comment">// scala/Some#copy$default$1(). =&gt; method copy$default$1[A]: A @&lt;?&gt;,</span>
<span class="hljs-comment">// scala/Any#`!=`(). =&gt; final method !=(that: Any): Boolean</span>
<span class="hljs-comment">// )</span>
getClassMethods(<span class="hljs-type">Symbol</span>(<span class="hljs-string">"java/lang/String#"</span>)).take(<span class="hljs-number">5</span>)
<span class="hljs-comment">// res30: Set[SymbolInformation] = HashSet(</span>
<span class="hljs-comment">// java/lang/String#isLatin1(). =&gt; private method isLatin1(): Boolean,</span>
<span class="hljs-comment">// java/lang/String#charAt(). =&gt; method charAt(param0: Int): Char,</span>
<span class="hljs-comment">// java/lang/String#endsWith(). =&gt; method endsWith(param0: String): Boolean,</span>
<span class="hljs-comment">// java/lang/Object#finalize(). =&gt; protected method finalize(): Unit,</span>
<span class="hljs-comment">// java/lang/String#hashCode(). =&gt; method hashCode(): Int</span>
<span class="hljs-comment">// java/lang/String#concat(). =&gt; method concat(param0: String): String,</span>
<span class="hljs-comment">// java/lang/Object#registerNatives(). =&gt; private static method registerNatives(): Unit,</span>
<span class="hljs-comment">// java/lang/String#startsWith(+1). =&gt; method startsWith(param0: String): Boolean,</span>
<span class="hljs-comment">// java/lang/Object#equals(). =&gt; method equals(param0: Object): Boolean,</span>
<span class="hljs-comment">// java/lang/Object#registerNatives(). =&gt; private static method registerNatives(): Unit</span>
<span class="hljs-comment">// )</span>
getClassMethods(<span class="hljs-type">Symbol</span>(<span class="hljs-string">"scala/collection/immutable/List#"</span>)).take(<span class="hljs-number">5</span>)
<span class="hljs-comment">// res31: Set[SymbolInformation] = HashSet(</span>
<span class="hljs-comment">// scala/collection/IterableOps#tail(). =&gt; method tail: C,</span>
<span class="hljs-comment">// scala/collection/IterableOps#coll(). =&gt; protected abstract method coll: C,</span>
<span class="hljs-comment">// scala/collection/IterableOnceOps#fold(). =&gt; method fold[A1 &gt;: A](z: A1)(op: Function2[A1, A1, A1]): A1,</span>
<span class="hljs-comment">// scala/Any#`!=`(). =&gt; final method !=(that: Any): Boolean,</span>
<span class="hljs-comment">// scala/collection/IterableOps#scanRight(). =&gt; method scanRight[B](z: B)(op: Function2[A, B, B]): CC[B]</span>
<span class="hljs-comment">// scala/collection/SeqOps#indexOf(+1). =&gt; @deprecatedOverriding method indexOf[B &gt;: A](elem: B): Int,</span>
<span class="hljs-comment">// scala/Any#`##`(). =&gt; final method ##(): Int,</span>
<span class="hljs-comment">// scala/collection/IterableOps#flatten(). =&gt; method flatten[B](implicit asIterable: Function1[A, IterableOnce[B]]): CC[B],</span>
<span class="hljs-comment">// scala/collection/IterableOps#flatten(). =&gt; method flatten[B](implicit asIterable: Function1[A, IterableOnce[B]]): CC[B],</span>
<span class="hljs-comment">// scala/collection/SeqOps#contains(). =&gt; method contains[A1 &gt;: A](elem: A1): Boolean</span>
<span class="hljs-comment">// )</span>
</code></pre>
<p>For Java methods, use <code>SymbolInformation.isStatic</code> to separate static methods
from non-static methods.</p>
<pre><code class="hljs css language-scala">getClassMethods(<span class="hljs-type">Symbol</span>(<span class="hljs-string">"java/lang/String#"</span>)).filter(_.isStatic).take(<span class="hljs-number">3</span>)
<span class="hljs-comment">// res32: Set[SymbolInformation] = HashSet(</span>
<span class="hljs-comment">// java/lang/String#valueOf(+8). =&gt; static method valueOf(param0: Double): String,</span>
<span class="hljs-comment">// java/lang/CharSequence#compare(). =&gt; static method compare(param0: CharSequence, param1: CharSequence): Int,</span>
<span class="hljs-comment">// java/lang/String#join(+1). =&gt; static method join(param0: CharSequence, param1: Iterable[local_wildcard]): String,</span>
<span class="hljs-comment">// java/lang/String#checkBoundsBeginEnd(). =&gt; private[lang] static method checkBoundsBeginEnd(param0: Int, param1: Int, param2: Int): Unit,</span>
<span class="hljs-comment">// java/lang/Object#registerNatives(). =&gt; private static method registerNatives(): Unit</span>
<span class="hljs-comment">// )</span>
getClassMethods(<span class="hljs-type">Symbol</span>(<span class="hljs-string">"java/lang/String#"</span>)).filter(!_.isStatic).take(<span class="hljs-number">3</span>)
<span class="hljs-comment">// res33: Set[SymbolInformation] = HashSet(</span>
<span class="hljs-comment">// java/lang/Object#wait(+1). =&gt; final method wait(param0: Long): Unit,</span>
<span class="hljs-comment">// java/lang/Object#toString(). =&gt; method toString(): String,</span>
<span class="hljs-comment">// java/lang/String#indexOf(+3). =&gt; method indexOf(param0: String, param1: Int): Int</span>
<span class="hljs-comment">// java/lang/Object#clone(). =&gt; protected method clone(): Object,</span>
<span class="hljs-comment">// java/lang/Object#hashCode(). =&gt; method hashCode(): Int,</span>
<span class="hljs-comment">// java/lang/String#substring(+1). =&gt; method substring(param0: Int, param1: Int): String</span>
<span class="hljs-comment">// )</span>
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="lookup-class-primary-constructor"></a><a href="#lookup-class-primary-constructor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Lookup class primary constructor</h3>
Expand Down Expand Up @@ -483,8 +483,8 @@ <h3><a class="anchor" aria-hidden="true" id="lookup-method-overloads"></a><a hre
getMethodOverloads(<span class="hljs-type">Symbol</span>(<span class="hljs-string">"java/io/PrintStream#"</span>), <span class="hljs-string">"print"</span>).take(<span class="hljs-number">3</span>)
<span class="hljs-comment">// res47: Set[SymbolInformation] = HashSet(</span>
<span class="hljs-comment">// java/io/PrintStream#print(+4). =&gt; method print(param0: Float): Unit,</span>
<span class="hljs-comment">// java/io/PrintStream#print(). =&gt; method print(param0: Boolean): Unit,</span>
<span class="hljs-comment">// java/io/PrintStream#print(+8). =&gt; method print(param0: Object): Unit</span>
<span class="hljs-comment">// java/io/PrintStream#print(+7). =&gt; method print(param0: String): Unit,</span>
<span class="hljs-comment">// java/io/PrintStream#print(+5). =&gt; method print(param0: Double): Unit</span>
<span class="hljs-comment">// )</span>
</code></pre>
<p>Overloaded methods can be inherited from supertypes.</p>
Expand Down
20 changes: 16 additions & 4 deletions docs/users/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -363,12 +363,24 @@ <h3><a class="anchor" aria-hidden="true" id="example-project"></a><a href="#exam
<h2><a class="anchor" aria-hidden="true" id="command-line"></a><a href="#command-line" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Command line</h2>
<p>First, install the <a href="https://get-coursier.io/docs/cli-installation">Coursier</a>
command-line interface.</p>
<p>Next, install a <code>scalafix</code> binary with Coursier</p>
<p>Then, download the Scalafix runner built with the latest version of Scala
(3.5.1)</p>
<pre><code class="hljs css language-sh">cs install scalafix
./scalafix --version <span class="hljs-comment"># Should say 0.13.0</span>
</code></pre>
<blockquote>
<p>If you plan to use advanced semantic rules like <code>ExplicitResultTypes</code>, you
must use the version of Scalafix built with a Scala version matching your
target source files.</p>
<p>If your target files are not built with the latest minor version of Scala,
use one of the following commands to create a custom runner</p>
<pre><code class="hljs css language-sh">cs bootstrap ch.epfl.scala:scalafix-cli_2.12.20:0.13.0 --main scalafix.cli.Cli -o scalafix_2.12
cs bootstrap ch.epfl.scala:scalafix-cli_2.13.15:0.13.0 --main scalafix.cli.Cli -o scalafix_2.13
cs bootstrap ch.epfl.scala:scalafix-cli_3.3.4:0.13.0 --main scalafix.cli.Cli -o scalafix_3-lts
</code></pre>
</blockquote>
<h3><a class="anchor" aria-hidden="true" id="help"></a><a href="#help" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Help</h3>
<pre><code class="hljs">Scalafix <span class="hljs-number">0.13</span>.<span class="hljs-number">0</span>+<span class="hljs-number">23</span>-<span class="hljs-number">1</span>bf297d2-SNAPSHOT
<pre><code class="hljs">Scalafix <span class="hljs-number">0.13</span>.<span class="hljs-number">0</span>+<span class="hljs-number">25</span>-<span class="hljs-number">9</span>c282a55-SNAPSHOT
Usage: scalafix [options] [&lt;path&gt; ...]

Scalafix <span class="hljs-keyword">is</span> a refactoring <span class="hljs-keyword">and</span> linting tool. Scalafix
Expand Down Expand Up @@ -540,10 +552,10 @@ <h2><a class="anchor" aria-hidden="true" id="snapshot"></a><a href="#snapshot" a
<pre><code class="hljs css language-diff"> // project/plugins.sbt
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.13.0")
<span class="hljs-addition">+resolvers += Resolver.sonatypeRepo("snapshots")</span>
<span class="hljs-addition">+dependencyOverrides += "ch.epfl.scala" % "scalafix-interfaces" % "0.13.0+23-1bf297d2-SNAPSHOT"</span>
<span class="hljs-addition">+dependencyOverrides += "ch.epfl.scala" % "scalafix-interfaces" % "0.13.0+25-9c282a55-SNAPSHOT"</span>
</code></pre>
<p>If using the command-line interface</p>
<pre><code class="hljs css language-sh">cs launch ch.epfl.scala:scalafix-cli_2.13.15:0.13.0+23-1bf297d2-SNAPSHOT -r sonatype:snapshots --main scalafix.cli.Cli -- --<span class="hljs-built_in">help</span>
<pre><code class="hljs css language-sh">cs launch ch.epfl.scala:scalafix-cli_2.13.15:0.13.0+25-9c282a55-SNAPSHOT -r sonatype:snapshots --main scalafix.cli.Cli -- --<span class="hljs-built_in">help</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/scalafix/docs/users/configuration.html"><span>Configuration</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#support">Support</a></li><li><a href="#sbt">sbt</a><ul class="toc-headings"><li><a href="#settings-and-tasks">Settings and tasks</a></li><li><a href="#main-and-test-sources">Main and test sources</a></li><li><a href="#integration-tests">Integration tests</a></li><li><a href="#multi-module-builds">Multi-module builds</a></li><li><a href="#enforce-in-ci">Enforce in CI</a></li><li><a href="#cache-in-ci">Cache in CI</a></li><li><a href="#run-scalafix-automatically-on-compile">Run Scalafix automatically on compile</a></li><li><a href="#run-custom-rules">Run custom rules</a></li><li><a href="#exclude-files-from-semanticdb-scala-2x-only">Exclude files from SemanticDB (Scala 2.x only)</a></li><li><a href="#exclude-files-from-scalafix">Exclude files from Scalafix</a></li><li><a href="#customize-semanticdb-output-directory">Customize SemanticDB output directory</a></li><li><a href="#disable-scalafix-for-specific-project">Disable Scalafix for specific project</a></li><li><a href="#enable-semanticdb-for-current-shell-session">Enable SemanticDB for current shell session</a></li><li><a href="#example-project">Example project</a></li></ul></li><li><a href="#command-line">Command line</a><ul class="toc-headings"><li><a href="#help">Help</a></li></ul></li><li><a href="#plugins-for-other-build-tools">Plugins for other build tools</a></li><li><a href="#snapshot">SNAPSHOT</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#15242B"><section class="sitemap"><a href="/scalafix/" class="nav-home"><img src="/scalafix/img/scalafix-brand-small2x.png" alt="Scalafix" width="52" height="52"/></a><div><h5>Docs</h5><a href="
/scalafix/docs/users/installation.html">Get started</a><a href="
Expand Down

0 comments on commit d09c1e6

Please sign in to comment.