fix: return module #3
Merged
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
Previously loading this module would set `pack` and `unpack` into the global `string` library. Since these methods now exist (since Lua 5.3), other Lua modules will use these functions if they exist, assuming that they are the implemenations in Lua 5.3. More generally, modern best practice is to return the module when loading instead of setting anything globally. Obviously this is a breaking change.
|
|
Use `luarocks build` or `luarocks make` instead. The "builtin" process is much better at providing the appropriate CFLAGS.
Since it no longer pollutes the `string` table, it's just a normal module. Also use a bit of formatting.
bungle
approved these changes
Oct 26, 2021
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.
Previously loading this module would set
packandunpackinto the globalstringlibrary. Since these methods now exist (since Lua 5.3), other Lua modules will use these functions if they exist, assuming that they are the implementations in Lua 5.3.The upshot being that in various places where this module is used, the user is forced to unload it and reset the string methods in order to avoid breaking other code.
More generally, modern best practice is to return the module when loading instead of setting anything globally.
Obviously this is a breaking change, and would require a major version bump.