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

Add more examples of installer switches to docs

Open SpecterShell opened this issue 1 year ago • 3 comments


Questions:

  1. Should we split the Silent and the SilentWithProgress switches into two columns?
  2. Should we add examples for each type of installer?
Microsoft Reviewers: Open in CodeFlow

SpecterShell avatar Jun 04 '24 06:06 SpecterShell

@check-spelling-bot Report

:red_circle: Please review

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

Unrecognized words (8)

actualinstaller advancedinstaller exenoui indigorose revenera tarma unattendedmodeui webhelp

Previously acknowledged words that are now absent ata bitspace EPester epth flexera helplib hrow issuetitle mapview Mta oop PFM rzkzqaqjwj sfs STARTUPINFOW testdata visualstudiocode :arrow_right:
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]:SpecterShell/winget-cli.git repository on the docs-installer-switches 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/9362588104/attempts/1'
Available :books: dictionaries could cover words not in the :blue_book: dictionary

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

Dictionary Entries Covers
cspell:win32/src/win32.txt 53509 20
cspell:python/src/python/python-lib.txt 3873 3
cspell:python/src/python/python.txt 453 2
cspell:python/src/common/extra.txt 741 2
cspell:php/php.txt 2597 2
cspell:npm/npm.txt 288 2
cspell:django/django.txt 859 2
cspell:csharp/csharp.txt 19 2
cspell:sql/src/tsql.txt 455 1
cspell:scala/scala.txt 833 1

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

      with:
        extra_dictionaries:
          cspell:win32/src/win32.txt
          cspell:python/src/python/python-lib.txt
          cspell:python/src/python/python.txt
          cspell:python/src/common/extra.txt
          cspell:php/php.txt
          cspell:npm/npm.txt
          cspell:django/django.txt
          cspell:csharp/csharp.txt
          cspell:sql/src/tsql.txt
          cspell:scala/scala.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: unexpected-line-ending 4

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 Jun 04 '24 06:06 github-actions[bot]

@check-spelling-bot Report

:red_circle: Please review

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

Unrecognized words (8)

actualinstaller advancedinstaller exenoui indigorose revenera tarma unattendedmodeui webhelp

Previously acknowledged words that are now absent ata bitspace EPester epth flexera helplib hrow issuetitle mapview Mta oop PFM rzkzqaqjwj sfs STARTUPINFOW testdata visualstudiocode :arrow_right:
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]:SpecterShell/winget-cli.git repository on the docs-installer-switches 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/9362697249/attempts/1'
Available :books: dictionaries could cover words not in the :blue_book: dictionary

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

Dictionary Entries Covers
cspell:win32/src/win32.txt 53509 20
cspell:python/src/python/python-lib.txt 3873 3
cspell:python/src/python/python.txt 453 2
cspell:python/src/common/extra.txt 741 2
cspell:php/php.txt 2597 2
cspell:npm/npm.txt 288 2
cspell:django/django.txt 859 2
cspell:csharp/csharp.txt 19 2
cspell:sql/src/tsql.txt 455 1
cspell:scala/scala.txt 833 1

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

      with:
        extra_dictionaries:
          cspell:win32/src/win32.txt
          cspell:python/src/python/python-lib.txt
          cspell:python/src/python/python.txt
          cspell:python/src/common/extra.txt
          cspell:php/php.txt
          cspell:npm/npm.txt
          cspell:django/django.txt
          cspell:csharp/csharp.txt
          cspell:sql/src/tsql.txt
          cspell:scala/scala.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: unexpected-line-ending 4

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 Jun 04 '24 07:06 github-actions[bot]

Splitting into columns might help users, and if you are pointing to some relatively stable manifests with switches, it might help. I'd just be concerned about a manifest getting removed or installer type changing, but permalinks might work.

denelon avatar Jun 04 '24 15:06 denelon

@specterShell, the spelling files need to be updated.

denelon avatar Jul 08 '24 16:07 denelon