Add configuration for luacheck and run luacheck in Github actions

Also fixes some warnings generated by luacheck.

Author: joto

.github/workflows/luacheck.yml

@@ -0,0 +1,19 @@
+name: Check Lua scripts with luacheck
+
+on: [ push, pull_request ]
+
+jobs:
+  luacheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install prerequisites
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -yq --no-install-suggests --no-install-recommends lua-check
+
+      - name: Run luacheck
+        run: luacheck flex-config/*.lua flex-config/gen/*.lua tests/data/*.lua tests/lua/tests.lua
+

.luacheckrc

@@ -0,0 +1,38 @@
+--
+--  Configuration for luacheck
+--
+--  To check Lua files call like this:
+--  luacheck flex-config/*.lua flex-config/gen/*.lua tests/data/*.lua tests/lua/tests.lua
+--
+
+unused_args = false
+
+stds.osm2pgsql = {
+    read_globals = {
+        osm2pgsql = {
+            fields = {
+                process_node = {
+                    read_only = false
+                },
+                process_way = {
+                    read_only = false
+                },
+                process_relation = {
+                    read_only = false
+                },
+                select_relation_members = {
+                    read_only = false
+                },
+                process_gen = {
+                    read_only = false
+                },
+            },
+            other_fields = true,
+        }
+    }
+}
+
+std = 'min+osm2pgsql'
+
+files['tests/lua/tests.lua'].globals = { 'osm2pgsql' }
+

tests/data/test_output_flex.lua

@@ -37,7 +37,7 @@ tables.route = osm2pgsql.define_table{
     }
 }
 
-function is_polygon(tags)
+local function is_polygon(tags)
     if tags.aeroway
         or tags.amenity
         or tags.area

tests/data/test_output_flex_stage2.lua

@@ -32,7 +32,7 @@ function osm2pgsql.process_way(object)
     local d = w2r[object.id]
     if d then
         local refs = {}
-        for rel_id, rel_ref in pairs(d) do
+        for _, rel_ref in pairs(d) do
             refs[#refs + 1] = rel_ref
         end
         table.sort(refs)

tests/data/test_output_flex_stage2_alt.lua

@@ -36,7 +36,7 @@ function osm2pgsql.process_way(object)
     local d = w2r[object.id]
     if d then
         local refs = {}
-        for rel_id, rel_ref in pairs(d) do
+        for _, rel_ref in pairs(d) do
             refs[#refs + 1] = rel_ref
         end
         table.sort(refs)

tests/data/test_output_flex_uni.lua

@@ -20,7 +20,7 @@ local table2idcol = osm2pgsql.define_table{
     }
 }
 
-function is_empty(some_table)
+local function is_empty(some_table)
     return next(some_table) == nil
 end
 

tests/data/test_output_flex_validgeom.lua

@@ -7,7 +7,7 @@ local polygons = osm2pgsql.define_table{
     }
 }
 
-function is_empty(some_table)
+local function is_empty(some_table)
     return next(some_table) == nil
 end
 

tests/data/test_output_flex_way.lua

@@ -20,7 +20,7 @@ tables.tboth = osm2pgsql.define_way_table('osm2pgsql_test_tboth', {
 
 local w2r = {}
 
-function get_ids(data)
+local function get_ids(data)
     if data then
         local ids = {}
         for rel_id, _ in pairs(data) do
@@ -59,7 +59,7 @@ function osm2pgsql.process_way(object)
     end
 end
 
-function way_member_ids(relation)
+local function way_member_ids(relation)
     local ids = {}
     for _, member in ipairs(relation.members) do
         if member.type == 'w' and member.role == 'mark' then

tests/lua/tests.lua

@@ -93,7 +93,7 @@ do
     assert(tags['source:vs:source'] == nil)
     assert(tags['with:source:infix'] == 'keepme')
 
-    num = 0
+    local num = 0
     for k, v in pairs(tags) do
         num = num + 1
     end
@@ -116,7 +116,7 @@ assert(osm2pgsql.trim(nil) == nil)
 
 -- split_unit
 
-v, u = o.split_unit('20m', '')
+local v, u = o.split_unit('20m', '')
 assert(v == 20 and u == 'm')
 
 v, u = o.split_unit('20 m')
@@ -147,16 +147,16 @@ v, u = o.split_unit('-20000', 'leagues')
 assert(v == -20000 and u == 'leagues')
 
 v, u = o.split_unit('20xx20', '')
-assert(v == nil)
+assert(v == nil and u == nil)
 
 v, u = o.split_unit('20-20', '')
-assert(v == nil)
+assert(v == nil and u == nil)
 
 v, u = o.split_unit('20xx20', 'foo')
-assert(v == nil)
+assert(v == nil and u == nil)
 
 v, u = o.split_unit('abc', 'def')
-assert(v == nil)
+assert(v == nil and u == nil)
 
 v, u = o.split_unit(nil)
 assert(v == nil and u == nil)
@@ -166,7 +166,7 @@ assert(v == nil and u == nil)
 
 -- split_string
 
-r = o.split_string('ab c;d;e f;ghi')
+local r = o.split_string('ab c;d;e f;ghi')
 assert(#r == 4)
 assert(r[1] == 'ab c')
 assert(r[2] == 'd')