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.

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

Updates to the PowerShell modules #4716

Merged
merged 19 commits into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
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
36 changes: 36 additions & 0 deletions .github/actions/spelling/expect.txt
kilasuit marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
AType
AUrl
auxdata
awgpm
awgs
azcopy
azurewebsites
Baz
Expand Down Expand Up @@ -85,7 +87,10 @@
CLOSEAPP
cloudapp
clsctx
clsid
cmpwgc
CMSG
cnwgc
cobertura
CODEOWNERS
codepage
Expand All @@ -110,6 +115,7 @@
cswinrt
ctc
CTL
ctwgcy
currentuser
dacl
datetimeoffset
Expand All @@ -134,6 +140,7 @@
DUPLICATEALIAS
dustojnikhummer
dvinns
dwgs
ecfr
ecfrbrowse
EFGH
Expand All @@ -148,10 +155,13 @@
ESRB
etest
etl
ewgp
ewgs
execustom
EXEHASH
experimentalfeatures
fdw
fdwgp
FECAFEB
fedorapeople
fileinuse
Expand Down Expand Up @@ -188,6 +198,13 @@
GRPICONDIRENTRY
guiddef
Gumbalapura
gwgc
gwgcd
gwgp
gwgse
gwgso
gwgus
gwgv
Hackathon
hashtables
helplib
Expand Down Expand Up @@ -233,8 +250,10 @@
ishelp
ISQ
ISVs
iswgp
itr
iwr
iwgc
JArray
JDictionary
jdk
Expand Down Expand Up @@ -354,6 +373,7 @@
notalostreference
NOTAPROPERTY
NOTIMPL
notmatch
NOTRACK
NOUPDATE
nowarn
Expand Down Expand Up @@ -456,19 +476,25 @@
Roronoa
rosoft
rowid
rowids

Check warning on line 479 in .github/actions/spelling/expect.txt

View workflow job for this annotation

GitHub Actions / Check Spelling

`rowids` is ignored by check spelling because another more general variant is also in expect. (ignored-expect-variant)
roy
rpwgpm
RRF
rrr
rswgs
RTTI
runspace
runtimeclass
runtimes
rwgch
rwgs
ryfu
sacl
SARL
sas
SASURL
savepoint
sawgc
schematab
Scm
sddl
Expand Down Expand Up @@ -503,6 +529,7 @@
sourceversion
spamming
SPAPI
spwgc
sqlite
Srinivasan
SRL
Expand All @@ -518,6 +545,7 @@
Sudarshan
superstring
swervy
swgus
SYD
SYG
sysrefcomp
Expand All @@ -527,6 +555,8 @@
taskhostw
tcs
TEMPDIRECTORY
templating
Templating

Check warning on line 559 in .github/actions/spelling/expect.txt

View workflow job for this annotation

GitHub Actions / Check Spelling

`Templating` is ignored by check spelling because another more general variant is also in expect. (ignored-expect-variant)
temppath
testexampleinstaller
thiscouldbeapc
Expand All @@ -537,11 +567,15 @@
transitioning
trimstart
ttl
twgc
twgus
typedef
typeparam
UCase
ucasemap
UChars
ucnv
udwgp
uec
ULONGLONG
UNAVAIL
Expand All @@ -564,6 +598,7 @@
USEDEFAULT
userfilesetting
userprofile
uswgp
uwp
VALUENAMECASE
vclib
Expand All @@ -578,6 +613,7 @@
webpages
Webserver
website
websites

Check warning on line 616 in .github/actions/spelling/expect.txt

View workflow job for this annotation

GitHub Actions / Check Spelling

`websites` is ignored by check spelling because another more general variant is also in expect. (ignored-expect-variant)
wesome
wfsopen
wgetenv
Expand Down
3 changes: 3 additions & 0 deletions .github/actions/spelling/patterns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -201,3 +201,6 @@ ReplaceWhileCopying\(L.*\)

# devil fruits
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\sno Mi

# PowerShell Aliases defined in .cs files (not those in AliasesToExport in psd1 files)
\[Alias\("[a-z]+"\)\]
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

[Get-WinGetSettings](Get-WinGetSettings.md)
[Get-WinGetSetting](Get-WinGetSetting.md)

[Set-WinGetUserSettings](Set-WinGetUserSettings.md)
[Set-WinGetUserSetting](Set-WinGetUserSetting.md)
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

[Get-WinGetSettings](Get-WinGetSettings.md)
[Get-WinGetSetting](Get-WinGetSetting.md)

[Disable-WinGetSetting](Disable-WinGetSetting.md)
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Module Name: Microsoft.WinGet.Client
ms.date: 08/01/2024
online version:
schema: 2.0.0
title: Get-WinGetSettings
title: Get-WinGetSetting
---

# Get-WinGetSettings
# Get-WinGetSetting

## SYNOPSIS
Gets WinGet configuration settings.

## SYNTAX

