-
-
Notifications
You must be signed in to change notification settings - Fork 487
valijson: add package #8279
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
valijson: add package #8279
Conversation
Summary of ChangesHello @star-hengxing, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request integrates the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a new package for the valijson header-only library. My review identifies two main issues. First, the package as submitted is not functional because it lacks a required JSON parser adapter configuration. Second, the installation logic uses CMake, which is inefficient and unconventional for a header-only library in Xmake. I've provided suggestions to add rapidjson as a default adapter, simplify the installation to a direct file copy, and improve the test snippet to verify the adapter integration.
| add_configs("exceptions", {description = "Enable exception", default = true, type = "boolean"}) | ||
|
|
||
| add_deps("cmake") | ||
|
|
||
| on_install(function (package) | ||
| if package:config("exceptions") then | ||
| package:add("defines", "VALIJSON_USE_EXCEPTIONS=1") | ||
| end | ||
|
|
||
| local configs = {} | ||
| table.insert(configs, "-DCMAKE_BUILD_TYPE=" .. (package:is_debug() and "Debug" or "Release")) | ||
| table.insert(configs, "-DBUILD_SHARED_LIBS=" .. (package:config("shared") and "ON" or "OFF")) | ||
| import("package.tools.cmake").install(package, configs) | ||
| end) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two issues with the current package definition:
- Missing Parser Adapter:
valijsonrequires a JSON parser adapter to be functional. Without one, it's not possible to validate any JSON documents. The package should configure a default adapter. - Inefficient Installation: For a header-only library, using
cmakefor installation is unnecessary. The idiomatic approach in Xmake is to copy the header files directly usingos.cp.
The suggested change addresses both points by adding rapidjson as a dependency and default adapter, and simplifying the on_install function. This makes the package functional and more efficient, while also removing the unneeded cmake dependency.
add_configs("exceptions", {description = "Enable exception", default = true, type = "boolean"})
add_deps("rapidjson")
on_install(function (package)
if package:config("exceptions") then
package:add("defines", "VALIJSON_USE_EXCEPTIONS=1")
end
package:add("defines", "VALIJSON_ADAPTER_RAPIDJSON")
os.cp("include/valijson", package:installdir("include"))
end)
No description provided.