Skip to content

Commit

Permalink
Deployed dcec7ba to dev-snapshot with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Ktlint Release Workflow committed Apr 23, 2024
1 parent a276e01 commit bdaabbe
Show file tree
Hide file tree
Showing 4 changed files with 694 additions and 650 deletions.
123 changes: 85 additions & 38 deletions dev-snapshot/rules/configuration-intellij-idea/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">


<a href="#intellij-idea-configuration" class="md-skip">
Skip to content
</a>

</div>
<div data-md-component="announce">

Expand Down Expand Up @@ -775,6 +780,19 @@
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">





<label class="md-nav__link md-nav__link--active" for="__toc">


<span class="md-ellipsis">
IntelliJ IDEA configuration
</span>


<span class="md-nav__icon md-icon"></span>
</label>

<a href="./" class="md-nav__link md-nav__link--active">

Expand All @@ -786,6 +804,34 @@

</a>



<nav class="md-nav md-nav--secondary" aria-label="Table of contents">






<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#preventing-conflicts" class="md-nav__link">
<span class="md-ellipsis">
Preventing conflicts
</span>
</a>

</li>

</ul>

</nav>

</li>


Expand Down Expand Up @@ -1101,6 +1147,25 @@






<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#preventing-conflicts" class="md-nav__link">
<span class="md-ellipsis">
Preventing conflicts
</span>
</a>

</li>

</ul>

</nav>
</div>
Expand All @@ -1118,44 +1183,26 @@



<h1>IntelliJ IDEA configuration</h1>

<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><code>ktlint</code> strives to prevent code formatting conflicts with IntelliJ IDEA / Android Studio. We recommend using either IDE formatting or <code>ktlint</code> formatting. However, if you persist on using both, then please ensure that the formatting settings are aligned as described below. This reduces the chance that code which is formatted by ktlint conflicts with formatting by the IntelliJ IDEA built-in formatter.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>IntelliJ IDEA supports the <a href="https://kotlinlang.org/docs/coding-conventions.html">kotlin coding conventions</a>. As of version 0.47.x of ktlint, the support to overwrite some configuration files of IntelliJ IDEA has been dropped as it no longer fits the scope of the project. </p>
</div>
<p>Steps:</p>
<ol>
<li>Go to your project directory</li>
<li>Create or replace file <code>.idea/codeStyles/codeStyleConfig.xml</code> with content below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">&lt;component</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;ProjectCodeStyleConfiguration&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">&lt;state&gt;</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;USE_PER_PROJECT_SETTINGS&quot;</span><span class="w"> </span><span class="na">value=</span><span class="s">&quot;true&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">&lt;/state&gt;</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="nt">&lt;/component&gt;</span>
</code></pre></div></li>
<li>Create or replace file <code>.idea/codeStyles/Project.xml</code> with content below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">&lt;component</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;ProjectCodeStyleConfiguration&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt">&lt;code_scheme</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;Project&quot;</span><span class="w"> </span><span class="na">version=</span><span class="s">&quot;173&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">&lt;JetCodeStyleSettings&gt;</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;PACKAGES_TO_USE_STAR_IMPORTS&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">&lt;value</span><span class="w"> </span><span class="nt">/&gt;</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">&lt;/option&gt;</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;NAME_COUNT_TO_USE_STAR_IMPORT&quot;</span><span class="w"> </span><span class="na">value=</span><span class="s">&quot;2147483647&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;NAME_COUNT_TO_USE_STAR_IMPORT_FOR_MEMBERS&quot;</span><span class="w"> </span><span class="na">value=</span><span class="s">&quot;2147483647&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;CODE_STYLE_DEFAULTS&quot;</span><span class="w"> </span><span class="na">value=</span><span class="s">&quot;KOTLIN_OFFICIAL&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="nt">&lt;/JetCodeStyleSettings&gt;</span>
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="nt">&lt;codeStyleSettings</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;kotlin&quot;</span><span class="nt">&gt;</span>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w"> </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;CODE_STYLE_DEFAULTS&quot;</span><span class="w"> </span><span class="na">value=</span><span class="s">&quot;KOTLIN_OFFICIAL&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w"> </span><span class="nt">&lt;/codeStyleSettings&gt;</span>
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="nt">&lt;/code_scheme&gt;</span>
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="nt">&lt;/component&gt;</span>
</code></pre></div></li>
</ol>
<h1 id="intellij-idea-configuration">Intellij IDEA configuration<a class="headerlink" href="#intellij-idea-configuration" title="Permanent link">&para;</a></h1>
<p><code>ktlint</code> strives to prevent code formatting conflicts with IntelliJ IDEA / Android Studio as much as possible. In some cases, <code>ktlint</code> deliberately deviates from IDEA formatting.</p>
<h2 id="preventing-conflicts">Preventing conflicts<a class="headerlink" href="#preventing-conflicts" title="Permanent link">&para;</a></h2>
<p>Many conflicts can be prevented by setting following <code>.editorconfig</code> settings:
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>root = true
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>[*]
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>insert_final_newline = true
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>[{*.kt,*.kts}]
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a># Disable wildcard imports entirely
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>ij_kotlin_name_count_to_use_star_import = 2147483647
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>ij_kotlin_packages_to_use_import_on_demand = unset
</code></pre></div></p>
<p>Conflicts between <code>ktlint</code> and IDEA formatting can also be resolved by using the <a href="https://plugins.jetbrains.com/plugin/15057-ktlint">ktlint-intellij-plugin</a> (or install via Intellij IDEA plugin marketplace) in <code>distract free</code> mode. In this mode, the plugin formats your code with <code>ktlint</code> while you're editing the code.</p>
<h1 id="cleaning-up-old-xml-configuration-settings">Cleaning up old XML configuration settings<a class="headerlink" href="#cleaning-up-old-xml-configuration-settings" title="Permanent link">&para;</a></h1>
<p>Projects which have been created with (old)er versions of Intellij IDEA might still contain XML configuration regarding code styling. It is advised to remove the directory <code>.idea/codeStyles</code> whenever it still exists in your project directory.</p>



Expand Down

0 comments on commit bdaabbe

Please sign in to comment.