microsoft / winget-dsc

MIT License
23 stars 14 forks source link

New module script #121

Closed Gijsreyn closed 1 week ago

Gijsreyn commented 2 weeks ago

@denelon Separate PR to add utility folder to create new DSC resource modules. Adjusted the CONTRIBUTING.md.

Microsoft Reviewers: Open in CodeFlow
github-actions[bot] commented 2 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

Workaround

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:Gijsreyn/winget-dsc.git](https://github.com/Gijsreyn/winget-dsc.git) repository on the `utility-improvement` 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/11716138655/attempts/1' ```
Pattern suggestions :scissors: (3) You could add these patterns to `.github/actions/spelling/patterns.txt`: ``` # Automatically suggested patterns # hit-count: 15 file-count: 6 # Compiler flags (?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) # hit-count: 3 file-count: 2 # GitHub SHAs (markdown) (?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) # hit-count: 3 file-count: 1 # githubusercontent /[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]* ```
Notices (1) #### See the [:open_file_folder: files](https://github.com/microsoft/winget-dsc/pull/121/files/) view, the [:scroll:action log](https://github.com/microsoft/winget-dsc/actions/runs/11716138655/job/32633691176#step:4:1), or [:memo: job summary](https://github.com/microsoft/winget-dsc/actions/runs/11716138655/attempts/1#summary-32633691176) 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) | 6 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.
denelon commented 1 week ago

I think we should add something related to the .winget configuration for the project in the CONTRIBUTING.md file. I think @Kaleb and I found a bug in the configuration file, so it might be OK to let this go "as is" until we figure out what the fix is.

Gijsreyn commented 1 week ago

@denelon I think if I'm not mistaken, you are referring to #125