Skip to content
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.

Sign up for GitHub

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

[vcpkg] json format for search #12509

Merged
merged 4 commits into from
Sep 5, 2020
Merged

[vcpkg] json format for search #12509

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
697f737
json format for search
dan-shaw Jul 20, 2020
30f694e
fix merge
dan-shaw Aug 17, 2020
bbd511c
fixes
dan-shaw Aug 17, 2020
430b176
Merge remote-tracking branch 'origin/master' into vcpkg-search-json
BillyONeal Aug 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 40 additions & 8 deletions toolsrc/src/vcpkg/commands.search.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,27 @@ using vcpkg::PortFileProvider::PathsPortFileProvider;
namespace vcpkg::Commands::Search
Copy link
Contributor

Choose a reason for hiding this comment

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

We also should ensure that we do not emit the survey message when passing x-json.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think vcpkg runs the survey message when using the search command.

{
static constexpr StringLiteral OPTION_FULLDESC = "x-full-desc"; // TODO: This should find a better home, eventually
static constexpr StringLiteral OPTION_JSON = "x-json";

static void do_print_json(std::vector<const vcpkg::SourceControlFile*> source_control_files)
{
Json::Object obj;
for (const SourceControlFile* scf : source_control_files)
{
auto& source_paragraph = scf->core_paragraph;
Json::Object& library_obj = obj.insert(source_paragraph->name, Json::Object());
library_obj.insert("package_name", Json::Value::string(source_paragraph->name));
library_obj.insert("version", Json::Value::string(source_paragraph->version));
library_obj.insert("port_version", Json::Value::integer(source_paragraph->port_version));
Json::Array& desc = library_obj.insert("description", Json::Array());
for (const auto& line : source_paragraph->description)
{
desc.push_back(Json::Value::string(line));
}
}

System::print2(Json::stringify(obj, Json::JsonStyle{}));
}
static void do_print(const SourceParagraph& source_paragraph, bool full_desc)
{
auto full_version = VersionT(source_paragraph.version, source_paragraph.port_version).to_string();
Expand Down Expand Up @@ -59,8 +79,9 @@ namespace vcpkg::Commands::Search
}
}

static constexpr std::array<CommandSwitch, 1> SEARCH_SWITCHES = {{
static constexpr std::array<CommandSwitch, 2> SEARCH_SWITCHES = {{
{OPTION_FULLDESC, "Do not truncate long text"},
{OPTION_JSON, "(experimental) List libraries in JSON format"},
}};

const CommandStructure COMMAND_STRUCTURE = {
Expand All @@ -77,6 +98,7 @@ namespace vcpkg::Commands::Search
{
const ParsedArguments options = args.parse_arguments(COMMAND_STRUCTURE);
const bool full_description = Util::Sets::contains(options.switches, OPTION_FULLDESC);
const bool enable_json = Util::Sets::contains(options.switches, OPTION_JSON);

PathsPortFileProvider provider(paths, args.overlay_ports);
auto source_paragraphs =
Expand All @@ -85,12 +107,19 @@ namespace vcpkg::Commands::Search

if (args.command_arguments.empty())
{
for (const auto& source_control_file : source_paragraphs)
if (enable_json)
{
do_print(*source_control_file->core_paragraph, full_description);
for (auto&& feature_paragraph : source_control_file->feature_paragraphs)
do_print_json(source_paragraphs);
}
else
{
for (const auto& source_control_file : source_paragraphs)
{
do_print(source_control_file->core_paragraph->name, *feature_paragraph, full_description);
do_print(*source_control_file->core_paragraph, full_description);
for (auto&& feature_paragraph : source_control_file->feature_paragraphs)
{
do_print(source_control_file->core_paragraph->name, *feature_paragraph, full_description);
}
}
}
}
Expand Down Expand Up @@ -137,9 +166,12 @@ namespace vcpkg::Commands::Search
}
}

System::print2(
"\nIf your library is not listed, please open an issue at and/or consider making a pull request:\n"
" https://github.com/Microsoft/vcpkg/issues\n");
if (!enable_json)
{
System::print2(
"\nIf your library is not listed, please open an issue at and/or consider making a pull request:\n"
" https://github.com/Microsoft/vcpkg/issues\n");
}

Checks::exit_success(VCPKG_LINE_INFO);
}
Expand Down