Skip to content

Commit 8486bc8

Browse files
committed
Deployed ad5accf with MkDocs version: 1.6.1
1 parent a2221ae commit 8486bc8

2 files changed

Lines changed: 36 additions & 41 deletions

File tree

‎releases/index.html‎

Lines changed: 35 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -665,10 +665,10 @@
665665
</li>
666666

667667
<li class="md-nav__item">
668-
<a href="#cli-output-enhancements" class="md-nav__link">
668+
<a href="#cli-improvements" class="md-nav__link">
669669
<span class="md-ellipsis">
670670

671-
🖥️ CLI Output Enhancements
671+
🖥️ CLI Improvements
672672

673673
</span>
674674
</a>
@@ -954,10 +954,10 @@
954954
</li>
955955

956956
<li class="md-nav__item">
957-
<a href="#cli-output-enhancements" class="md-nav__link">
957+
<a href="#cli-improvements" class="md-nav__link">
958958
<span class="md-ellipsis">
959959

960-
🖥️ CLI Output Enhancements
960+
🖥️ CLI Improvements
961961

962962
</span>
963963
</a>
@@ -1212,64 +1212,59 @@ <h1 id="release-notes">Release Notes<a class="headerlink" href="#release-notes"
12121212
<hr />
12131213
<h2 id="v130">v1.3.0<a class="headerlink" href="#v130" title="Link to this section">&para;</a></h2>
12141214
<p><em>Released on July 31, 2026</em></p>
1215-
<p>This release introduces direct source code scanning for local Kotlin and Java project directories, mapping exact declaration source locations (file path, line, and column) and imports directly into the unified API database index.</p>
1215+
<p>This release introduces scan-source, enabling Library Insight to analyze local Kotlin and Java source projects without compilation. Source declarations, documentation, imports, and precise source locations are indexed into the same unified API database used for compiled libraries.</p>
12161216
<h3 id="raw-source-directory-scanner-scan-source">🔍 Raw Source Directory Scanner (<code>scan-source</code>)<a class="headerlink" href="#raw-source-directory-scanner-scan-source" title="Link to this section">&para;</a></h3>
1217-
<p>Scan raw source code directories containing Kotlin (<code>.kt</code>) and Java (<code>.java</code>) files without compiling them. It generates the exact same unified API index database as the compiled <code>scan</code> pipeline, meaning all downstream commands (<code>search</code>, <code>explain</code>, <code>export</code>, <code>ai-export</code>) function seamlessly.</p>
1217+
<p>Scan raw source code directories containing Kotlin (<code>.kt</code>) and Java (<code>.java</code>) files without compiling them. It generates the same unified API index as the existing scan command, allowing existing commands such as search, explain, export, and ai-export to work without any workflow changes.</p>
12181218
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>library-insight<span class="w"> </span>scan-source<span class="w"> </span>app/src/main
12191219
</span></code></pre></div>
1220-
<p><strong>Features:</strong>
1221-
- <strong>Java Parser Integration</strong>: Uses JavaParser to parse Java classes, interfaces, enums, records, constructors, methods, properties, modifiers, annotations, generics, and Javadocs.
1222-
- <strong>Kotlin PSI Integration</strong>: Uses the official Kotlin compiler embeddable (<code>kotlin-compiler-embeddable</code>) and PSI parser to traverse syntax trees, preserving KDocs, class modifiers (data, sealed, value, inner, open, abstract), companion objects, secondary constructors, and extension receiver types.</p>
1220+
<p><strong>Features:</strong></p>
1221+
<ul>
1222+
<li><strong>Java Source Parsing</strong>: Uses JavaParser to extract classes, interfaces, enums, records, constructors, methods, fields, generics, annotations, modifiers, and Javadocs.</li>
1223+
<li><strong>Kotlin Source Parsing</strong>: Uses the official Kotlin compiler PSI (<code>kotlin-compiler-embeddable</code>) to extract KDoc, modifiers, companion objects, secondary constructors, extension receivers, generics, and Kotlin-specific language features.</li>
1224+
</ul>
12231225
<h3 id="source-location-imports-indexing">📍 Source Location &amp; Imports Indexing<a class="headerlink" href="#source-location-imports-indexing" title="Link to this section">&para;</a></h3>
12241226
<ul>
1225-
<li><strong>Source Pointers</strong>: Persists the relative file path, line number, and column for every class, constructor, method, and property.</li>
1227+
<li><strong>Source Locations</strong>: Stores the relative file path, line number, and column for every indexed class, constructor, method, and property.</li>
12261228
<li><strong>Import Statements</strong>: Persists file-level import lists inside the class API model, helpful for dependency analysis and code structure auditing.</li>
12271229
<li><strong>Backward-Compatible Database</strong>: Existing bytecode-scanned indices are backward-compatible and load seamlessly without schema validation breaks.</li>
12281230
</ul>
1229-
<h3 id="cli-output-enhancements">🖥️ CLI Output Enhancements<a class="headerlink" href="#cli-output-enhancements" title="Link to this section">&para;</a></h3>
1231+
<h3 id="cli-improvements">🖥️ CLI Improvements<a class="headerlink" href="#cli-improvements" title="Link to this section">&para;</a></h3>
12301232
<ul>
1231-
<li><strong><code>scan-source</code> statistics</strong>: The console prints clean statistics on scanned file types:
1232-
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>Scanning source directory: app/src/main
1233-
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
1234-
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>Detected:
1235-
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a> • Kotlin files : 82
1236-
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a> • Java files : 14
1237-
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>
1238-
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>Scan complete!
1239-
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>Found 143 classes across 18 packages.
1240-
</span></code></pre></div></li>
1241-
<li><strong><code>search</code> source locations</strong>: Whenever available, search results display declaration files and line numbers directly below matched symbols.</li>
1242-
<li><strong><code>explain</code> reports</strong>: The class explain template now displays <code>Source</code> file locations at the header, <code>Imports</code> imports list (if any), and source file/line markers next to each property and method.</li>
1233+
<li>scan-source displays Kotlin/Java file statistics and indexing progress.</li>
1234+
<li>search now shows declaration source locations when available.</li>
1235+
<li>explain now displays source locations, imports, and declaration locations for methods and properties.</li>
12431236
</ul>
12441237
<hr />
12451238
<h2 id="v120">v1.2.0<a class="headerlink" href="#v120" title="Link to this section">&para;</a></h2>
12461239
<p><em>Released on July 29, 2026</em></p>
12471240
<p>This major update introduces deep Kotlin DSL analysis, bytecode call graph visualization, automated example generation, package health metrics, and compile-time ABI linkage checks to prevent runtime errors.</p>
12481241
<h3 id="kotlin-dsl-fluent-api-report-dsl-report">🧩 Kotlin DSL &amp; Fluent API Report (<code>dsl-report</code>)<a class="headerlink" href="#kotlin-dsl-fluent-api-report-dsl-report" title="Link to this section">&para;</a></h3>
1249-
<p>Expose the structure of DSL-heavy libraries. Scans and groups:
1250-
- <strong>Type aliases</strong> — extracted from package metadata.
1251-
- <strong>DSL scopes</strong> — classes carrying <code>@DslMarker</code> annotations.
1252-
- <strong>Extension functions</strong> — mapped to their receiver types.
1253-
- <strong>Lambda builders</strong> — functions taking lambda-with-receiver blocks.
1254-
- <strong>Inline reified entry points</strong>.</p>
1242+
<p>Expose the structure of DSL-heavy libraries. Scans and groups:</p>
1243+
<ul>
1244+
<li><strong>Type aliases</strong> — extracted from package metadata.</li>
1245+
<li><strong>DSL scopes</strong> — classes carrying <code>@DslMarker</code> annotations.</li>
1246+
<li><strong>Extension functions</strong> — mapped to their receiver types.</li>
1247+
<li><strong>Lambda builders</strong> — functions taking lambda-with-receiver blocks.</li>
1248+
<li><strong>Inline reified entry points</strong>.</li>
1249+
</ul>
12551250
<p><em>Also registered as the <code>dsl_report</code> tool on the MCP server!</em></p>
1256-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>library-insight<span class="w"> </span>dsl-report
1251+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>library-insight<span class="w"> </span>dsl-report
12571252
</span></code></pre></div>
12581253
<h3 id="method-call-graph-generator-callgraph">🌳 Method Call Graph Generator (<code>callgraph</code>)<a class="headerlink" href="#method-call-graph-generator-callgraph" title="Link to this section">&para;</a></h3>
12591254
<p>Recursively traces method call instructions to render a visual tree of internal invocations inside the bytecode. Excellent for understanding execution flows and auditing internals.</p>
1260-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>library-insight<span class="w"> </span>callgraph<span class="w"> </span>HtmlBuilder.div
1255+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>library-insight<span class="w"> </span>callgraph<span class="w"> </span>HtmlBuilder.div
12611256
</span></code></pre></div>
12621257
<h3 id="automatic-examples-generator-examples">📝 Automatic Examples Generator (<code>examples</code>)<a class="headerlink" href="#automatic-examples-generator-examples" title="Link to this section">&para;</a></h3>
12631258
<p>Generates typical instantiation patterns (constructors, builders, factories, singletons) from bytecode signatures, and extracts code blocks from Dokka/README markdown files.</p>
1264-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>library-insight<span class="w"> </span>examples<span class="w"> </span>HtmlBuilder
1259+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>library-insight<span class="w"> </span>examples<span class="w"> </span>HtmlBuilder
12651260
</span></code></pre></div>
12661261
<h3 id="package-health-complexity-health">🩺 Package Health &amp; Complexity (<code>health</code>)<a class="headerlink" href="#package-health-complexity-health" title="Link to this section">&para;</a></h3>
12671262
<p>Analyzes structural complexity indices, public API distributions (classes, methods, properties), and deprecation ratios to grade the library.</p>
1268-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>library-insight<span class="w"> </span>health
1263+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>library-insight<span class="w"> </span>health
12691264
</span></code></pre></div>
12701265
<h3 id="classpath-abi-linkage-detector-dependency-check">🚨 Classpath ABI Linkage Detector (<code>dependency-check</code>)<a class="headerlink" href="#classpath-abi-linkage-detector-dependency-check" title="Link to this section">&para;</a></h3>
12711266
<p>Checks compiled transitive dependencies for method and field signatures missing from the classpath. Proactively flags runtime risks such as <code>NoSuchMethodError</code>, <code>NoSuchFieldError</code>, or <code>LinkageError</code>.</p>
1272-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>library-insight<span class="w"> </span>dependency-check
1267+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>library-insight<span class="w"> </span>dependency-check
12731268
</span></code></pre></div>
12741269
<h3 id="mcp-server-enhancements">⚙️ MCP Server Enhancements<a class="headerlink" href="#mcp-server-enhancements" title="Link to this section">&para;</a></h3>
12751270
<ul>
@@ -1283,7 +1278,7 @@ <h2 id="v110">v1.1.0<a class="headerlink" href="#v110" title="Link to this secti
12831278
<p>This release evolves Library Insight from a CLI scanner into a full <strong>JVM API Explorer &amp; MCP Server</strong> — your AI IDE can now use it automatically, without any manual commands.</p>
12841279
<h3 id="mcp-server-model-context-protocol">🔌 MCP Server (Model Context Protocol)<a class="headerlink" href="#mcp-server-model-context-protocol" title="Link to this section">&para;</a></h3>
12851280
<p>Connect Cursor, Claude Desktop, or any MCP-compatible IDE directly. AI agents can call <code>scan_library</code>, <code>search_symbols</code>, and <code>explain_class</code> natively without leaving the editor.</p>
1286-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>library-insight<span class="w"> </span>mcp
1281+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>library-insight<span class="w"> </span>mcp
12871282
</span></code></pre></div>
12881283
<h3 id="migration-advisor-migrate">🔄 Migration Advisor (<code>migrate</code>)<a class="headerlink" href="#migration-advisor-migrate" title="Link to this section">&para;</a></h3>
12891284
<p>Compare two library versions and get a structured report of:</p>
@@ -1293,23 +1288,23 @@ <h3 id="migration-advisor-migrate">🔄 Migration Advisor (<code>migrate</code>)
12931288
<li>✅ Added APIs</li>
12941289
</ul>
12951290
<p>Perfect for upgrading Retrofit, OkHttp, Compose, or Kotlin.</p>
1296-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>library-insight<span class="w"> </span>migrate<span class="w"> </span>com.squareup.retrofit2:retrofit:2.9.0<span class="w"> </span>com.squareup.retrofit2:retrofit:2.11.0
1291+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>library-insight<span class="w"> </span>migrate<span class="w"> </span>com.squareup.retrofit2:retrofit:2.9.0<span class="w"> </span>com.squareup.retrofit2:retrofit:2.11.0
12971292
</span></code></pre></div>
12981293
<h3 id="dependency-api-audit-audit">🔍 Dependency API Audit (<code>audit</code>)<a class="headerlink" href="#dependency-api-audit-audit" title="Link to this section">&para;</a></h3>
12991294
<p>Scan all project Gradle dependencies recursively and report deprecated classes, methods, and properties found in the actual bytecode.</p>
1300-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>library-insight<span class="w"> </span>audit
1295+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>library-insight<span class="w"> </span>audit
13011296
</span></code></pre></div>
13021297
<h3 id="dependency-graph-dependency-graph">🌳 Dependency Graph (<code>dependency-graph</code>)<a class="headerlink" href="#dependency-graph-dependency-graph" title="Link to this section">&para;</a></h3>
13031298
<p>Print a visual recursive tree of transitive compile dependencies from POM descriptors.</p>
1304-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>library-insight<span class="w"> </span>dependency-graph<span class="w"> </span>com.github.ajalt.clikt:clikt-jvm:4.4.0
1299+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>library-insight<span class="w"> </span>dependency-graph<span class="w"> </span>com.github.ajalt.clikt:clikt-jvm:4.4.0
13051300
</span></code></pre></div>
13061301
<h3 id="search-maven-central-search-central">🔎 Search Maven Central (<code>search-central</code>)<a class="headerlink" href="#search-maven-central-search-central" title="Link to this section">&para;</a></h3>
13071302
<p>Find Maven coordinates and versions without leaving the terminal.</p>
1308-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>library-insight<span class="w"> </span>search-central<span class="w"> </span>retrofit
1303+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>library-insight<span class="w"> </span>search-central<span class="w"> </span>retrofit
13091304
</span></code></pre></div>
13101305
<h3 id="semver-compliance-checker-semver">✅ SemVer Compliance Checker (<code>semver</code>)<a class="headerlink" href="#semver-compliance-checker-semver" title="Link to this section">&para;</a></h3>
13111306
<p>Verify that a version bump correctly reflects the actual bytecode changes. Flags unbumped breaking changes.</p>
1312-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>library-insight<span class="w"> </span>semver<span class="w"> </span>com.squareup.retrofit2:retrofit:2.9.0<span class="w"> </span>com.squareup.retrofit2:retrofit:2.11.0
1307+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>library-insight<span class="w"> </span>semver<span class="w"> </span>com.squareup.retrofit2:retrofit:2.9.0<span class="w"> </span>com.squareup.retrofit2:retrofit:2.11.0
13131308
</span></code></pre></div>
13141309
<h3 id="other-improvements">📋 Other Improvements<a class="headerlink" href="#other-improvements" title="Link to this section">&para;</a></h3>
13151310
<ul>

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)