microsoft / microsoft/winget-create

Skip headings in `wingetcreate show` command

Open
#629 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Feature
Dominant language
C#
Stars
651
Forks
114
Avg merge
7h 52m
Merged PRs (30d)
3

Description

Description of the new feature / enhancement

wingetcreate show can be used in automation scenarios. For that purpose, it's output should be one that can be cleanly parsed. Current output of wingetcreate show includes headings which were originally intended for user reading experience. I think we should remove them in favor of output that is parsed more cleanly in automation scenario

While the YAML output is still parse-able, the JSON output looks like

Installer Manifest:
{
  ...
}

Default Locale (en-US) Manifest:
{
   ...
}

Version Manifest:
{
   ...
}

The headings can be replaced by something that is easier to deal with in automation scenarios, maybe something like:

{
  "InstallerManifest": {
    ...
  },
  "DefaultLocaleManifest": {
    ...
  },
  "LocaleManifests": [
    {
        ...
    },
    {
        ...
    }
  ],
  "VersionManifest": {
      ...
  }
}
Proposed technical implementation details

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the wingetcreate show command and inspect how its YAML and JSON output are assembled. Determine how the current headings are emitted and how the proposed structured JSON should represent the installer, default locale, locale, and version manifests. Done means automation can parse the output without headings while preserving the manifest data.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.