The official repo for a project involving a crowdsourced DFIR book. The main purpose of this book is to give anyone interested an opportunity to write a chapter of a book to get their name out there, get a publication on their resume with an actual ISBN number, and ideally lower the bar for people to contribute something back to the DFIR Community. Want to write a chapter? Let me know and let's make it happen!
MIT License
185
stars
22
forks
source link
Update excludes.txt - add Markdown (.md) to ignore list #196
To have the bot do this for you, reply quoting the following line:
@check-spelling-bot apply updates.
Available :books: dictionaries could cover words not in the :blue_book: dictionary
Dictionary | Entries | Covers
-|-|-
[cspell:cpp/src/cpp.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/cpp/src/cpp.txt)|30216|99|
[cspell:software-terms/src/software-terms.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/software-terms/src/software-terms.txt)|1237|81|
[cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/python/python-lib.txt)|3873|33|
[cspell:php/php.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/php/php.txt)|2597|33|
[cspell:node/node.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/node/node.txt)|1768|25|
[cspell:win32/src/win32.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/win32/src/win32.txt)|53509|19|
[cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/filetypes/filetypes.txt)|264|19|
[cspell:npm/npm.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/npm/npm.txt)|288|18|
[cspell:aws/aws.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/aws/aws.txt)|218|18|
[cspell:typescript/typescript.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/typescript/typescript.txt)|1211|17|
Consider adding them using (in `.github/workflows/spelling.yml`):
``` yml
with:
extra_dictionaries:
cspell:cpp/src/cpp.txt
cspell:software-terms/src/software-terms.txt
cspell:python/src/python/python-lib.txt
cspell:php/php.txt
cspell:node/node.txt
cspell:win32/src/win32.txt
cspell:filetypes/filetypes.txt
cspell:npm/npm.txt
cspell:aws/aws.txt
cspell:typescript/typescript.txt
```
To stop checking additional dictionaries, add:
``` yml
with:
check_extra_dictionaries: ''
```
Pattern suggestions :scissors: (21)
You could add these patterns to .github/actions/spelling/patterns.txt:
```
# Automatically suggested patterns
# hit-count: 356 file-count: 24
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]
# hit-count: 44 file-count: 17
# hex runs
\b[0-9a-fA-F]{16,}\b
# hit-count: 24 file-count: 2
# version suffix v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))
# hit-count: 15 file-count: 11
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+\)
# hit-count: 14 file-count: 8
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
# hit-count: 13 file-count: 6
# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there
# YouTube url
\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]*
# hit-count: 9 file-count: 8
# Twitter status
\btwitter\.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)
# hit-count: 8 file-count: 5
# uuid:
\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b
# hit-count: 8 file-count: 2
# microsoft
\b(?:https?://|)(?:(?:download\.visualstudio|docs|msdn2?|research)\.microsoft|blogs\.msdn)\.com/[-_a-zA-Z0-9()=./%]*
# hit-count: 6 file-count: 5
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
# hit-count: 6 file-count: 3
# Wikipedia
\ben\.wikipedia\.org/wiki/[-\w%.#]+
# hit-count: 4 file-count: 4
# Amazon
\bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|)
# hit-count: 3 file-count: 1
# URL escaped characters
\%[0-9A-F][A-F]
# hit-count: 2 file-count: 1
# discord
/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,}
# hit-count: 2 file-count: 1
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b
# hit-count: 1 file-count: 1
# gist github
\bgist\.github\.com/[^/\s"]+/[0-9a-f]+
# hit-count: 1 file-count: 1
# ibm
[a-z.]*ibm\.com/[-_#=:%!?~.\\/\d\w]*
# hit-count: 1 file-count: 1
# imgur
\bimgur\.com/[^.]+
# hit-count: 1 file-count: 1
# Internet Archive
\barchive\.org/web/\d+/(?:[-\w.?,'/\\+&%$#_:]*)
# hit-count: 1 file-count: 1
# freecodecamp.org
\bfreecodecamp\.org/[-\w/.]+
# hit-count: 1 file-count: 1
# IPv6
\b(?:[0-9a-fA-F]{0,4}:){3,7}[0-9a-fA-F]{0,4}\b
```
Errors (5)
See the [:open_file_folder: files](196/files/) view, the [:scroll:action log](https://github.com/Digital-Forensics-Discord-Server/TheHitchhikersGuidetoDFIRExperiencesFromBeginnersandExperts/actions/runs/5143856630/jobs/9259395794#step:2:1) or [:angel: SARIF report](https://github.com/Digital-Forensics-Discord-Server/TheHitchhikersGuidetoDFIRExperiencesFromBeginnersandExperts/security/code-scanning?query=is:open+pr:196) for details.
[:x: Errors](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) | Count
-|-
[:information_source: binary-file](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#binary-file) | 66
[:information_source: candidate-pattern](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#candidate-pattern) | 43
[:x: check-file-path](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#check-file-path) | 7
[:x: forbidden-pattern](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#forbidden-pattern) | 10
[:information_source: large-file](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#large-file) | 37
See [:x: Event descriptions](https://github.com/check-spelling/check-spelling/wiki/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.
Let's see how this looks when it runs during a PR...