Current section

42 Versions

Jump to

Compare versions

4 files changed
+31 additions
-4 deletions
  @@ -5,6 +5,15 @@ See [Conventional Commits](Https://conventionalcommits.org) for commit guideline
5 5
6 6 <!-- changelog -->
7 7
8 + ## v0.1.21 (2025-07-17)
9 +
10 +
11 +
12 +
13 + ### Improvements:
14 +
15 + * only show notice about local docs when module is compiled by Zach Daniel
16 +
8 17 ## v0.1.20 (2025-07-17)
  @@ -6,7 +6,7 @@
6 6 {<<"GitHub">>,<<"https://github.com/ash-project/usage_rules">>},
7 7 {<<"Website">>,<<"https://ash-hq.org">>}]}.
8 8 {<<"name">>,<<"usage_rules">>}.
9 - {<<"version">>,<<"0.1.20">>}.
9 + {<<"version">>,<<"0.1.21">>}.
10 10 {<<"description">>,
11 11 <<"A dev tool for Elixir projects to gather LLM usage rules from dependencies">>}.
12 12 {<<"elixir">>,<<"~> 1.18">>}.
  @@ -172,17 +172,35 @@ defmodule Mix.Tasks.UsageRules.SearchDocs do
172 172 :error ->
173 173 ""
174 174
175 - _ ->
175 + other ->
176 + show? =
177 + case other do
178 + {{:__aliases__, _, parts}, _} -> compiled?(parts)
179 + {:{}, [], [{:__aliases__, _, parts}, _, _]} -> compiled?(parts)
180 + {:__aliases__, _, parts} -> compiled?(parts)
181 + _ -> false
182 + end
183 +
184 + if show? do
176 185 """
177 - For module or function docs in the current app, run:
186 + For local docs, run:
178 187
179 188 mix usage_rules.docs #{term}
180 189 """
190 + else
191 + ""
192 + end
181 193 end
182 194
183 195 header <> results <> docs_hint
184 196 end
185 197
198 + defp compiled?(parts) do
199 + parts
200 + |> Module.concat()
201 + |> Code.ensure_loaded?()
202 + end
203 +
186 204 defp format_search_result_markdown(hit, index, current_page, per_page) do
187 205 %{
188 206 "document" => %{
  @@ -1,7 +1,7 @@
1 1 defmodule UsageRules.MixProject do
2 2 use Mix.Project
3 3
4 - @version "0.1.20"
4 + @version "0.1.21"
5 5 @description """
6 6 A dev tool for Elixir projects to gather LLM usage rules from dependencies
7 7 """