Breaking - changes.lua no longer pcalls.

Any scripts using changes will need to be updated.

stdlib/data/developer/developer.lua

@@ -27,6 +27,7 @@ end
 -- local Developer = require('__stdlib__/stdlib/data/develper/developer')
 -- Developer.make_test_entities()
 function Developer.make_test_entities()
+    log('Making developer debug entities')
     if not data.raw['electric-energy-interface']['debug-energy-interface'] then
         Data('electric-energy-interface', 'electric-energy-interface'):copy('debug-energy-interface'):set_fields {
             flags = {'placeable-off-grid'},

stdlib/event/changes.lua

@@ -1,12 +1,23 @@
 --- Configuration changed event handling.
 -- This module registers events
 -- @module Event.Changes
--- @usage require('__stdlib__/stdlib/event/changes')
+-- @usage
+-- local Changes = require('__stdlib__/stdlib/event/changes')
+-- Changes.register('mod_versions', 'path_to_version_file')
+-- @usage
+-- -- version files should return a dictionary of functions indexed by version number.
+-- return {['1.0.0'] = function() end}
+-- @usage
+-- -- Other change files should return a single function and will run in the order they are added.
+-- -- Multiple files can be registered to a change type.
+-- Changes.register('any-first', 'path_to_file_1')
+-- Changes.register('any-first', 'path_to_file_2')
 
 local Event = require('__stdlib__/stdlib/event/event')
 
 local Changes = {
-   __module = 'Changes'
+    __module = 'Changes',
+    registered_for_events = false
 }
 setmetatable(Changes, require('__stdlib__/stdlib/core'))
 
@@ -21,93 +32,105 @@ setmetatable(Changes, require('__stdlib__/stdlib/core'))
     old_version :: string: Old version of the mod. May be nil if the mod wasn't previously present (i.e. it was just added).
     new_version :: string: New version of the mod. May be nil if the mod is no longer present (i.e. it was just removed).
 --]]
-Changes.versions = prequire('changes/versions') or {}
-Changes['map-change-always-first'] = prequire('changes/map-change-always-first')
-Changes['any-change-always-first'] = prequire('changes/any-change-always-first')
-Changes['mod-change-always-first'] = prequire('changes/mod-change-always-first')
-Changes['mod-change-always-last'] = prequire('changes/mod-change-always-last')
-Changes['any-change-always-last'] = prequire('changes/any-change-always-last')
-Changes['map-change-always-last'] = prequire('changes/map-change-always-last')
 
-local function run_if_exists(func)
-    return func and type(func) == 'function' and func()
+local table = require('__stdlib__/stdlib/utils/table')
+
+local map_changes = {
+    ['map_first'] = true,
+    ['any_first'] = true,
+    ['mod_first'] = true,
+    ['mod_versions'] = true,
+    ['mod_last'] = true,
+    ['any_last'] = true,
+    ['map_last'] = true
+}
+for change_type in pairs(map_changes) do
+    Changes[change_type] = {}
+end
+
+local function run_if_exists(path)
+    for _, func in pairs(path) do
+        if type(func) == 'function' then
+            func()
+        end
+    end
+end
+
+function Changes.register_events(change_type, path)
+    if map_changes[change_type] then
+        if not Changes.registered_for_events then
+            Event.register(Event.core_events.configuration_changed, Changes.on_configuration_changed)
+            if change_type == 'mod_versions' then
+                -- Register on_init only for mod_versions changes
+                Event.register(Event.core_events.init, Changes.on_init)
+            end
+        end
+        Changes[change_type][path] = require(path)
+    else
+        error('Incorrect change type ' .. (change_type or 'nil') .. ' expected: ' .. table.concat(table.keys(map_changes), ', ') .. '.')
+    end
+    return Changes
 end
+Changes.register = Changes.register_events
 
---[Mark all migrations as complete during Init]--
+function Changes.register_versions(path)
+    return Changes.register_events('mod_versions', path)
+end
+
+-- Mark all version changes as complete during Init
 function Changes.on_init()
-    local list = {}
-    local cur_version = game.active_mods[script.mod_name]
-    for ver in pairs(Changes.versions) do
-        list[ver] = cur_version
+    for _, versions in pairs(Changes.mod_versions) do
+        local list = {}
+        local cur_version = game.active_mods[script.mod_name]
+        for ver in pairs(versions) do
+            list[ver] = cur_version
+        end
+        global._changes = list
     end
