Skip to content

Commit

Permalink
Add spell check (#39)
Browse files Browse the repository at this point in the history
* Add dictionary wordlist and spellcheck script

* Add spell check

* Added spell check

* Add hunspell

* Add AAC to dict

* Added additional words to dictionary

* Added additional word spellings

* Maybe overwrote file

* Corrected spelling errors

* Finished final spellings
  • Loading branch information
robert-will-brown authored Sep 1, 2022
1 parent 277da50 commit 643f6f4
Show file tree
Hide file tree
Showing 13 changed files with 251 additions and 89,124 deletions.
15 changes: 14 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
name: Tests
on: [pull_request, workflow_dispatch]
jobs:

spelling:
name: Spell Check
runs-on: ubuntu-latest
steps:
- name: Set up Git repository
uses: actions/checkout@v2
- name: Install hunspell
run: sudo apt-get -y install hunspell hunspell-en-gb
- name: Spell Check
run: cicd/Spelling.sh
shell: bash --noprofile --norc -eo pipefail -o nounset {0}

build_pdf:
name: Create Test PDF
runs-on: ubuntu-latest
Expand Down Expand Up @@ -38,7 +51,7 @@ jobs:
name: video-streaming-cheatsheet.pdf
path: ./video-streaming-cheatsheet.pdf

test_two_pages:
two_pages:
name: Check Num Pages
needs: build_pdf
runs-on: ubuntu-latest
Expand Down
53 changes: 53 additions & 0 deletions 3
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
1080i
2D
3D
720p
ADI
APIs
Bitrate
chrominance
Codec
Comcast
DRM
FairPlay
Github
HD
HEVC
IPTV
ITU
Intra
Javascript
Luminance
Monetisation
Movielabs
Multicast
NTSC
Narrowcast
OTT
Ogg
OpenGL
PlayReady
Pre
RGB
TCP
Telco
Transactional
Transcode
UHD
Unicast
VLC
Vorbis
WMV
WebGL
WebRTC
bitrate
codebase
codec
codecs
colour
criminalise
decrypt
decrypting
js
natively
utilised
18 changes: 18 additions & 0 deletions cicd/Spelling.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/bash
#
# Check the spelling of the LaTeX file and fail if there are errors.
#

hunspellOutput="$(hunspell -d en_GB -t -a -l -p dict/words **/*tex)"
if [ "${hunspellOutput}" != "" ]; then
# Spelling errors
echo ""
echo "======================================="
echo "There are spelling errors listed below."
echo "Either fix, or add to \"dict/words\""
echo "======================================="
echo ""
hunspell -d en_GB -t -a -l -p dict/words **/*tex
exit 1

fi
Loading

0 comments on commit 643f6f4

Please sign in to comment.