Merge pull request #122 from zhongwencool/ci

Refactor and update configs, types, and code structure

Author: zhongwencool

.github/workflows/erlang.yml

@@ -16,20 +16,12 @@ jobs:
             rebar3: '3.22'
           - otp: '26'
             rebar3: '3.22'
-          - otp: '25'
-            rebar3: '3.22'
-          - otp: '24'
-            rebar3: '3.22'
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         with:
           otp-version: ${{matrix.otp}}
           rebar3-version: ${{matrix.rebar3}}
-      - name: compile
-        run: rebar3 compile
-      - name: xref
-        run: rebar3 xref
-      - name: dialyzer
-        run: rebar3 dialyzer
+      - name: quality checks
+        run: rebar3 check
 

README.md

@@ -240,7 +240,7 @@ Top N list sort by memory size, all items defined in [`mnesia:table_info/2`](htt
 
 ### Application
 
-![Application](https://github.com/zhongwencool/observer_cli/raw/main/docs/images/application.jpg)
+![Application](https://github.com/zhongwencool/observer_cli/raw/main/docs/images/application.png)
 
 The Application panel aggregates supervision data from [`application_controller:info()`](https://github.com/erlang/otp/blob/master/lib/kernel/src/application_controller.erl#L280), groups processes by their application master, and shows their live resource usage. Each row includes:
 

doc/overview.edoc

@@ -1,47 +1,37 @@
-[
- {
-   elvis,
-   [
-    {config,
-     [#{dirs => ["src", "test"],
-        filter => "*.erl",
-        rules => [{elvis_style, line_length, #{limit => 140}},
-                  {elvis_style, no_tabs},
-                  {elvis_style, macro_names},
-                  {elvis_style, macro_module_names},
-                  {elvis_style, operator_spaces, #{rules => [{right, ","},
-                                                             {right, "++"},
-                                                             {left, "++"}]}},
-                  {elvis_style, nesting_level, #{level => 4}},
-                  {elvis_style, god_modules, #{limit => 25}},
-                  {elvis_style, no_if_expression},
-                  {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
-                  {elvis_style, used_ignored_variable},
-                  {elvis_style, no_behavior_info},
-                  {
-                    elvis_style,
-                    module_naming_convention,
-                    #{regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$",
-                      ignore => []}
-                  },
-                  {elvis_style, state_record_and_type},
-                  {elvis_style, no_spec_with_records}
-                 ]
-       },
-      #{dirs => ["."],
-        filter => "Makefile",
-        rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => [sync]}}]
-       },
-      #{dirs => ["."],
-        filter => "rebar.config",
-        rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}}]
-       },
-      #{dirs => ["."],
-        filter => "elvis.config",
-        rules => [{elvis_project, old_configuration_format}]
-       }
-     ]
-    }
-   ]
- }
-].
+[{elvis, [
+    {config, [
+        #{ dirs    => ["src"]
+         , filter  => "*.erl"
+         , ruleset => erl_files
+         , rules   => [
+             {elvis_text_style, line_length, #{limit => 140}},
+             {elvis_style, atom_naming_convention, #{ignore => [observer_cli_mnesia]}},
+             {elvis_style, param_pattern_matching, disable},
+             {elvis_style, no_receive_without_timeout, disable},
+             {elvis_style, no_block_expressions, disable},
+             {elvis_style, dont_repeat_yourself, disable},             
+             {elvis_style, no_debug_call, #{ignore => [observer_cli_escriptize]}},
+             {elvis_style, no_if_expression, disable},
+             {elvis_style, no_catch_expressions, disable},             
+             {elvis_style, export_used_types, disable}             
+         ]
+        }
+      , #{ dirs    => ["include"]
+         , filter  => "*.hrl"
+         , ruleset => hrl_files
+         , rules   => [
+             {elvis_text_style, line_length, #{limit => 140}},
+             {elvis_style, no_types, disable},
+             {elvis_style, macro_names, disable}
+         ]
+        }
+      , #{ dirs    => ["."]
+         , filter  => "rebar.config"
+         , ruleset => rebar_config
+        }
+    ]}
+  , {output_format, colors}
+  , {verbose, true}
+  , {no_output, false}
+  , {parallel, 1}
+]}].

docs/overview.edoc

@@ -51,20 +51,31 @@
 -record(plug, {cur_index = 1 :: pos_integer(), plugs = [] :: map() | []}).
 
 -record(view_opts, {
-    home = #home{} :: home(),
-    ets = #ets{} :: ets(),
-    sys = #system{} :: system(),
-    app = #app{} :: app(),
-    db = #db{} :: db(),
-    help = #help{} :: help(),
-    inet = #inet{} :: inet(),
-    process = #process{} :: process(),
+    home = #home{} :: #home{},
+    ets = #ets{} :: #ets{},
+    sys = #system{} :: #system{},
+    app = #app{} :: #app{},
+    db = #db{} :: #db{},
+    help = #help{} :: #help{},
+    inet = #inet{} :: #inet{},
+    process = #process{} :: #process{},
     port = ?DEFAULT_INTERVAL :: pos_integer(),
-    plug = #plug{} :: plug(),
+    plug = #plug{} :: #plug{},
     auto_row = true :: boolean()
 }).
 
--export_type([view_opts/0]).
+-export_type([
+    view_opts/0,
+    home/0,
+    app/0,
+    system/0,
+    ets/0,
+    db/0,
+    help/0,
+    inet/0,
+    process/0,
+    plug/0
+]).
 
 -type view_opts() :: #view_opts{}.
 -type home() :: #home{}.
@@ -103,6 +114,6 @@
 -define(SELECT(Text), observer_cli_lib:select(Text)).
 -define(UNSELECT(Text), observer_cli_lib:unselect(Text)).
 
--define(render(_FA_), observer_cli_lib:render(_FA_)).
--define(output(_F_, _A_), io:format(iolist_to_binary(_F_), _A_)).
--define(output(_L_), ?output(_L_, [])).
+-define('render'(_FA_), observer_cli_lib:render(_FA_)).
+-define('output'(_F_, _A_), io:format(iolist_to_binary(_F_), _A_)).
+-define('output'(_L_), ?output(_L_, [])).