move lazy_doc under priv dir, release 0.5.2

Author: pxp9

README.md

@@ -11,7 +11,7 @@ defmodule LazyDoc do
   It implements functions to read files matching a given path pattern, extract their AST and comments, group function definitions by names and arities, filter out undocumented functions and modules, and retrieve associated documentation for the extracted modules. The module serves as a utility for generating or managing documentation for Elixir projects.
   """
 
-  @doc File.read!("lazy_doc/lazy_doc/extract_data_from_files.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/extract_data_from_files.md")
   def extract_data_from_files() do
     patterns =
       Application.get_env(:lazy_doc, :patterns, [
@@ -83,7 +83,7 @@ defmodule LazyDoc do
     end)
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/join_code_from_clauses.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/join_code_from_clauses.md")
   def join_code_from_clauses(names) do
     join_code_from_clauses(names, [])
   end
@@ -146,7 +146,7 @@ defmodule LazyDoc do
     end
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/extract_names.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/extract_names.md")
 
   # TO_DO: support defprotocol and defimpl
   def extract_names(ast) do
@@ -253,7 +253,7 @@ defmodule LazyDoc do
     acc
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/filter_undocumented_functions.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/filter_undocumented_functions.md")
   def filter_undocumented_functions(
         {module, module_ast, _code_mod, functions},
         {_mod, {_module_doc, function_docs}}
@@ -271,7 +271,7 @@ defmodule LazyDoc do
     {module, module_ast, functions}
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/filter_documented_functions.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/filter_documented_functions.md")
   def filter_documented_functions(
         {module, module_ast, _code_mod, functions},
         {_mod, {_module_doc, function_docs}}
@@ -285,7 +285,7 @@ defmodule LazyDoc do
     {module, module_ast, functions}
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/filter_undocumented_modules.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/filter_undocumented_modules.md")
   def filter_undocumented_modules(zip_to_process) do
     Enum.filter(zip_to_process, fn
       {_names_module, {_mod, {module_doc, _function_docs}}} ->
@@ -309,7 +309,7 @@ defmodule LazyDoc do
              signature: [binary()],
              metadata: map()
 
-  @doc File.read!("lazy_doc/lazy_doc/docs_per_module.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/docs_per_module.md")
   def docs_per_module(modules) do
     Enum.map(modules, fn module ->
       {:docs_v1, _annotation, _beam_language, _format, module_doc, _metadata, function_docs} =
@@ -325,7 +325,7 @@ defmodule LazyDoc do
     end)
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/group_docs_different_arities.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/group_docs_different_arities.md")
   def group_docs_different_arities(func_docs) do
     Enum.group_by(
       func_docs,

lib/lazy_doc.ex

@@ -11,7 +11,7 @@ defmodule LazyDoc.Application do
   """
   use Application
 
-  @doc File.read!("lazy_doc/lazy_doc/application/start.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/application/start.md")
   def start(_start_type, _start_args) do
     {:ok, self()}
   end

lib/lazy_doc/application.ex

