Merge pull request #91 from paulo-ferraz-oliveira/fix/for-strict-generators

Support OTP 28

Author: elbrujohalcon

.github/workflows/ci.yml

@@ -10,30 +10,31 @@ jobs:
 
     strategy:
       matrix:
-        otp: ['25', '26', '27']
-        rebar: ['3.24']
+        otp: ['26', '27', '28']
+        rebar: ['3.25']
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         id: setup-beam
         with:
           otp-version: ${{matrix.otp}}
           rebar3-version: ${{matrix.rebar}}
       - name: Restore _build
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: _build
           key: _build-cache-for-os-${{runner.os}}-otp-${{steps.setup-beam.outputs.otp-version}}-rebar3-${{steps.setup-beam.outputs.rebar3-version}}-hash-${{hashFiles('rebar.lock')}}
       - name: Restore rebar3's cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/rebar3
           key: rebar3-cache-for-os-${{runner.os}}-otp-${{steps.setup-beam.outputs.otp-version}}-rebar3-${{steps.setup-beam.outputs.rebar3-version}}-hash-${{hashFiles('rebar.lock')}}
       - name: Compile
         run: ERL_FLAGS="-enable-feature all" rebar3 compile
-      #- name: Format check
-      #  run: ERL_FLAGS="-enable-feature all" rebar3 format --verify
+      - name: Format check
+        if: matrix.otp == '27'
+        run: rebar3 fmt --check
       - name: Run tests and verifications (features not enabled)
         run: rebar3 test
       - name: Run tests and verifications (features enabled)

elvis.config

@@ -1,10 +1,20 @@
-[{elvis,
-  [{config,
-    [#{dirs => ["src"],
-       filter => "*.erl",
-       ruleset => erl_files,
-       rules => [{elvis_style, atom_naming_convention, #{regex => "^([a-z][A-Za-z0-9]*_?)*$"}}]},
-     #{dirs => ["test"],
-       filter => "*.erl",
-       ruleset => erl_files,
-       rules => [{elvis_style, no_debug_call, disable}]}]}]}].
+[
+    {elvis, [
+        {config, [
+            #{
+                dirs => ["src"],
+                filter => "*.erl",
+                ruleset => erl_files,
+                rules => [
+                    {elvis_style, atom_naming_convention, #{regex => "^([a-z][A-Za-z0-9]*_?)*$"}}
+                ]
+            },
+            #{
+                dirs => ["test"],
+                filter => "*.erl",
+                ruleset => erl_files,
+                rules => [{elvis_style, no_debug_call, disable}]
+            }
+        ]}
+    ]}
+].

rebar.config

@@ -1,45 +1,48 @@
 %% == Compiler and Profiles ==
 
-{erl_opts,
- [warn_unused_import, warn_export_vars, warnings_as_errors, verbose, report, debug_info]}.
+{erl_opts, [warn_unused_import, warn_export_vars, warnings_as_errors, verbose, report, debug_info]}.
 
-{minimum_otp_vsn, "25"}.
+{minimum_otp_vsn, "26"}.
 
-{profiles,
- [{test, [{cover_enabled, true}, {cover_opts, [verbose]}, {ct_opts, [{verbose, true}]}]}]}.
+{profiles, [{test, [{cover_enabled, true}, {cover_opts, [verbose]}, {ct_opts, [{verbose, true}]}]}]}.
 
 {alias, [{test, [compile, lint, xref, dialyzer, ct, cover]}]}.
 
 %% == Dependencies and plugins ==
 
-{project_plugins,
- [{rebar3_hank, "~> 1.4.0"},
-  {rebar3_hex, "~> 7.0.7"},
-  {rebar3_format, "~> 1.3.0"},
-  {rebar3_lint, "~> 3.1.0"},
-  {rebar3_ex_doc, "~> 0.2.20"}]}.
+{project_plugins, [
+    {rebar3_hank, "~> 1.4.0"},
+    {rebar3_hex, "~> 7.0.7"},
+    {erlfmt, "~> 1.6.2"},
+    {rebar3_lint, "~> 3.1.0"},
+    {rebar3_ex_doc, "~> 0.2.20"}
+]}.
 
 %% == Documentation ==
 
-{ex_doc,
- [{source_url, <<"https://github.com/inaka/katana-code">>},
-  {extras, [<<"README.md">>, <<"LICENSE">>]},
-  {main, <<"README.md">>},
-  {prefix_ref_vsn_with_v, false}]}.
+{ex_doc, [
+    {source_url, <<"https://github.com/inaka/katana-code">>},
+    {extras, [<<"README.md">>, <<"LICENSE">>]},
+    {main, <<"README.md">>},
+    {prefix_ref_vsn_with_v, false}
+]}.
 
 {hex, [{doc, #{provider => ex_doc}}]}.
 
 %% == Format ==
 
-{format, [{options, #{unquote_atoms => false}}]}.
+{erlfmt, [
+    write,
+    {files, ["src/**/*.app.src", "src/**/*.erl", "test/**/*.erl", "*.config"]}
+]}.
 
 %% == Dialyzer + XRef ==
 
-{dialyzer,
- [{warnings, [no_return, unmatched_returns, error_handling, underspecs, unknown]},
-  {plt_extra_apps, [syntax_tools, common_test]}]}.
+{dialyzer, [
+    {warnings, [no_return, unmatched_returns, error_handling, underspecs, unknown]},
+    {plt_extra_apps, [syntax_tools, common_test]}
+]}.
 
-{xref_checks,
- [undefined_function_calls, deprecated_function_calls, deprecated_functions]}.
+{xref_checks, [undefined_function_calls, deprecated_function_calls, deprecated_functions]}.
 
 {xref_extra_paths, ["test/**"]}.

src/katana_code.app.src

@@ -1,10 +1,10 @@
-{application,
- katana_code,
- [{description, "Functions useful for processing Erlang code."},
-  {vsn, git},
-  {applications, [kernel, stdlib]},
-  {modules, []},
-  {registered, []},
-  {licenses, ["Apache 2.0"]},
-  {links, [{"GitHub", "https://github.com/inaka/katana-code"}]},
-  {build_tools, ["rebar3"]}]}.
+{application, katana_code, [
+    {description, "Functions useful for processing Erlang code."},
+    {vsn, git},
+    {applications, [kernel, stdlib]},
+    {modules, []},
+    {registered, []},
+    {licenses, ["Apache 2.0"]},
+    {links, [{"GitHub", "https://github.com/inaka/katana-code"}]},
+    {build_tools, ["rebar3"]}
+]}.