CredoTodoOrDie.Check (credo_todo_or_die v0.4.1) View Source

Basics

This check is disabled by default. {: .neutral}

Learn how to enable it via .credo.exs.

This check has a base priority of 0 and works with any version of Elixir.

Explanation

Check-Specific Parameters

Use the following parameters to configure this check:

:tag_name

The tag to look for (TODO/FIXME/NOTE/etc...)

This parameter defaults to "TODO".

:timezone

When specifing date/time you can specify the timezone of your development / CI machine
so that it reports as accurately as possible

Timezone can be anything specified in Timex.is_valid_timezone?
https://hexdocs.pm/timex/Timex.html#is_valid_timezone?/1

This parameter defaults to "Etc/UTC".

General Parameters

Like with all checks, general params can be applied.

Parameters can be configured via the .credo.exs config file.

Link to this section Summary

Link to this section Functions

Link to this function

items_with_index(source_file, tag_name, params)

View Source