@@ -6,7 +6,7 @@ defmodule LazyDoc.Example do
   the task provided.
   """
 
-  @doc File.read!("lazy_doc/lazy_doc/example/my_func_2.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/example/my_func_2.md")
 
   ## This comment is just to ilustrate that the algorithm will
   ## take the comments
@@ -23,15 +23,15 @@ defmodule LazyDoc.Example do
     "is #{inspect(n)}"
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/example/hello.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/example/hello.md")
   def hello do
     :world
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/example/func_without_doc.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/example/func_without_doc.md")
   def func_without_doc(), do: IO.puts("Hello world")
 
-  @doc File.read!("lazy_doc/lazy_doc/example/my_func.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/example/my_func.md")
   def my_func(1) do
     "is one"
   end

lib/lazy_doc/example.ex

@@ -24,24 +24,24 @@ defmodule LazyDoc.Provider do
           token :: binary(),
           params :: keyword()
         ) :: {:ok, Req.Response.t()} | {:error, Exception.t()}
-  @doc File.read!("lazy_doc/lazy_doc/provider/request_prompt.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/provider/request_prompt.md")
   def request_prompt(callback_module, prompt, model, token, params \\ []),
     do: callback_module.request_prompt(prompt, model, token, params)
 
   @callback get_docs_from_response(response :: Req.Response.t()) :: binary()
   @spec get_docs_from_response(callback_module :: module(), response :: Req.Response.t()) ::
           binary()
-  @doc File.read!("lazy_doc/lazy_doc/provider/get_docs_from_response.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/provider/get_docs_from_response.md")
   def get_docs_from_response(callback_module, response),
     do: callback_module.get_docs_from_response(response)
 
   @callback model(model :: atom()) :: binary()
   @spec model(callback_module :: module(), model :: atom()) :: binary()
-  @doc File.read!("lazy_doc/lazy_doc/provider/model.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/provider/model.md")
   def model(callback_module, model), do: callback_module.model(model)
 
   @callback check_parameters?(params :: keyword()) :: boolean()
   @spec check_parameters?(callback_module :: module(), params :: keyword()) :: boolean()
-  @doc File.read!("lazy_doc/lazy_doc/provider/check_parameters?.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/provider/check_parameters?.md")
   def check_parameters?(callback_module, params), do: callback_module.check_parameters?(params)
 end

lib/lazy_doc/provider.ex

@@ -17,13 +17,13 @@ defmodule LazyDoc.Providers.GithubAi do
   ## TO_DO: implement retry with customizable number of retries if fails but with default value.
   @spec request_prompt(binary(), binary(), binary(), keyword()) ::
           {:ok, Req.Response.t()} | {:error, Exception.t()}
-  @doc File.read!("lazy_doc/lazy_doc/providers/github_ai/request_prompt.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/providers/github_ai/request_prompt.md")
   def request_prompt(prompt, model, token, params \\ []) do
     req_query(prompt, model, token, params)
     |> Req.post()
   end
 
-  @doc File.read!("lazy_doc/lazy_doc/providers/github_ai/req_query.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/providers/github_ai/req_query.md")
   def req_query(prompt, model, token, params \\ []) do
     temperature = Keyword.get(params, :temperature, 1)
     top_p = Keyword.get(params, :top_p, 1)
@@ -55,15 +55,15 @@ defmodule LazyDoc.Providers.GithubAi do
   ## TO_DO: we should review if for each model in Github you have the same response format in the body.
   ## Maybe this premise is not true and it will require changes.
   @spec get_docs_from_response(Req.Response.t()) :: binary()
-  @doc File.read!("lazy_doc/lazy_doc/providers/github_ai/get_docs_from_response.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/providers/github_ai/get_docs_from_response.md")
   def get_docs_from_response(%Req.Response{body: body} = _response) do
     ## Take always first choice
     message = Enum.at(body["choices"], 0)["message"]["content"]
     message
   end
 
   @spec model(atom()) :: binary()
-  @doc File.read!("lazy_doc/lazy_doc/providers/github_ai/model.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/providers/github_ai/model.md")
   def model(model) do
     case model do
       :codestral -> "Codestral-2501"
@@ -73,7 +73,7 @@ defmodule LazyDoc.Providers.GithubAi do
   end
 
   @spec check_parameters?(params :: keyword()) :: boolean()
-  @doc File.read!("lazy_doc/lazy_doc/providers/github_ai/check_parameters?.md")
+  @doc File.read!("priv/lazy_doc/lazy_doc/providers/github_ai/check_parameters?.md")
   def check_parameters?(params) do
     valid_params = [:max_tokens, :top_p, :temperature]
     Enum.map(params, fn {key, _value} -> key in valid_params end) |> Enum.all?()

lib/lazy_doc/providers/github_ai.ex

@@ -12,7 +12,7 @@ defmodule Mix.Tasks.LazyDoc.Check do
   require Logger
   use Mix.Task
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.check/run.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.check/run.md")
   def run(_command_line_args) do
     _result = LazyDoc.Application.start("", "")
 
@@ -32,7 +32,7 @@ defmodule Mix.Tasks.LazyDoc.Check do
     end
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.check/get_undocumented_functions.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.check/get_undocumented_functions.md")
   def get_undocumented_functions(entry_functions, file) do
     Enum.reduce(entry_functions, [], fn {mod, _mod_ast, functions} = mod_tuple, acc ->
       if functions != [] do
@@ -44,7 +44,7 @@ defmodule Mix.Tasks.LazyDoc.Check do
     end)
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.check/print_warnings.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.check/print_warnings.md")
   def print_warnings(functions, mod, file) do
     Enum.each(functions, fn {:function, {name, _code}} ->
       Logger.warning("Function :#{name} in module `#{mod}` needs to be documented")
@@ -53,7 +53,7 @@ defmodule Mix.Tasks.LazyDoc.Check do
     Logger.info("file: #{file}")
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.check/get_undocumented_modules.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.check/get_undocumented_modules.md")
   def get_undocumented_modules(modules, file) do
     if modules != [] do
       Enum.each(modules, fn {mod, _mod_ast, _cod} ->

lib/mix/tasks/lazy_doc.check.ex

@@ -12,7 +12,7 @@ defmodule Mix.Tasks.LazyDoc.Clean do
   require Logger
   use Mix.Task
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.clean/run.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.clean/run.md")
   def run(_command_line_args) do
     _result = LazyDoc.Application.start("", "")
 
@@ -41,7 +41,7 @@ defmodule Mix.Tasks.LazyDoc.Clean do
   end
 
   ## It will work if we suppose @doc is on top of the function.
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.clean/delete_doc_from_ast.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.clean/delete_doc_from_ast.md")
   def delete_doc_from_ast(ast, module_ast, name_func) do
     {new_ast, _acc} =
       Macro.traverse(
@@ -98,7 +98,7 @@ defmodule Mix.Tasks.LazyDoc.Clean do
     new_ast
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc.clean/clean_tree?.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc.clean/clean_tree?.md")
   def clean_tree?() do
     "git"
     |> System.cmd(["diff-files", "--quiet"])

lib/mix/tasks/lazy_doc.clean.ex

@@ -18,7 +18,7 @@ defmodule Mix.Tasks.LazyDoc do
 
   @default_module_prompt ~s(You should describe what this module does based on the code given.\n\n Please do it in the following format given as an example, important do not return the code of the module, your output must be only the docs in the following format.\n\n@moduledoc """\n\n## Main functionality\n\nThe module GithubAi provides a way of communicating with Github AI API.\n\n## Description\n\nIt implements the behavior Provider a standard way to use a provider in LazyDoc.\n"""\n\nModule to document:\n)
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/run.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/run.md")
   def run(_command_line_args) do
     ## Start req
 