```
Get-WinGetSettings [-AsPlainText] [<CommonParameters>]
Get-WinGetSetting [-AsPlainText] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -32,7 +32,7 @@ For more information about WinGet settings, see
### Example 1 - Display the WinGet configuration settings

```powershell
Get-WinGetSettings
Get-WinGetSetting
```

```Output
Expand All @@ -47,7 +47,7 @@ adminSettings {[ProxyCommandLineOptions, False], [LocalArchiveMalwareScanOve
### Example 2 - Display the administrative settings in WinGet configuration

```powershell
Get-WinGetSettings | Select-Object -ExpandProperty adminSettings
Get-WinGetSetting | Select-Object -ExpandProperty adminSettings
```

```Output
Expand Down Expand Up @@ -97,6 +97,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

[Get-WinGetUserSettings](Get-WinGetUserSettings.md)
[Get-WinGetUserSetting](Get-WinGetUserSetting.md)

[Set-WinGetUserSettings](Set-WinGetUserSettings.md)
[Set-WinGetUserSetting](Set-WinGetUserSetting.md)
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@ Module Name: Microsoft.WinGet.Client
ms.date: 08/01/2024
online version:
schema: 2.0.0
title: Get-WinGetUserSettings
title: Get-WinGetUserSetting
---

# Get-WinGetUserSettings
# Get-WinGetUserSetting

## SYNOPSIS
Gets user settings for WinGet.

## SYNTAX

```
Get-WinGetUserSettings [<CommonParameters>]
Get-WinGetUserSetting [<CommonParameters>]
```

## DESCRIPTION

This command displays the WinGet settings for the current user. The settings are stored in
`$env:LOCALAPPDATA\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json`.
This file only exists if you have changed a user setting, for example, using the `Set-WinGetUserSettings` command.
This file only exists if you have changed a user setting, for example, using the `Set-WinGetUserSetting` command.

## EXAMPLES

### Example 1: Get the WinGet settings for the current user

```powershell
Get-WinGetUserSettings
Get-WinGetUserSetting
```

## PARAMETERS
Expand All @@ -53,6 +53,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

[Get-WinGetSettings](Get-WinGetSettings.md)
[Get-WinGetSetting](Get-WinGetSetting.md)

[Set-WinGetUserSettings](Set-WinGetUserSettings.md)
[Set-WinGetUserSetting](Set-WinGetUserSetting.md)
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ Searches configured sources for packages.
### [Get-WinGetPackage](Get-WinGetPackage.md)
Gets installed packages.

### [Get-WinGetSettings](Get-WinGetSettings.md)
### [Get-WinGetSetting](Get-WinGetSetting.md)
Gets WinGet settings.

### [Get-WinGetSource](Get-WinGetSource.md)
Gets configured WinGet sources.

### [Get-WinGetUserSettings](Get-WinGetUserSettings.md)
### [Get-WinGetUserSetting](Get-WinGetUserSetting.md)
Gets user settings for WinGet.

### [Get-WinGetVersion](Get-WinGetVersion.md)
Expand All @@ -58,10 +58,10 @@ Repairs the WinGet client.
### [Reset-WinGetSource](Reset-WinGetSource.md)
Resets default WinGet sources.

### [Set-WinGetUserSettings](Set-WinGetUserSettings.md)
### [Set-WinGetUserSetting](Set-WinGetUserSetting.md)
Sets WinGet settings.

### [Test-WinGetUserSettings](Test-WinGetUserSettings.md)
### [Test-WinGetUserSetting](Test-WinGetUserSetting.md)
Tests WinGet settings.

### [Uninstall-WinGetPackage](Uninstall-WinGetPackage.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Module Name: Microsoft.WinGet.Client
ms.date: 08/01/2024
online version:
schema: 2.0.0
title: Set-WinGetUserSettings
title: Set-WinGetUserSetting
---

# Set-WinGetUserSettings
# Set-WinGetUserSetting

## SYNOPSIS
Sets configuration settings of the WinGet client for the current user.

## SYNTAX

```
Set-WinGetUserSettings -UserSettings <Hashtable> [-Merge] [<CommonParameters>]
Set-WinGetUserSetting -UserSettings <Hashtable> [-Merge] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -31,7 +31,7 @@ For more information about WinGet settings, see
### Example 1: Set progress bar theme

```powershell
Set-WinGetUserSettings -UserSettings @{
Set-WinGetUserSetting -UserSettings @{
visual = @{
progressBar = 'rainbow'
}
Expand All @@ -43,7 +43,7 @@ Sets the theme of the progress bar to rainbow.
### Example 2: Merge install behavior settings

```powershell
Set-WinGetUserSettings -Merge -UserSettings @{
Set-WinGetUserSetting -Merge -UserSettings @{
installBehavior = @{
preferences = @{
scope = 'user'
Expand All @@ -57,7 +57,7 @@ Appends the user scope preference setting to the existing WinGet settings config
### Example 3: Change multiple settings

```powershell
Set-WinGetUserSettings -UserSettings @{
Set-WinGetUserSetting -UserSettings @{
visual = @{
progressBar = 'rainbow'
anonymizeDisplayedPaths = $true
Expand Down Expand Up @@ -121,6 +121,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

[Get-WinGetUserSettings](Get-WinGetUserSettings.md)
[Get-WinGetUserSetting](Get-WinGetUserSetting.md)

[Test-WinGetUserSettings](Test-WinGetUserSettings.md)
[Test-WinGetUserSetting](Test-WinGetUserSetting.md)
Loading
Loading