From 4d893f123c462e175e717d80dd356d42c570b82f Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Mon, 18 Mar 2019 23:51:20 -0400 Subject: Add basic linting for .app file This currently just checks for the existence of the description and applications keys and that the applications list has kernel and stdlib in it. --- src/rebar_app_utils.erl | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'src') diff --git a/src/rebar_app_utils.erl b/src/rebar_app_utils.erl index 5fe5ba6..037bf9d 100644 --- a/src/rebar_app_utils.erl +++ b/src/rebar_app_utils.erl @@ -100,6 +100,7 @@ validate_application_info(AppInfo, AppDetail) -> undefined -> false; AppFile -> + lint_detail(AppDetail, AppFile), case proplists:get_value(modules, AppDetail) of undefined -> ?PRV_ERROR({module_list, AppFile}); @@ -108,6 +109,36 @@ validate_application_info(AppInfo, AppDetail) -> end end. +-spec lint_detail(list(), file:filename_all()) -> ok. +lint_detail(AppDetail, AppFile) -> + lint_description(AppDetail, AppFile), + lint_applications(AppDetail, AppFile). + +-spec lint_description(list(), file:filename_all()) -> ok. +lint_description(AppDetail, AppFile) -> + case proplists:get_value(description, AppDetail, "") of + "" -> ?WARN("~p is missing description entry", [AppFile]); + _ -> ok + end. + +-spec lint_applications(list(), file:filename_all()) -> ok. +lint_applications(AppDetail, AppFile) -> + case proplists:get_value(applications, AppDetail, []) of + [] -> ?WARN("~p is missing applications entry", [AppFile]); + AppList when is_list(AppList) -> + case lists:member(kernel, AppList) of + false -> + ?WARN("~p is missing kernel from applications list", [AppFile]); + true -> ok + end, + case lists:member(stdlib, AppList) of + false -> + ?WARN("~p is missing stdlib from applications list", [AppFile]); + true -> ok + end; + _ -> ?WARN("~p requires a list for applications key", [AppFile]) + end. + %% @doc parses all dependencies from the root of the project -spec parse_deps(Dir, Deps, State, Locks, Level) -> [rebar_app_info:t()] when Dir :: file:filename(), -- cgit v1.1 From 1fa0503fc93b3411f42ebb58d197f4a060f40631 Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 16 Apr 2019 12:43:05 -0400 Subject: Change wording in application linting to be more clear --- src/rebar_app_utils.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/rebar_app_utils.erl b/src/rebar_app_utils.erl index 037bf9d..951bc1d 100644 --- a/src/rebar_app_utils.erl +++ b/src/rebar_app_utils.erl @@ -136,7 +136,7 @@ lint_applications(AppDetail, AppFile) -> ?WARN("~p is missing stdlib from applications list", [AppFile]); true -> ok end; - _ -> ?WARN("~p requires a list for applications key", [AppFile]) + _ -> ?WARN("~p requires a list for applications value", [AppFile]) end. %% @doc parses all dependencies from the root of the project -- cgit v1.1 From cb881390dce42dab63f18dba59eddd1e4990b969 Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 16 Apr 2019 12:58:14 -0400 Subject: An empty list on applications key should not be treated as missing --- src/rebar_app_utils.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/rebar_app_utils.erl b/src/rebar_app_utils.erl index 951bc1d..bb706fd 100644 --- a/src/rebar_app_utils.erl +++ b/src/rebar_app_utils.erl @@ -123,8 +123,8 @@ lint_description(AppDetail, AppFile) -> -spec lint_applications(list(), file:filename_all()) -> ok. lint_applications(AppDetail, AppFile) -> - case proplists:get_value(applications, AppDetail, []) of - [] -> ?WARN("~p is missing applications entry", [AppFile]); + case proplists:get_value(applications, AppDetail) of + undefined -> ?WARN("~p is missing applications entry", [AppFile]); AppList when is_list(AppList) -> case lists:member(kernel, AppList) of false -> -- cgit v1.1