OeditusCredo.Check.Warning.DirectStructUpdate (OeditusCredo v0.6.2)

View Source

Basics

This check is disabled by default.

Learn how to enable it via .credo.exs.

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

Explanation

Use changesets instead of direct struct updates for data validation.

Direct struct updates bypass validation and can lead to invalid data in the database.

Bad:

user = %User{user | email: new_email}
Map.put(user, :email, new_email)

Good:

user
|> User.changeset(%{email: new_email})
|> Repo.update()

Check-Specific Parameters

Use the following parameters to configure this check:

:exclude_test_files

Set to true to skip test files (default: false)

This parameter defaults to nil.

:extra_struct_patterns

Additional regex pattern strings for struct-like variable names (default: [])

This parameter defaults to nil.

General Parameters

Like with all checks, general params can be applied.

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