-    global._changes = list
 end
 
 function Changes.on_configuration_changed(event)
-    run_if_exists(Changes['map-change-always-first'])
+    run_if_exists(Changes.map_first)
     if event.mod_changes then
-        run_if_exists(Changes['any-change-always-first'])
+        run_if_exists(Changes.any_first)
         if event.mod_changes[script.mod_name] then
-            run_if_exists(Changes['mod-change-always-first'])
+            run_if_exists(Changes.mod_first)
             local this_mod_changes = event.mod_changes[script.mod_name]
             Changes.on_mod_changed(this_mod_changes)
             log('Version changed from ' .. tostring(this_mod_changes.old_version) .. ' to ' .. tostring(this_mod_changes.new_version))
-            run_if_exists(Changes['mod-change-always-last'])
+            run_if_exists(Changes.mod_last)
         end
-        run_if_exists(Changes['any-change-always-last'])
+        run_if_exists(Changes.any_last)
     end
-    run_if_exists(Changes['map-change-always-last'])
+    run_if_exists(Changes.map_last)
 end
 
 function Changes.on_mod_changed(this_mod_changes)
-    global._changes = global._changes or {}
+    if Changes.mod_versions then
+        global._changes = global._changes or {}
 
-    local old = this_mod_changes.old_version
-    if old then -- Find the last installed version
-        for ver, func in pairs(Changes.versions) do
-            if not global._changes[ver] then
-                run_if_exists(func)
-                global._changes[ver] = old
-                log('Migration completed for version ' .. ver)
+        local old = this_mod_changes.old_version
+        if old then -- Find the last installed version
+            for _, path in pairs(Changes.versions) do
+                for ver, func in pairs(path) do
+                    if not global._changes[ver] then
+                        run_if_exists(func)
+                        global._changes[ver] = old
+                        log('Migration completed for version ' .. ver)
+                    end
+                end
             end
         end
     end
 end
 
-function Changes.register_events()
-    Event.register(Event.core_events.configuration_changed, Changes.on_configuration_changed)
-    Event.register(Event.core_events.init, Changes.on_init)
-    return Changes
-end
-
 function Changes.dump_data()
-    local tabs = {
-        'versions',
-        'map-change-always-first',
-        'any-change-always-first',
-        'mod-change-always-first',
-        'map-change-always-last',
-        'any-change-always-last',
-        'mod-change-always-last'
-    }
-    for _, v in pairs(tabs) do
-        if Changes[v] then
-            game.write_file(Changes.get_file_path('Changes/' .. v .. '.lua'), inspect(Changes[v], {longkeys = true, arraykeys = true}))
+    for change_type in pairs(map_changes) do
+        if table.size(Changes[change_type]) > 0 then
+            game.write_file(Changes.get_file_path('Changes/' .. change_type .. '.lua'), inspect(Changes[change_type], {longkeys = true, arraykeys = true}))
         end
     end
     game.write_file(Changes.get_file_path('Changes/global.lua'), inspect(global._changes or nil, {longkeys = true, arraykeys = true}))
 end
---[Always run these before any migrations]--
---Changes["map-change-always-first"] = function() end
---Changes["any-change-always-first"] = function() end
---Changes["mod-change-always-first"] = function() end
-
---Mod version changes made
---Changes.version["0.0.1"] = function() end
-
---[Always run these at the end]--
---Changes["mod-change-always-last"] = function() end
---Changes["any-change-always-last"] = function() end
---Changes["map-change-always-last"] = function() end
 
 return Changes

stdlib/scripts/interface.lua

@@ -17,7 +17,7 @@ local Force = require('__stdlib__/stdlib/event/force')
 local serp_settings = {comment = false, nocode = true}
 
 interface['write_global'] = function()
-    --game.remove_path(script.mod_name .."/")
+    game.remove_path(script.mod_name)
     game.write_file(script.mod_name .. '/global.lua', serpent.block(global, serp_settings), false)
     game.write_file(script.mod_name .. '/global-inspect.lua', inspect(global), false)
     if remote.interfaces[script.mod_name] then
@@ -30,7 +30,7 @@ interface['write_global'] = function()
 end
 
 interface['dump_all'] = function()
-    --game.remove_path('Interfaces')
+    game.remove_path('Interfaces')
     for inter, face in pairs(remote.interfaces) do
         game.write_file('Interfaces/' .. inter .. '.lua', serpent.block(table.keys(remote.interfaces[inter], true, true), serp_settings))
         for func in pairs(face) do