@@ -35,17 +35,17 @@ defmodule Mix.Tasks.LazyDoc do
     |> proccess_files()
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/docs_are_ok?.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/docs_are_ok?.md")
   def docs_are_ok?(docs) when is_binary(docs) do
     match?("@doc \" " <> _, docs) or match?("@doc \"\"\"\n" <> _, docs)
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/write_to_file.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/write_to_file.md")
   def write_to_file(file, ast) do
     File.write(file, Macro.to_string(ast))
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/write_to_file_formatted.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/write_to_file_formatted.md")
   def write_to_file_formatted(file, ast, comments) do
     line_length = Application.get_env(:lazy_doc, :line_length, 98)
 
@@ -59,7 +59,7 @@ defmodule Mix.Tasks.LazyDoc do
     File.write(file, to_write)
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/insert_doc_for_function.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/insert_doc_for_function.md")
   def insert_doc_for_function(ast, name_func, ast_doc, module_ast) do
     {new_ast, _acc} =
       Macro.traverse(
@@ -127,7 +127,7 @@ defmodule Mix.Tasks.LazyDoc do
     new_ast
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/proccess_files.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/proccess_files.md")
   def proccess_files(entries) do
     {provider_mod, model, params} = Application.get_env(:lazy_doc, :provider)
 
@@ -181,7 +181,7 @@ defmodule Mix.Tasks.LazyDoc do
     end)
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/insert_nodes_in_module.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/insert_nodes_in_module.md")
   def insert_nodes_in_module(
         {module, module_ast, functions},
         final_prompt,
@@ -213,7 +213,7 @@ defmodule Mix.Tasks.LazyDoc do
         to_string(module.module_info(:compile)[:source])
         |> String.split("/lib")
         |> Enum.at(1)
-        |> then(fn path -> "lazy_doc#{path}" end)
+        |> then(fn path -> "priv/lazy_doc#{path}" end)
         |> String.replace(
           ".ex",
           ""
@@ -250,7 +250,7 @@ defmodule Mix.Tasks.LazyDoc do
     end
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/docs_to_module_doc_node.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/docs_to_module_doc_node.md")
   def docs_to_module_doc_node(docs, acc_ast, module_ast) do
     result =
       Code.string_to_quoted_with_comments(docs,
@@ -269,7 +269,7 @@ defmodule Mix.Tasks.LazyDoc do
     end
   end
 
-  @doc File.read!("lazy_doc/mix/tasks/lazy_doc/insert_module_doc.md")
+  @doc File.read!("priv/lazy_doc/mix/tasks/lazy_doc/insert_module_doc.md")
   def insert_module_doc(ast, module_ast, ast_doc) do
     {new_ast, _acc} =
       Macro.prewalk(

lib/mix/tasks/lazy_doc.ex

@@ -1,7 +1,7 @@
 defmodule LazyDoc.MixProject do
   use Mix.Project
 
-  @version "0.5.1"
+  @version "0.5.2"
 
   def project do
     [