New module Microsoft.Windows.Settings

.github/actions/spelling/allow.txt

@@ -60,10 +60,32 @@ vsconfig
 website
 websites
 wekyb
+Hmmss
+MMdd
+azdoserver
+Codecov
+eature
+HQRM
+hqrmtest
+modulefast
+MOF
+nupkg
+powershellgallery
+quickconfig
+QWord
+registrering
+schange
+setvariable
+sourcing
+splatting
+updatebuildnumber
+vso
+winrm
+MMdd
+NOLOGO
 whatif
 wildcards
 Windo
 winget
 workflows
 worktree
-yml

.gitignore

@@ -348,3 +348,6 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# Output folder from Sampler module
+**/output/

.vscode/analyzersettings.psd1

@@ -0,0 +1,44 @@
+@{
+    CustomRulePath      = '.\output\RequiredModules\DscResource.AnalyzerRules'
+    includeDefaultRules = $true
+    IncludeRules   = @(
+        # DSC Resource Kit style guideline rules.
+        'PSAvoidDefaultValueForMandatoryParameter',
+        'PSAvoidDefaultValueSwitchParameter',
+        'PSAvoidInvokingEmptyMembers',
+        'PSAvoidNullOrEmptyHelpMessageAttribute',
+        'PSAvoidUsingCmdletAliases',
+        'PSAvoidUsingComputerNameHardcoded',
+        'PSAvoidUsingDeprecatedManifestFields',
+        'PSAvoidUsingEmptyCatchBlock',
+        'PSAvoidUsingInvokeExpression',
+        'PSAvoidUsingPositionalParameters',
+        'PSAvoidShouldContinueWithoutForce',
+        'PSAvoidUsingWMICmdlet',
+        'PSAvoidUsingWriteHost',
+        'PSDSCReturnCorrectTypesForDSCFunctions',
+        'PSDSCStandardDSCFunctionsInResource',
+        'PSDSCUseIdenticalMandatoryParametersForDSC',
+        'PSDSCUseIdenticalParametersForDSC',
+        'PSMisleadingBacktick',
+        'PSMissingModuleManifestField',
+        'PSPossibleIncorrectComparisonWithNull',
+        'PSProvideCommentHelp',
+        'PSReservedCmdletChar',
+        'PSReservedParams',
+        'PSUseApprovedVerbs',
+        'PSUseCmdletCorrectly',
+        'PSUseOutputTypeCorrectly',
+        'PSAvoidGlobalVars',
+        'PSAvoidUsingConvertToSecureStringWithPlainText',
+        'PSAvoidUsingPlainTextForPassword',
+        'PSAvoidUsingUsernameAndPasswordParams',
+        'PSDSCUseVerboseMessageInDSCResource',
+        'PSShouldProcess',
+        'PSUseDeclaredVarsMoreThanAssignments',
+        'PSUsePSCredentialType',
+
+        'Measure-*'
+    )
+
+}

.vscode/settings.json

@@ -4,19 +4,16 @@
         "files.encoding": "utf8bom",
         "files.autoGuessEncoding": true
     },
-    "powershell.codeFormatting.preset": "OTBS",
-    "powershell.codeFormatting.useConstantStrings": true,
-    "powershell.codeFormatting.trimWhitespaceAroundPipe": true,
-    "powershell.codeFormatting.useCorrectCasing": true,
-    "powershell.codeFormatting.whitespaceBeforeOpenParen": true,
-    "powershell.codeFormatting.whitespaceBetweenParameters": true,
-    "powershell.codeFormatting.addWhitespaceAroundPipe": true,
-    "powershell.codeFormatting.alignPropertyValuePairs": true,
-    "powershell.codeFormatting.autoCorrectAliases": true,
-    "powershell.codeFormatting.avoidSemicolonsAsLineTerminators": true,
-    "powershell.codeFormatting.ignoreOneLineBlock": true,
+    "powershell.codeFormatting.openBraceOnSameLine": false,
+    "powershell.codeFormatting.newLineAfterOpenBrace": true,
+    "powershell.codeFormatting.newLineAfterCloseBrace": true,
     "powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
+    "powershell.codeFormatting.whitespaceBeforeOpenParen": true,
     "powershell.codeFormatting.whitespaceAroundOperator": true,
     "powershell.codeFormatting.whitespaceAfterSeparator": true,
-    "powershell.codeFormatting.whitespaceInsideBrace": true
+    "powershell.codeFormatting.ignoreOneLineBlock": false,
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
+    "powershell.codeFormatting.preset": "Custom",
+    "powershell.codeFormatting.alignPropertyValuePairs": true,
+    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
 }

resources/Microsoft.Windows.Settings/.gitattributes

