LazyDoc

Lazy Doc is a project for those who are lazy af to document their code.

It is designed to detect undocumented functions, pass the function to an AI provider which is a tuple of two elements {GithubAi, :codestral}.

Roadmap

• Make AI docs for functions @doc.
• Simple check if the response is in @doc format.
• Make AI providers more extensible (define a behavior, what an AI provider should do ?).
• Custom path wildcard (limits the action of lazy_doc)
• Make some unit tests.
• Improve the default prompt to generate markdown syntax.
• Fix inner module detection (creates scopes for inner modules and builds the full name of the inner module).
• Make a task or an arg in the current task to check if the functions are documented. (allows CI usage)
• File is written to file according to Elixir formatter.
• Make AI docs for modules as well, @moduledoc.
• Custom prompts for function and module.
• Simple check if the response is in @moduledoc format.
• Customizable number of retries.
• Custom paramters to pass the provider (max_tokens, top_p, temperature).
• Check if custom paramters are valid for that provider.
• Inspect the defimpl and defprotocol nodes.

Installation

def deps do
  [
    {:lazy_doc, "~> 0.4.0"}
  ]
end

Configuration

config/config.exs

## alias of GithubAi above
config :lazy_doc, :provider, {GithubAi, :gpt_4o_mini}

## configure formatter.
config :lazy_doc,
       :provider,
       {GithubAi, :gpt_4o_mini, [max_tokens: 2048, top_p: 1, temperature: 1]}

config :lazy_doc, :max_retries, 3

config :lazy_doc, :receive_timeout, 15_000

config :lazy_doc, :line_length, 98

config :lazy_doc,
       :custom_function_prompt,
       ~s(You should describe the parameters based on the spec given and give a small description of the following function.\n\nPlease do it in the following format given as an example, important do not return the header of the function, do not return a explanation of the function, your output must be only the docs in the following format.\n\n@doc """\n\n## Parameters\n\n- transaction_id - foreign key of the Transactions table.\n## Description\n Performs a search in the database\n\n## Returns\n the Transaction corresponding to transaction_id\n\n"""\n\nFunction to document:\n)

config :lazy_doc,
       :custom_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\n The module GithubAi provides a way of communicating with Github AI API.\n\n ## Description\n\n It implements the behavior Provider a standard way to use a provider in LazyDoc.\n"""\n\nModule to document:\n)

config :lazy_doc, :path_wildcard, "lib/**/*.ex"

config/runtime.exs

config :lazy_doc, :token, System.get_env("API_TOKEN")

.env

API_TOKEN="YOUR AWESOME TOKEN"

How to run it ?

From the root of the elixir project once installed and configured.

mix lazy_doc

I would recommend to run a mix format after just in case.

If you want, you can add a simple check to see what needs to be documented in your project. This is good for CI.

mix lazy_doc.check

Known limitations that wont be fixed.

Module names in the same file must be different.

If the user creates an inner module with the same name as the parent module lazy_doc, it wont work properly because they have the same :__aliases__ AST node.

Note: this limitation it is only in module names. So if the user have same names of functions in different modules or in the same module, it will work.

defmodule Hello do

  defmodule Hello do

  end

end

produces the following AST

{:defmodule, [line: 1],
 [
## This is why it does not work [:Hello] 
   {:__aliases__, [line: 1], [:Hello]},
   [
     do: {:defmodule, [line: 3],
      [
        {:__aliases__, [line: 3],
## This is why it does not work [:Hello] 
         [:Hello]},
        [do: {:__block__, [], []}]
      ]}
   ]
 ]}