Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on aadace9
  • Loading branch information
Docusaurus bot committed Sep 27, 2024
1 parent a9694fa commit 3ddc702
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/developers/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h2><a class="anchor" aria-hidden="true" id="packages"></a><a href="#packages" a
<p>The Scalafix public API documentation is composed of several packages.</p>
<h3><a class="anchor" aria-hidden="true" id="scalafix-v1"></a><a href="#scalafix-v1" 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>Scalafix v1</h3>
<p>Latest Scaladoc:
<a href="https://static.javadoc.io/ch.epfl.scala/scalafix-core_2.12/0.12.1/scalafix/v1/index.html">v0.12.1</a></p>
<a href="https://static.javadoc.io/ch.epfl.scala/scalafix-core_2.12/0.13.0/scalafix/v1/index.html">v0.13.0</a></p>
<p>The Scalafix v1 API is available through <code>import scalafix.v1._</code>. Key data
structures include:</p>
<ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/developers/setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ <h3><a class="anchor" aria-hidden="true" id="running-a-single-test"></a><a href=
<h2><a class="anchor" aria-hidden="true" id="library-api"></a><a href="#library-api" 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>Library API</h2>
<p>To test custom Scalafix rules outside of sbt use the library API of
<code>scalafix-testkit</code> directly. Start by adding a dependency on the
<a href="https://search.maven.org/artifact/ch.epfl.scala/scalafix-testkit_2.12.20/0.12.1/jar">scalafix-testkit</a>
<a href="https://search.maven.org/artifact/ch.epfl.scala/scalafix-testkit_2.12.20/0.13.0/jar">scalafix-testkit</a>
artifact</p>
<pre><code class="hljs">cs fetch ch.epfl.scala:scalafix-testkit_2<span class="hljs-number">.12</span><span class="hljs-number">.20</span>:<span class="hljs-number">0.12</span><span class="hljs-number">.1</span>
<pre><code class="hljs">cs fetch ch.epfl.scala:scalafix-testkit_2<span class="hljs-number">.12</span><span class="hljs-number">.20</span>:<span class="hljs-number">0.13</span><span class="hljs-number">.0</span>
</code></pre>
<p>Next, create a test suite that extends <code>AbstractSemanticRuleSuite</code></p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">package</span> myproject
Expand All @@ -173,7 +173,7 @@ <h2><a class="anchor" aria-hidden="true" id="library-api"></a><a href="#library-
directories for the input and output sources. To learn more about what values
should go into <code>scalafix-testkit.properties</code>, consult the Scaladocs.</p>
<p>Latest Scaladoc:
<a href="https://static.javadoc.io/ch.epfl.scala/scalafix-testkit_2.12.20/0.12.1/scalafix/testkit/TestkitProperties.html"><code>TestkitProperties</code></a></p>
<a href="https://static.javadoc.io/ch.epfl.scala/scalafix-testkit_2.12.20/0.13.0/scalafix/testkit/TestkitProperties.html"><code>TestkitProperties</code></a></p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/scalafix/docs/developers/before-you-begin.html"><span>Before you write code</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#sbt">sbt</a><ul class="toc-headings"><li><a href="#import-into-intellij">Import into IntelliJ</a></li><li><a href="#customizing-input-and-output-projects">Customizing input and output projects</a></li><li><a href="#running-a-single-test">Running a single test</a></li></ul></li><li><a href="#library-api">Library API</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="
/scalafix/docs/rules/overview.html">Rules</a><a href="
Expand Down
48 changes: 24 additions & 24 deletions docs/developers/symbol-information.html
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/Any#getClass(). =&gt; final method getClass(): Class,</span>
<span class="hljs-comment">// scala/Any#`##`(). =&gt; final method ##(): Int,</span>
<span class="hljs-comment">// scala/Option#foreach(). =&gt; @inline final method foreach[U](f: Function1[A, U]): Unit,</span>
<span class="hljs-comment">// scala/Option#exists(). =&gt; @inline final method exists(p: Function1[A, Boolean]): Boolean,</span>
<span class="hljs-comment">// scala/Any#equals(). =&gt; abstract method equals(that: Any): Boolean</span>
<span class="hljs-comment">// scala/Option#isDefined(). =&gt; final method isDefined: Boolean,</span>
<span class="hljs-comment">// scala/Any#`==`(). =&gt; final method ==(that: Any): Boolean,</span>
<span class="hljs-comment">// scala/Product#productElement(). =&gt; abstract method productElement(n: Int): Any,</span>
<span class="hljs-comment">// scala/Any#equals(). =&gt; abstract method equals(that: Any): Boolean,</span>
<span class="hljs-comment">// scala/Any#`##`(). =&gt; final method ##(): Int</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/Object#equals(). =&gt; method equals(param0: Object): Boolean,</span>
<span class="hljs-comment">// java/lang/String#lastIndexOf(). =&gt; method lastIndexOf(param0: Int): Int,</span>
<span class="hljs-comment">// java/lang/String#equalsIgnoreCase(). =&gt; method equalsIgnoreCase(param0: String): Boolean,</span>
<span class="hljs-comment">// java/lang/Object#clone(). =&gt; protected method clone(): Object,</span>
<span class="hljs-comment">// java/lang/String#split(+1). =&gt; method split(param0: String): Array[String]</span>
<span class="hljs-comment">// java/lang/Object#finalize(). =&gt; protected method finalize(): Unit,</span>
<span class="hljs-comment">// java/lang/Object#hashCode(). =&gt; method hashCode(): Int,</span>
<span class="hljs-comment">// java/lang/Object#finalize(). =&gt; protected method finalize(): Unit,</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/String#replaceAll(). =&gt; method replaceAll(param0: String, param1: String): String</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/Any#getClass(). =&gt; final method getClass(): Class,</span>
<span class="hljs-comment">// scala/Any#equals(). =&gt; abstract method equals(that: Any): Boolean,</span>
<span class="hljs-comment">// scala/PartialFunction#unapply(). =&gt; method unapply(a: A): Option[B],</span>
<span class="hljs-comment">// scala/collection/IterableOnceOps#toArray(). =&gt; method toArray[B &gt;: A](implicit evidence$2: ClassTag[B]): Array[B],</span>
<span class="hljs-comment">// scala/collection/IterableOps#sizeCompare(+1). =&gt; method sizeCompare(that: Iterable[_] forSome { type _ }): Int</span>
<span class="hljs-comment">// scala/collection/LinearSeqOps#exists(). =&gt; method exists(p: Function1[A, Boolean]): Boolean,</span>
<span class="hljs-comment">// scala/collection/IterableOnceOps#flatten(). =&gt; abstract method flatten[B](implicit asIterable: Function1[A, IterableOnce[B]]): CC[B],</span>
<span class="hljs-comment">// scala/collection/IterableOps#scan(). =&gt; method scan[B &gt;: A](z: B)(op: Function2[B, B, B]): CC[B],</span>
<span class="hljs-comment">// scala/collection/IterableOps#collect(). =&gt; method collect[B](pf: PartialFunction[A, B]): CC[B],</span>
<span class="hljs-comment">// scala/collection/SeqOps#`++:`(). =&gt; @inline final method ++:[B &gt;: A](prefix: IterableOnce[B]): CC[B]</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(+4). =&gt; static method valueOf(param0: Char): String,</span>
<span class="hljs-comment">// java/lang/String#rangeCheck(). =&gt; private static method rangeCheck(param0: Array[Char], param1: Int, param2: Int): Void,</span>
<span class="hljs-comment">// java/lang/String#valueOf(+7). =&gt; static method valueOf(param0: Float): String</span>
<span class="hljs-comment">// java/lang/String#valueOf(+3). =&gt; static method valueOf(param0: Boolean): String,</span>
<span class="hljs-comment">// java/lang/String#copyValueOf(+1). =&gt; static method copyValueOf(param0: Array[Char]): String,</span>
<span class="hljs-comment">// java/lang/String#valueOf(+4). =&gt; static method valueOf(param0: Char): String</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/CharSequence#chars(). =&gt; default method chars(): IntStream,</span>
<span class="hljs-comment">// java/lang/String#concat(). =&gt; method concat(param0: String): String,</span>
<span class="hljs-comment">// java/lang/String#isBlank(). =&gt; method isBlank(): Boolean</span>
<span class="hljs-comment">// java/lang/String#offsetByCodePoints(). =&gt; method offsetByCodePoints(param0: Int, param1: Int): Int,</span>
<span class="hljs-comment">// java/lang/String#split(+1). =&gt; method split(param0: String): Array[String],</span>
<span class="hljs-comment">// java/lang/Object#equals(). =&gt; method equals(param0: Object): Boolean</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 @@ -482,9 +482,9 @@ <h3><a class="anchor" aria-hidden="true" id="lookup-method-overloads"></a><a hre
<span class="hljs-comment">// )</span>
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(+2). =&gt; method print(param0: Int): Unit,</span>
<span class="hljs-comment">// java/io/PrintStream#print(+5). =&gt; method print(param0: Double): 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(+1). =&gt; method print(param0: Char): Unit,</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(+2). =&gt; method print(param0: Int): Unit</span>
<span class="hljs-comment">// )</span>
</code></pre>
<p>Overloaded methods can be inherited from supertypes.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/tutorial.html
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ <h2><a class="anchor" aria-hidden="true" id="use-symbolinformation-to-lookup-met
<li><code>Tree.symbol</code> returns a <code>Symbol</code>, which represents the unique identifier of
definition such as a <code>val</code> or a <code>class</code>.</li>
<li><code>Symbol.info</code> returns a
<a href="https://static.javadoc.io/ch.epfl.scala/scalafix-core_2.12/0.12.1/scalafix/v1/SymbolInformation.html"><code>SymbolInformation</code></a>,
<a href="https://static.javadoc.io/ch.epfl.scala/scalafix-core_2.12/0.13.0/scalafix/v1/SymbolInformation.html"><code>SymbolInformation</code></a>,
which contains metadata about that symbol.</li>
</ul>
<p>Next, we use <code>SymbolInformation.signature</code> to see if the symbol is a method with
Expand Down
Loading

0 comments on commit 3ddc702

Please sign in to comment.