Config JSON Tweaks #108
Merged
Config JSON Tweaks #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
ithinkandicode
commented
Feb 11, 2023
•
ithinkandicode
commented
- Fix missing space in log string
- Log improvements
- Generally improves log messages, giving them better user notices that are more accurate to the current issue.
- Use assert for cases where there are definite code errors that need addressing (eg. an invalid mod ID)
- Use enums for the error codes
- Rename "error" (eg. "error code") to "status"
- Remove a redundant bit of text
- Generally improve log messages, giving them better user notices that are more accurate to the current issue. - Use assert for cases where there are definite code errors that need addressing (eg. an invalid mod ID)
Qubus0
reviewed
Feb 13, 2023
Qubus0
approved these changes
Feb 13, 2023
KANAjetzt
added a commit
that referenced
this pull request
Feb 16, 2023
* set more static types, follow style guide more closely, improve readability * fix missing %s in format strings * upgrade semver validation to disallow leading zeros and overly long versions * replace printerr with log_fatal * use PoolStringArray where applicable * ✔ added file and dir existence check utils * ✅ added overwrite handling * add simple loader self setup through script flag * don't attempt setup if the autoload already exists * fix mods dir path not being overridden * 🔨 renamed functions to be more semantic * 🔨 2 blank lines after functions * 🔨 static typing * fix type inference of game_mod_folder_path * remove run.gd, as it's no longer needed * 🔨 removed unnecessary blank lines * 🔨 fill the void * Add credits * fix typo in setup where `ModLoaderUtils` should be `modloaderutils` * lint - fix not storing returned value in a variable for certain methods * lint - fix var type set not being able to be inferred Fixes error: The assigned value doesn't have a set type; the variable type can't be inferred * fix errors due to func args having the same name as local vars Fixes 2 `SHADOWED_VARIABLE` errors: - The local variable 'name' is shadowing an already-defined variable at line 9. - The local variable 'version_number' is shadowing an already-defined variable at line 15/ * revert non-inferred var type fix * ✔ added reorder_autoloads() * ✔ added file data setup * ✔ added project.binary injection * ✔ added godotPckTool * ✔ cleanup project.binary file after injection * fix typo in `_handle_missing_dependency` * ✔ added --only-setup cli arg * validate dependencies and incompatibilities (closes #23) * remove old version from the intro comment * add constant for version (`MODLOADER_VERSION`) * fix: prevent duplicate global class registration * refactor: utils global class registration does not save anymore, mod_loader exposes a new method for mods to use it and save * log info instead of warning * dependency validation: use `get_mod_id` * shorten `is_dependency_or_incompatibility_valid` to `is_mod_id_valid`, and make the `type` arg optional * assert that ModLoader is the first autoload * rename var to `is_mod_loader_first` * ✔ added --setup-create-override-cfg cli arg * store log backups and rotate them like godot * 🔨 fixed the double log * don't log the full manifest by default, add option to do this * fixes `log_fatal` to add the missing log to file Previously this func would not log to the file, which means it wouldn't show in the godot.log during mod development. Note: Unlike the `"error"` condition, I've only used `push_error` instead of also using `printerr`, because `push_error` also seems to print the error already (incl. the `ERROR: ` prefix, which `printerr` doesn't include) * ✔ added --setup-create-override-cfg cli arg * 🔨 fixed the double log * ✔ added get_autoload_array and get_autoload_index * ✔ updated `_check_first_autoload` to use utils * 🔨 added back autoload order logging * 🔨 .trim_prefix("autoload/") instead of .split('/')[1] * 🔨 might as well just use an array * 🔨 trim prefix "autoload/" in get_autoload_array() * 🧹 removed unnecessary var value in get_autoload_array() * fix: properly parse all types of command line arg values (#103) * fix: properly parse all types of command line arg values * refactor: adjust code line in doc comments * refactor: add cmdline arg fixing wrapper function * fix: also cover args without = * ✔ run setup based on position in autoloads (#105) * downgrade the missing "mods" dir error to a warning (#107) because the notice is most likely to be seen by modders in the editor, who won't be using the `mods` dir * Config JSON Tweaks (#108) * `get_mod_config` - fix missing space in log string * `get_mod_config` - log improvements - Generally improve log messages, giving them better user notices that are more accurate to the current issue. - Use assert for cases where there are definite code errors that need addressing (eg. an invalid mod ID) * `get_mod_config` - use enums for the error codes * `get_mod_config` - rename "error" (eg. "error code") to "status" * `get_mod_config` - remove a redundant bit of text * ✔ added checks for override.cfg setup (#110) * ✔ added checks for override.cfg setup * 🧹 removed logging when no autoloads are set up If there is no autoloads there will be no mod_loader.gd --------- Co-authored-by: Qubus0 <steen.rickmer@gmx.de> Co-authored-by: otDan <otdanofficial@gmail.com> Co-authored-by: Chris Bloomfield <43499897+ithinkandicode@users.noreply.github.com>
KANAjetzt
added a commit
that referenced
this pull request
Feb 16, 2023
…ource_path: String) (#120) * set more static types, follow style guide more closely, improve readability * fix missing %s in format strings * upgrade semver validation to disallow leading zeros and overly long versions * replace printerr with log_fatal * use PoolStringArray where applicable * ✔ added file and dir existence check utils * ✅ added overwrite handling * add simple loader self setup through script flag * don't attempt setup if the autoload already exists * fix mods dir path not being overridden * 🔨 renamed functions to be more semantic * 🔨 2 blank lines after functions * 🔨 static typing * fix type inference of game_mod_folder_path * remove run.gd, as it's no longer needed * 🔨 removed unnecessary blank lines * 🔨 fill the void * Add credits * fix typo in setup where `ModLoaderUtils` should be `modloaderutils` * lint - fix not storing returned value in a variable for certain methods * lint - fix var type set not being able to be inferred Fixes error: The assigned value doesn't have a set type; the variable type can't be inferred * fix errors due to func args having the same name as local vars Fixes 2 `SHADOWED_VARIABLE` errors: - The local variable 'name' is shadowing an already-defined variable at line 9. - The local variable 'version_number' is shadowing an already-defined variable at line 15/ * revert non-inferred var type fix * ✔ added reorder_autoloads() * ✔ added file data setup * ✔ added project.binary injection * ✔ added godotPckTool * ✔ cleanup project.binary file after injection * fix typo in `_handle_missing_dependency` * ✔ added --only-setup cli arg * validate dependencies and incompatibilities (closes #23) * remove old version from the intro comment * add constant for version (`MODLOADER_VERSION`) * fix: prevent duplicate global class registration * refactor: utils global class registration does not save anymore, mod_loader exposes a new method for mods to use it and save * log info instead of warning * dependency validation: use `get_mod_id` * shorten `is_dependency_or_incompatibility_valid` to `is_mod_id_valid`, and make the `type` arg optional * assert that ModLoader is the first autoload * rename var to `is_mod_loader_first` * ✔ added --setup-create-override-cfg cli arg * store log backups and rotate them like godot * 🔨 fixed the double log * don't log the full manifest by default, add option to do this * fixes `log_fatal` to add the missing log to file Previously this func would not log to the file, which means it wouldn't show in the godot.log during mod development. Note: Unlike the `"error"` condition, I've only used `push_error` instead of also using `printerr`, because `push_error` also seems to print the error already (incl. the `ERROR: ` prefix, which `printerr` doesn't include) * ✔ added --setup-create-override-cfg cli arg * 🔨 fixed the double log * ✔ added get_autoload_array and get_autoload_index * ✔ updated `_check_first_autoload` to use utils * 🔨 added back autoload order logging * 🔨 .trim_prefix("autoload/") instead of .split('/')[1] * 🔨 might as well just use an array * 🔨 trim prefix "autoload/" in get_autoload_array() * 🧹 removed unnecessary var value in get_autoload_array() * fix: properly parse all types of command line arg values (#103) * fix: properly parse all types of command line arg values * refactor: adjust code line in doc comments * refactor: add cmdline arg fixing wrapper function * fix: also cover args without = * ✔ run setup based on position in autoloads (#105) * downgrade the missing "mods" dir error to a warning (#107) because the notice is most likely to be seen by modders in the editor, who won't be using the `mods` dir * Config JSON Tweaks (#108) * `get_mod_config` - fix missing space in log string * `get_mod_config` - log improvements - Generally improve log messages, giving them better user notices that are more accurate to the current issue. - Use assert for cases where there are definite code errors that need addressing (eg. an invalid mod ID) * `get_mod_config` - use enums for the error codes * `get_mod_config` - rename "error" (eg. "error code") to "status" * `get_mod_config` - remove a redundant bit of text * ✔ added checks for override.cfg setup (#110) * ✔ added checks for override.cfg setup * 🧹 removed logging when no autoloads are set up If there is no autoloads there will be no mod_loader.gd * Validate file exists for `add_translation_from_resource` (#118) * `add_translation_from_resource` - Validate file exists * `add_translation_from_resource` - fix log name in previous commit * ✔ bump version string to 5.0.0 * ⚙ Bump version string to 5.0.1 --------- Co-authored-by: Qubus0 <steen.rickmer@gmx.de> Co-authored-by: otDan <otdanofficial@gmail.com> Co-authored-by: Chris Bloomfield <43499897+ithinkandicode@users.noreply.github.com>
Merged
Merged
KANAjetzt
pushed a commit
to GDami/godot-mod-loader
that referenced
this pull request
Feb 23, 2023
* `get_mod_config` - fix missing space in log string * `get_mod_config` - log improvements - Generally improve log messages, giving them better user notices that are more accurate to the current issue. - Use assert for cases where there are definite code errors that need addressing (eg. an invalid mod ID) * `get_mod_config` - use enums for the error codes * `get_mod_config` - rename "error" (eg. "error code") to "status" * `get_mod_config` - remove a redundant bit of text
ithinkandicode
added
the
refactor / cleanup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.