Skip to content

readme: change dependency name from ziglua to lua_wrapper #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 6, 2025

Conversation

robbielyman
Copy link
Collaborator

@robbielyman robbielyman commented Mar 6, 2025

the purpose of this PR is to close #139.

still left to consider:

  • the module name as defined in build.zig is currently "ziglua", and the README adopts this module name in the examples. do we want to change it, or leave it as-is?

BREAKING: build.zig code in depending projects that calls
`ziglua.module("ziglua")` will need to be changed to call
`ziglua.module("lua_wrapper")`. probably it would be good for
depending build.zig code to also update the name of their dependency,
but that is not forced by this change.
Copy link
Contributor

@nurpax nurpax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re your question in the PR overview: IMO all mentions of ziglua should be changed to lua_wrapper.

But shortening to lua_dep like you did here looks and reads well, so I like that over writing it out lua_wrapper_dep.

@robbielyman
Copy link
Collaborator Author

since merging this would force all users of ziglua to update their build.zig code (changing one line), would it be worth softening this somehow by also exporting a module named "ziglua" for a certain amount of time? maybe not, since now is when folks are making 0.14.0 changes anyway...

@robbielyman
Copy link
Collaborator Author

i'm happy to merge as-is! any strong feelings about exporting a "ziglua" module for the time being?

@nurpax
Copy link
Contributor

nurpax commented Mar 6, 2025

I think it's better to go for full churn now this once. :)

@robbielyman robbielyman merged commit 7bfb3c2 into main Mar 6, 2025
3 checks passed
@robbielyman robbielyman deleted the readme-changes branch March 6, 2025 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Module name + README mismatch with build.zig.zon
2 participants