-
Notifications
You must be signed in to change notification settings - Fork 47
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
fix(build)!: update to zig 0.14.0 #136
Conversation
BREAKING: this PR changes the package name from `ziglua` to `lua_bindings`. not using `zig` in the package name has been repeatedly communicated as best practices, analogous to `npm`'s naming guidelines. for this particular package, this is complicated by the fact that `ziglua` provides far more than just `lua` packaged for Zig's build system (which already exists in numerous places), but also aims to provide ergonomic and powerful Zig abstractions on top of the Lua C implementation. For this reason, I chose to add "bindings" to the name. NB - the "fingerprint" field in build.zig.zon is new in Zig 0.14.0 and is computed in part based on the name. once we have settled on the name, if it is not "lua_bindings" it will be necessary to delete the fingerprint line and regenerated it.
this would close #117. @natecraddock would really love your input on the name we end up using! not at all attached to |
FWIW, I'd still vote for ziglua. But I won't be sad with the proposed name either. |
Hmmm. I don't love |
|
I guess ziglua as the repo name still makes sense? |
yeah, i think |
Okay let's do const lua_wrapper = b.dependency("lua_wrapper", .{
.target = target,
.optimize = optimize,
});
// ... snip ...
// add the ziglua module and lua artifact
exe.root_module.addImport("ziglua", lua_wrapper.module("ziglua")); Which makes me wonder, do we also change the module name? |
well, sounds like we have consensus on a good name. i'll go ahead and merge once CI goes green unless anyone has a strong opinion |
So when adding a dependency with
I guess the dependency name will be ziglua in the zon file? Or how is that decided? |
That's a good point - if that is the case, not sure what to do about that |
i think it will be |
We should be sure to update any comments / docs that use ziglua as a package name (like in the readme) |
I'll try it out. It'd make sense that the .name field is used for this. |
How build.zig.zon behaves with
It uses the .name field. Phew :) |
let's continue discussing in #139 :) |
BREAKING: this PR changes the package name from
ziglua
tolua_bindings
. not usingzig
in the package name has been repeatedly communicated as best practices, analogous tonpm
's naming guidelines. for this particular package, this is complicated by the fact thatziglua
provides far more than justlua
packaged for Zig's build system (which already exists in numerous places), but also aims to provide ergonomic and powerful Zig abstractions on top of the Lua C implementation. For this reason, I chose to add "bindings" to the name.NB - the "fingerprint" field in build.zig.zon is new in Zig 0.14.0 and is computed in part based on the name. once we have settled on the name, if it is not "lua_bindings" it will be necessary to delete the fingerprint line and regenerated it.