-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1099 from erlang-ls/1098-detect-unused-record-fields
[#1098] Detect unused record fields
- Loading branch information
Showing
6 changed files
with
113 additions
and
25 deletions.
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
apps/els_lsp/priv/code_navigation/src/diagnostics_unused_record_fields.erl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
-module(diagnostics_unused_record_fields). | ||
|
||
-export([main/1]). | ||
|
||
-record(used_field, {field_a, field_b = 42}). | ||
-record(unused_field, {field_c, field_d}). | ||
|
||
main(#used_field{field_a = A, field_b = B}) -> | ||
{A, B}; | ||
main(R) -> | ||
R#unused_field.field_c. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
%%============================================================================== | ||
%% Unused Includes diagnostics | ||
%%============================================================================== | ||
-module(els_unused_record_fields_diagnostics). | ||
|
||
%%============================================================================== | ||
%% Behaviours | ||
%%============================================================================== | ||
-behaviour(els_diagnostics). | ||
|
||
%%============================================================================== | ||
%% Exports | ||
%%============================================================================== | ||
-export([ is_default/0 | ||
, run/1 | ||
, source/0 | ||
]). | ||
|
||
%%============================================================================== | ||
%% Includes | ||
%%============================================================================== | ||
-include("els_lsp.hrl"). | ||
|
||
%%============================================================================== | ||
%% Callback Functions | ||
%%============================================================================== | ||
|
||
-spec is_default() -> boolean(). | ||
is_default() -> | ||
true. | ||
|
||
-spec run(uri()) -> [els_diagnostics:diagnostic()]. | ||
run(Uri) -> | ||
case filename:extension(Uri) of | ||
<<".erl">> -> | ||
case els_utils:lookup_document(Uri) of | ||
{error, _Error} -> | ||
[]; | ||
{ok, Document} -> | ||
UnusedRecordFields = find_unused_record_fields(Document), | ||
[make_diagnostic(POI) || POI <- UnusedRecordFields ] | ||
end; | ||
_ -> | ||
[] | ||
end. | ||
|
||
-spec source() -> binary(). | ||
source() -> | ||
<<"UnusedRecordFields">>. | ||
|
||
%%============================================================================== | ||
%% Internal Functions | ||
%%============================================================================== | ||
-spec find_unused_record_fields(els_dt_document:item()) -> [poi()]. | ||
find_unused_record_fields(Document) -> | ||
Definitions = els_dt_document:pois(Document, [record_def_field]), | ||
Usages = els_dt_document:pois(Document, [record_field]), | ||
UsagesIds = lists:usort([Id || #{id := Id} <- Usages]), | ||
[POI || #{id := Id} = POI <- Definitions, not lists:member(Id, UsagesIds)]. | ||
|
||
-spec make_diagnostic(poi()) -> els_diagnostics:diagnostic(). | ||
make_diagnostic(#{id := {RecName, RecField}, range := POIRange}) -> | ||
Range = els_protocol:range(POIRange), | ||
FullName = els_utils:to_binary(io_lib:format("#~p.~p", [RecName, RecField])), | ||
Message = <<"Unused record field: ", FullName/binary>>, | ||
Severity = ?DIAGNOSTIC_WARNING, | ||
Source = source(), | ||
els_diagnostics:make_diagnostic(Range, Message, Severity, Source). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters