Until DSC v3 is released, there isn't a good way to assert specific system parameters in DSC - Especially for use with WinGet. This module adds several different DSC Resources that can be used for asserting the state of a system, primarily for use in WinGet configuration files. This will allow DSC users in enterprises to target specific architectures, specific domain roles, computers with specific print servers, etc. by adding these assertions directly into their configuration YAML instead of having to push out a wrapper script that performs the checks before invoking the DSC, and without having to write their own implementations using the Script DSCResource.
These words are not needed and should be removed
Toolpackage
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words,
you could run the following commands
... in a clone of the [git@github.com:Trenly/winget-dsc.git](https://github.com/Trenly/winget-dsc.git) repository
on the `Specifications` branch ([:information_source: how do I use this?](
https://docs.check-spelling.dev/Accepting-Suggestions)):
``` sh
curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' |
perl - 'https://github.com/microsoft/winget-dsc/actions/runs/11693548741/attempts/1'
```
Pattern suggestions :scissors: (3)
You could add these patterns to `.github/actions/spelling/patterns.txt`:
```
# Automatically suggested patterns
# hit-count: 21 file-count: 7
# Compiler flags
(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})
# hit-count: 3 file-count: 1
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
# hit-count: 2 file-count: 1
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
```
Errors (2)
#### See the [:open_file_folder: files](https://github.com/microsoft/winget-dsc/pull/90/files/) view, the [:scroll:action log](https://github.com/microsoft/winget-dsc/actions/runs/11693548741/job/32565330376#step:4:1), or [:memo: job summary](https://github.com/microsoft/winget-dsc/actions/runs/11693548741/attempts/1#summary-32565330376) for details.
[:x: Errors](https://docs.check-spelling.dev/Event-descriptions) | Count
-|-
[:information_source: candidate-pattern](https://docs.check-spelling.dev/Event-descriptions#candidate-pattern) | 5
[:x: check-file-path](https://docs.check-spelling.dev/Event-descriptions#check-file-path) | 1
See [:x: Event descriptions](https://docs.check-spelling.dev/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](
https://www.regexplanet.com/advanced/perl/) 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](
../tree/HEAD/README.md) (on whichever branch you're using).
* well-formed pattern.
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.
Patterns are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
These words are not needed and should be removed
Toolpackage
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words,
you could run the following commands
... in a clone of the [git@github.com:Trenly/winget-dsc.git](https://github.com/Trenly/winget-dsc.git) repository
on the `Specifications` branch ([:information_source: how do I use this?](
https://docs.check-spelling.dev/Accepting-Suggestions)):
``` sh
curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' |
perl - 'https://github.com/microsoft/winget-dsc/actions/runs/11697788672/attempts/1'
```
Pattern suggestions :scissors: (3)
You could add these patterns to `.github/actions/spelling/patterns.txt`:
```
# Automatically suggested patterns
# hit-count: 13 file-count: 5
# Compiler flags
(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})
# hit-count: 3 file-count: 1
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
# hit-count: 2 file-count: 1
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
```
Notices (1)
#### See the [:open_file_folder: files](https://github.com/microsoft/winget-dsc/pull/90/files/) view, the [:scroll:action log](https://github.com/microsoft/winget-dsc/actions/runs/11697788672/job/32577055138#step:4:1), or [:memo: job summary](https://github.com/microsoft/winget-dsc/actions/runs/11697788672/attempts/1#summary-32577055138) for details.
[:information_source: Notices](https://docs.check-spelling.dev/Event-descriptions) | Count
-|-
[:information_source: candidate-pattern](https://docs.check-spelling.dev/Event-descriptions#candidate-pattern) | 5
See [:information_source: Event descriptions](https://docs.check-spelling.dev/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](
https://www.regexplanet.com/advanced/perl/) 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](
../tree/HEAD/README.md) (on whichever branch you're using).
* well-formed pattern.
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.
Patterns are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
Premise
Until DSC v3 is released, there isn't a good way to assert specific system parameters in DSC - Especially for use with WinGet. This module adds several different DSC Resources that can be used for asserting the state of a system, primarily for use in WinGet configuration files. This will allow DSC users in enterprises to target specific architectures, specific domain roles, computers with specific print servers, etc. by adding these assertions directly into their configuration YAML instead of having to push out a wrapper script that performs the checks before invoking the DSC, and without having to write their own implementations using the
Script
DSCResource.