Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add {dbg, '_'}, {dyntrace, '_'}, {instrument, '_'} to no_debug_call #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elbrujohalcon merged 1 commit into from
Jun 12, 2025
Merged

Add {dbg, '_'}, {dyntrace, '_'}, {instrument, '_'} to no_debug_call #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc_rules/elvis_style/no_debug_call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ lead to performance degradation, unwanted output, or inconsistent logging behavi

- `debug_functions :: [{module(), function(), arity()} | {module(), function()}]`
- default: `[{ct, pal}, {ct, print}, {io, format, 1}, {io, format, 2}, {erlang, display, 1},
{io, put_chars, 1}, {io, put_chars, 2}]`
{io, put_chars, 1}, {io, put_chars, 2}, {dbg, '_'}, {dyntrace, '_'}, {instrument, '_'}]`

`{erlang, display, 1}` was added in [1.5.0](https://github.com/inaka/elvis_core/releases/tag/1.5.0).

`{io, put_chars, 1}, {io, put_chars, 2}` was added in [4.0.0](https://github.com/inaka/elvis_core/releases/tag/4.0.0).

`{dbg, '_'}, {dyntrace, '_'}, {instrument, '_'}` was added in [4.1.0](https://github.com/inaka/elvis_core/releases/tag/4.1.0).

## Example configuration

```erlang
Expand All @@ -30,7 +32,10 @@ lead to performance degradation, unwanted output, or inconsistent logging behavi
, {io, format, 2}
, {erlang, display, 1}
, {io, put_chars, 1}
, {io, put_chars, 2}
, {io, put_chars, 2},
, {dbg, '_'},
, {dyntrace, '_'}
, {instrument, '_'}
]
}}
```
5 changes: 4 additions & 1 deletion src/elvis_style.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,10 @@ default(no_debug_call) ->
{io, format, 1},
{io, format, 2},
{io, put_chars, 1},
{io, put_chars, 2}
{io, put_chars, 2},
{dbg, '_'},
{dyntrace, '_'},
{instrument, '_'}
]
};
default(no_common_caveats_call) ->
Expand Down
5 changes: 4 additions & 1 deletion test/examples/fail_no_debug_call.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ fail() ->
ct:pal("Debug ~s", ["Debug Info"]),
ct:print("Debug"),
ct:print("Debug ~s", ["Debug Info"]),
io:put_chars("Debug").
io:put_chars("Debug"),
dbg:whatever_function(),
dyntrace:calls(missing),
instrument:this().
10 changes: 8 additions & 2 deletions test/style_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1664,7 +1664,10 @@ verify_no_debug_call(Config) ->
#{info := [io, format, 2, 10]},
#{info := [ct, print, 1, 16]},
#{info := [ct, print, 2, 17]},
#{info := [io, put_chars, 1, 18]}
#{info := [io, put_chars, 1, 18]},
#{info := [dbg, whatever_function, 0, 19]},
#{info := [dyntrace, calls, 1, 20]},
#{info := [instrument, this, 0, 21]}
] =
elvis_core_apply_rule(Config, elvis_style, no_debug_call, #{}, PathFail);
erl_files ->
Expand All @@ -1675,7 +1678,10 @@ verify_no_debug_call(Config) ->
#{info := [ct, pal, 2, 14]},
#{info := [ct, print, 1, 15]},
#{info := [ct, print, 2, 16]},
#{info := [io, put_chars, 1, 17]}
#{info := [io, put_chars, 1, 17]},
#{info := [dbg, whatever_function, 0, 18]},
#{info := [dyntrace, calls, 1, 19]},
#{info := [instrument, this, 0, 20]}
] =
elvis_core_apply_rule(Config, elvis_style, no_debug_call, #{}, PathFail)
end,
Expand Down