Merge pull request #41 from funkill/spellchecking

Add spellchecking

.travis.yml

@@ -3,12 +3,18 @@ dist: trusty
 language: rust
 cache: cargo
 rust: nightly-2019-08-21 # minimum required version for async/await
+addons:
+  apt:
+    packages:
+      - aspell
+      - aspell-en
 
 before_install:
   - cargo install mdbook --vers '0.3.1' --debug --force
   - cargo install mdbook-linkcheck --vers '0.3.1' --debug --force
 
 script:
+  - bash ci/spellcheck.sh list
   - mdbook build
   - cargo test --all --manifest-path=./examples/Cargo.toml --target-dir ./target
 

ci/dictionary.txt

@@ -0,0 +1,85 @@
+personal_ws-1.1 en 0 utf-8
+ambiently
+APIs
+ArcWake
+async
+AsyncFuture
+asynchronous
+AsyncRead
+AsyncWrite
+AwaitingFutOne
+AwaitingFutTwo
+combinator
+combinators
+compat
+const
+dyn
+enqueued
+enum
+epoll
+FreeBSD
+FusedFuture
+FusedStream
+FutOne
+FutTwo
+FutureObj
+FutureResponse
+FuturesUnordered
+GenFuture
+http
+Hyper's
+impl
+interoperate
+IoBlocker
+IOCP
+IoObject
+kqueue
+metadata
+multithreaded
+Mutex
+MyError
+MyFut
+MyType
+natively
+NotSend
+OtherType
+performant
+println
+proxied
+proxying
+pseudocode
+ReadIntoBuf
+recognise
+RefCell
+requeue
+reusability
+runtime
+rustc
+rustup
+SimpleFuture
+SocketRead
+SomeType
+spawner
+StepOne
+StepTwo
+struct
+subfuture
+subfutures
+subpar
+threadpool
+TimerFuture
+TODO
+Tokio
+toml
+TryFutureExt
+tuple
+turbofish
+usize
+utils
+Waker
+waker
+Wakeups
+wakeups
+webpages
+webserver
+Woot

ci/spellcheck.sh

@@ -0,0 +1,99 @@
+#!/bin/bash
+
+aspell --version
+
+# Checks project Markdown files for spelling mistakes.
+
+# Notes:
+
+# This script needs dictionary file ($dict_filename) with project-specific
+# valid words. If this file is missing, first invocation of a script generates
+# a file of words considered typos at the moment. User should remove real typos
+# from this file and leave only valid words. When script generates false
+# positive after source modification, new valid word should be added
+# to dictionary file.
+
+# Default mode of this script is interactive. Each source file is scanned for
+# typos. aspell opens window, suggesting fixes for each found typo. Original
+# files with errors will be backed up to files with format "filename.md.bak".
+
+# When running in CI, this script should be run in "list" mode (pass "list"
+# as first argument). In this mode script scans all files and reports found
+# errors. Exit code in this case depends on scan result:
+# 1 if any errors found,
+# 0 if all is clear.
+
+# Script skips words with length less than or equal to 3. This helps to avoid
+# some false positives.
+
+# We can consider skipping source code in markdown files (```code```) to reduce
+# rate of false positives, but then we lose ability to detect typos in code
+# comments/strings etc.
+
+shopt -s nullglob
+
+dict_filename=./ci/dictionary.txt
+markdown_sources=($(find ./src -iname '*.md'))
+mode="check"
+
+# aspell repeatedly modifies the personal dictionary for some reason,
+# so we should use a copy of our dictionary.
+dict_path="/tmp/dictionary.txt"
+
+if [[ "$1" == "list" ]]; then
+    mode="list"
+fi
+
+# Error if running in list (CI) mode and there isn't a dictionary file;
+# creating one in CI won't do any good :(
+if [[ "$mode" == "list" && ! -f "$dict_filename" ]]; then
+    echo "No dictionary file found! A dictionary file is required in CI!"
+    exit 1
+fi
+
+if [[ ! -f "$dict_filename" ]]; then
+    # Pre-check mode: generates dictionary of words aspell consider typos.
+    # After user validates that this file contains only valid words, we can
+    # look for typos using this dictionary and some default aspell dictionary.
+    echo "Scanning files to generate dictionary file '$dict_filename'."
+    echo "Please check that it doesn't contain any misspellings."
+
+    echo "personal_ws-1.1 en 0 utf-8" > "$dict_filename"
+    cat "${markdown_sources[@]}" | aspell --ignore 3 list | sort -u >> "$dict_filename"
+elif [[ "$mode" == "list" ]]; then
+    # List (default) mode: scan all files, report errors.
+    declare -i retval=0
+
+    cp "$dict_filename" "$dict_path"
+
+    if [ ! -f $dict_path ]; then
+        retval=1
+        exit "$retval"
+    fi
+
+    for fname in "${markdown_sources[@]}"; do
+        command=$(aspell --ignore 3 --personal="$dict_path" "$mode" < "$fname")
+        if [[ -n "$command" ]]; then
+            for error in $command; do
+                # FIXME: find more correct way to get line number
+                # (ideally from aspell). Now it can make some false positives,
+                # because it is just a grep.
+                grep --with-filename --line-number --color=always "$error" "$fname"
+            done
+            retval=1
+        fi
+    done
+    exit "$retval"
+elif [[ "$mode" == "check" ]]; then
+    # Interactive mode: fix typos.
+    cp "$dict_filename" "$dict_path"
+
+    if [ ! -f $dict_path ]; then
+        retval=1
+        exit "$retval"
+    fi
+
+    for fname in "${markdown_sources[@]}"; do
+        aspell --ignore 3 --dont-backup --personal="$dict_path" "$mode" "$fname"
+    done
+fi