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 three elements {GithubAi, :codestral, options}.

Installation

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

or install it as a single binary

mix escript.install hex lazy_doc 0.5.5

Configuration

Configuration is the same if you are using the binary or the dep.

config/config.exs

import Config
alias LazyDoc.Providers.GithubAi
## configure formatter.
config :lazy_doc,
  ## This is the default value, no need to configure.
  ## This option creates the docs in files under priv/lazy_doc directory. 
  external_docs: false,
  ## This is the default value, no need to configure.
  patterns: [
   ~r"^lib/[a-zA-Z_]+(?:/[a-zA-Z_]+)*/[a-zA-Z_]+\.ex$",
  ],
  ## This is the default value, no need to configure.
  max_retries: 1,
  ## This is the default value, no need to configure.
  receive_timeout: 15_000,
  ## This is the default value, no need to configure.
  file_formatter: ".formatter.exs",
  ## This is the default value, no need to configure.
  provider: {GithubAi, :gpt_4o_mini, [max_tokens: 2048, top_p: 1, temperature: 1]},
  ## This is the default value, no need to configure.
  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),
  ## This is the default value, no need to configure.
  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\nThe module GithubAi provides a way of communicating with Github AI API \(describes the main functionality of the module\).\n\n## Description\n\nIt implements the behavior Provider a standard way to use a provider in LazyDoc.\(gives a detailed description of what the module does\)\n"""\n\nModule to document:\n)

config/runtime.exs

## Required to be configured
config :lazy_doc, :token, System.get_env("API_TOKEN")

.env

API_TOKEN="YOUR AWESOME TOKEN"

Available Providers implemented by LazyDoc

You can check Providers implemented in LazyDoc here.

How to run it ?

As a Elixir dependency

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

mix lazy_doc

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

As a binary

lazy_doc

lazy_doc --check

Build the binary from source and install it.

MIX_ENV=dev mix escript.build

MIX_ENV=dev mix escript.install

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.

[!WARNING] 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__, [], []}]
      ]}
   ]
 ]}

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.
• Make @moduledoc documentation take data from the Modules is related the given module.
• Spec mode: Detect if a function does not have any @specs and try to generate their specs.
• Make an option external_docs to do @doc File.read!("file_gen_by_lazy_doc.md"), this will prevent code redability issues, it will create a folder where all the docs is generated.
• Make a mix lazy_doc.clean task that will allow to clear all the docs for updating to new docs.
• Make lazy_doc run in a single binary