Initial cspell and prettier support (#451)

* Initial cspell and prettier support

- Add cspell and prettier to yarn
- Create a config and custom word-list for cspell
- Update README
- Add Github Action for cspell
- Add Githun Action for prettier

---------

Co-authored-by: davidjharder <[email protected]>
Co-authored-by: Silke Hofstra <[email protected]>

.cspell-allowed-words.txt

@@ -0,0 +1,333 @@
+abcm
+ahci
+alienware
+anthy
+anydesk
+aosp
+apcupsd
+appindicator
+askpass
+asus
+atheros
+autodep
+autogen
+autoplay
+avahi
+ayatana
+bbswitch
+behaviour
+binutils
+bitwig
+bootable
+bootctl
+bootloader
+bootup
+bopomofo
+brasero
+brlaser
+brsaneconfig
+brscan
+bsymbolic
+buddiesofbudgie
+builddeps
+caddyfile
+caja
+cangjie
+centrino
+cflags
+changeme
+chipsets
+chrooted
+chrooting
+chsh
+cifs
+clion
+cmdline
+configfile
+confopts
+cran
+cryptsetup
+cxxflags
+datacenter
+datagrip
+dbus
+destdir
+devel
+devlog
+dircolors
+directoy
+diskutil
+distro
+distros
+docdir
+droidcam
+dtags
+dumpall
+dumpcap
+dymo
+efibootmgr
+emul
+enpass
+envsetup
+eopkg
+eopkgs
+epcsearch
+escpr
+exfat
+fastboot
+fcgi
+fdata
+fdisk
+ferryctl
+ferryd
+filesharing
+flarum
+flatpak
+flicky
+flto
+fluidsynth
+fpath
+funroll
+gamepad
+gconf
+geoclue
+getsol
+getsolus
+gobject
+goroot
+gotopkg
+gotosoluspkgs
+gpasswd
+gperf
+gssapi
+haruna
+homeserver
+hostnames
+hplip
+hyphenator
+ibetical
+ibus
+inet
+inkjet
+inspiron
+installdir
+installroot
+insync
+ipofyourscanner
+issuenumber
+journalctl
+kdenetwork
+khelp
+ksgrd
+ksshaskpass
+ksysguard
+ldflags
+libcurl
+libdir
+libfoobar
+libfreetype
+libgcc
+libgcrypt
+libgeoclue
+libglu
+libgpod
+libgtk
+libideviceactivation
+libimobiledevice
+libinput
+libjpeg
+libspeex
+libspeexdsp
+libsplit
+libssh
+libstdc
+libsuffix
+libudev
+libuiohook
+libwebp
+lifebook
+luks
+lutris
+lvchange
+lzop
+macbook
+maintainership
+markus
+mendeleydesktop
+metacity
+mojang
+moneydance
+mountpoint
+mprefer
+mscorefonts
+multirepo
+mydisk
+myfiles
+mygui
+nanorc
+necromancing
+nemo
+neovim
+netgear
+newerth
+nfpath
+nghttp
+nightlies
+nmbdoptions
+noauto
+nomodeset
+nopatch
+noprefixroute
+nproc
+nvme
+ocen
+ocenaudio
+oflag
+openrazer
+organised
+packagename
+persson
+perussanasto
+pfifo
+pgsql
+phab
+phabricator
+phpstorm
+pico
+pipewire
+pkgconfig
+pkgconfigs
+pkgfiles
+pkgname
+plexmediaserver
+pomo
+pomodoneapp
+portege
+powerline
+presario
+probook
+pspec
+psql
+qdisc
+qjackctl
+qlen
+qmake
+qmlc
+qosmio
+qsynth
+qtile
+quickstart
+ralink
+rbind
+rdesktop
+rdisk
+readline
+realtek
+redditor
+redistributable
+releng
+relocs
+relro
+replaceme
+resolv
+retroarch
+rhythmbox
+roccat
+rootfsbase
+routable
+rpath's
+rslave
+rstudio
+rubymine
+rundeps
+runpath
+runrecovery
+rustup
+sambaoptions
+schedtool
+schenker
+sdkman
+servername
+setcap
+sharename
+smbclient
+smbd
+smbdoptions
+smbpasswd
+solbuild
+solusesp
+somekey
+someotherpackage
+somepackage
+somepath
+someshare
+somevalue
+soundfont
+soundfonts
+spideroak
+squashfs
+statuslines
+subpackages
+sunvox
+synaptics
+sysconfig
+systemsettings
+taskfile
+teamviewer
+teamviewerd
+tecra
+testparm
+thinkpad
+tidyverse
+tigervnc
+timeframe
+titlebar
+tmpfiles
+touchpad
+touchpads
+trackpad
+uefi
+ufriilt
+unetbootin
+unikey
+untick
+usermod
+usershare
+usysconf
+utilising
+vaio
+vala
+vboot
+vboxusers
+verifyng
+vgchange
+vhba
+visio
+vncserver
+voikko
+vostro
+vpcec
+vulkan
+webstorm
+whatprovides
+whatuses
+winbind
+winbindoptions
+wireshark
+workdir
+wsdd
+wxwidgets
+xmodifiers
+xone
+xorg
+xorgxrdp
+xrdp
+xstartup
+xwrapper
+yjobs
+yourgithubaccount
+ypkg
+zcat
+zeroconf
+zhuyin
+zram

.cspell.json

@@ -0,0 +1,15 @@
+{
+ "version": "0.2",
+ "language": "en",
+ "words": ["add", "to", ".cspell-allowed-words.txt", "instead"],
+ "flagWords": ["flaggedword", "hte"],
+ "dictionaries": ["cspell-allowed-words"],
+
+ "dictionaryDefinitions": [
+ {
+ "name": "cspell-allowed-words",
+ "path": "./.cspell-allowed-words.txt",
+ "addWords": true
+ }
+ ]
+}

.github/workflows/prettier.yml

@@ -0,0 +1,17 @@
+name: 'Format with Prettier'
+on:
+ pull_request:
+ branches: [master]
+
+jobs:
+ prettier:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Prettify code
+ uses: creyD/[email protected]
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ prettier_options: --write **/*.{md,mdx}
+ only_changed: True

.github/workflows/spellcheck.yml

@@ -0,0 +1,19 @@
+name: 'Spellcheck with cspell'
+on:
+ pull_request:
+
+jobs:
+ spellcheck:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: streetsidesoftware/cspell-action@v5
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ files: |
+ **/*.{md,mdx}
+ inline: warning
+ strict: false
+ incremental_files_only: true
+ config: '.cspell.json'
+ verbose: false