winget-cli icon indicating copy to clipboard operation
winget-cli copied to clipboard

[Spec] WinGet configure export and import settings

Open RDMacLachlan opened this issue 2 years ago • 4 comments


Microsoft Reviewers: Open in CodeFlow

RDMacLachlan avatar Sep 27 '23 16:09 RDMacLachlan

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view or the :scroll:action log for details.

Unrecognized words (1)

rdmaclachlan

Previously acknowledged words that are now absent attr DMPAs dsc fabricbot remoting Syncy timezone wfopen :arrow_right:
Some files were automatically ignored

These sample patterns would exclude them:

^\Qsrc/AppInstallerCLIE2ETests/TestData/Configuration/Empty.yml\E$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept :heavy_check_mark: these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the [email protected]:RDMacLachlan/winget-cli.git repository on the user/romaclac/Spec/WinGet-export-and-import-settings branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' |
perl - 'https://github.com/microsoft/winget-cli/actions/runs/6328774832/attempts/1'
Available :books: dictionaries could cover words not in the :blue_book: dictionary

This includes both expected items (556) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary Entries Covers
cspell:cpp/src/cpp.txt 30216 30
cspell:win32/src/win32.txt 53509 25
cspell:python/src/python/python-lib.txt 3873 6
cspell:php/php.txt 2597 5
cspell:python/src/common/extra.txt 741 4
cspell:java/java.txt 7642 4
cspell:python/src/python/python.txt 453 3
cspell:npm/npm.txt 288 2
cspell:golang/go.txt 3412 2
cspell:dotnet/dotnet.txt 2263 2

Consider adding them using (in .github/workflows/spelling3.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:win32/src/win32.txt
          cspell:python/src/python/python-lib.txt
          cspell:php/php.txt
          cspell:python/src/common/extra.txt
          cspell:java/java.txt
          cspell:python/src/python/python.txt
          cspell:npm/npm.txt
          cspell:golang/go.txt
          cspell:dotnet/dotnet.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Warnings (1)

See the :open_file_folder: files view or the :scroll:action log for details.

:information_source: Warnings Count
:information_source: binary-file 1

See :information_source: Event descriptions for more information.

If the flagged items are :exploding_head: false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

github-actions[bot] avatar Sep 27 '23 16:09 github-actions[bot]

Speaking with Demitrius, it appears that the WinGet DSC will solve the issue I was attempting to solve with a new sub-command..

RDMacLachlan avatar Sep 27 '23 18:09 RDMacLachlan

Speaking with Demitrius, it appears that the WinGet DSC will solve the issue I was attempting to solve with a new sub-command..

I've added some comments to

  • https://github.com/microsoft/winget-cli/issues/3693

denelon avatar Sep 27 '23 18:09 denelon

@RDMacLachlan whats the latest update on this?

mominshaikhdevs avatar Jul 31 '24 02:07 mominshaikhdevs

Cleaning up old PRs.

We have already implemented winget configure export --all -o config.winget

denelon avatar Oct 08 '25 22:10 denelon