@@ -0,0 +1,15 @@
+# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
+* text eol=autocrlf
+
+*.mof   text eol=crlf
+*.sh    text eol=lf
+*.svg   eol=lf
+
+# Ensure any exe files are treated as binary
+*.exe binary
+*.jpg binary
+*.xl* binary
+*.pfx binary
+*.png binary
+*.dll binary
+*.so  binary

resources/Microsoft.Windows.Settings/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog for Microsoft.Windows.Settings
+
+The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- For new features.
+
+### Changed
+
+- For changes in existing functionality.
+
+### Deprecated
+
+- For soon-to-be removed features.
+
+### Removed
+
+- For now removed features.
+
+### Fixed
+
+- For any bug fix.
+
+### Security
+
+- In case of vulnerabilities.

resources/Microsoft.Windows.Settings/GitVersion.yml

@@ -0,0 +1,40 @@
+mode: ContinuousDelivery
+next-version: 0.0.1
+major-version-bump-message: '(breaking\schange|breaking|major)\b'
+minor-version-bump-message: '(adds?|features?|minor)\b'
+patch-version-bump-message: '\s?(fix|patch)'
+no-bump-message: '\+semver:\s?(none|skip)'
+assembly-informational-format: '{NuGetVersionV2}+Sha.{Sha}.Date.{CommitDate}'
+branches:
+  master:
+    tag: preview
+    regex: ^main$
+  pull-request:
+    tag: PR
+  feature:
+    tag: useBranchName
+    increment: Minor
+    regex: f(eature(s)?)?[\/-]
+    source-branches: ['master']
+  hotfix:
+    tag: fix
+    increment: Patch
+    regex: (hot)?fix(es)?[\/-]
+    source-branches: ['master']
+
+ignore:
+  sha: []
+merge-message-formats: {}
+
+
+# feature:
+#   tag: useBranchName
+#   increment: Minor
+#   regex: f(eature(s)?)?[/-]
+#   source-branches: ['master']
+# hotfix:
+#   tag: fix
+#   increment: Patch
+#   regex: (hot)?fix(es)?[/-]
+#   source-branches: ['master']
+

resources/Microsoft.Windows.Settings/README.md

@@ -0,0 +1,27 @@
+# Microsoft.Windows.Settings
+
+The DSC resource module `Microsoft.Windows.Settings` provides a set of Desired State Configuration (DSC) resources for managing Windows settings. These resources allow you to configure and manage settings such as app preferences, device experiences, and USB configurations through PowerShell DSC.
+
+## Wiki and module under construction :construction:
+
+## Resources :construction:
+
+- **AdvancedAppSettings**: Manage advanced application settings including app source preferences and device sharing experiences.
+- **USB**: Manage USB device settings including enabling/disabling devices, allowing wake, and selective suspend options.
+
+## Usage :construction:
+
+To use these resources, import the module and invoke the desired DSC resource with the appropriate parameters.
+
+```powershell
+Import-Module -Name Microsoft.Windows.Settings
+
+Invoke-DscResource -ModuleName Microsoft.Windows.Settings -Name AdvancedAppSettings -Method Set -Property @{
+    SID = 'S-1-5-21-1234567890-123456789-1234567890-1001';
+    AppSourcePreference = 'PreferStore';
+    ShareDeviceExperience = 'Everyone';
+    ArchiveApp = $true;
+}
+```
+
+For more detailed examples and parameter descriptions, refer to the individual resource documentation.

resources/Microsoft.Windows.Settings/RequiredModules.psd1

@@ -0,0 +1,31 @@
+@{
+    <#
+        This is only required if you need to use the method PowerShellGet & PSDepend
+        It is not required for PSResourceGet or ModuleFast (and will be ignored).
+        See Resolve-Dependency.psd1 on how to enable methods.
+    #>
+    #PSDependOptions             = @{
+    #    AddToPath  = $true
+    #    Target     = 'output\RequiredModules'
+    #    Parameters = @{
+    #        Repository = 'PSGallery'
+    #    }
+    #}
+
+    InvokeBuild                 = 'latest'
+    PSScriptAnalyzer            = 'latest'
+    Pester                      = 'latest'
+    ModuleBuilder               = 'latest'
+    ChangelogManagement         = 'latest'
+    Sampler                     = 'latest'
+    'Sampler.GitHubTasks'       = 'latest'
+    MarkdownLinkCheck           = 'latest'
+    'DscResource.Base'          = 'latest'
+    'DscResource.Common'        = 'latest'
+    'DscResource.Test'          = 'latest'
+    'DscResource.AnalyzerRules' = 'latest'
+    xDscResourceDesigner        = 'latest'
+    'DscResource.DocGenerator'  = 'latest'
+    PSDesiredStateConfiguration = 'latest'
+}
+