Add Vale to Travis CI (#1474)

* Add Vale to Travis CI * Clean up dictionary Removed the following terms: - datacenter / datacenters (see #1479) - bottem (misspelling) - programatically (misspelling) - pyintotify (misspelling) - shortcod (misspelling) - spamhuas (misspelling) - shouldn (old tokenization) * Update dictionary Removed the following terms (#1474): * apha ("alpha" is in the standard dictionary, so I didn't add it here.) * datbase * deeplearning * ebjabberd * hilight * hilights * highlite * longivew * nonrecusive * standalones * tokyo2 * webbrowser * Update dictionary Removed the following terms (#1474): * apha ("alpha" is in the standard dictionary, so I didn't add it here.) * datbase * deeplearning * ebjabberd * hilight * hilights * highlite * longivew * nonrecusive * standalones * tokyo2 * webbrowser * Add "moby" and "backticks" * Add "ws", "Hilights", and "subfile(s)"
linode · Feb 7, 2018 · 7c86132 · 7c86132
1 parent 3879692
commit 7c86132
Show file tree

Hide file tree

Showing 5 changed files with 1,537 additions and 1 deletion.
diff --git a/.travis.yml b/.travis.yml
@@ -18,7 +18,8 @@ before_install:
 #    - npm install
 
 install:
-    - echo "Install pytest and pip"
+    - echo "Install Vale, pytest, and pip"
+    - go get github.com/ValeLint/vale
     - pip install -r ci/requirements.txt
 
 before_script:
@@ -28,5 +29,6 @@ before_script:
 
 script:
     - echo "Checking for style guidelines"
+    - vale --glob='*.{md}' docs
     - python -m pytest -n 2
 
diff --git a/.vale.ini b/.vale.ini
@@ -0,0 +1,32 @@
+StylesPath = ci/vale/styles
+
+# The minimum alert level to display (suggestion, warning, or error).
+#
+# CI builds will only fail on error-level alerts.
+MinAlertLevel = warning
+
+# HTML tags to be ignored by Vale. `code` and `tt` are the default, but Linode
+# seems to use `strong` in a similar ways -- e.g., `**docker build -t ubuntu**`,
+# which could trigger two style issues ("docker" and "ubuntu") but is actually
+# a command.
+IgnoredScopes = code, strong, tt
+
+# Specifies what Vale considers to be a boundary between words.
+WordTemplate = \s(?:%s)\s
+
+[*.md]
+# A Linode-specific style (see ci/vale/styles/Linode) that implements spelling
+# and capitalization rules.
+#
+# To add another style, just add it to the `StylesPath` and update the setting
+# below (e.g., `BasedOnStyles = Linode, AnotherStyle`).
+BasedOnStyles = Linode
+
+# Exclude `{{< file >}}`, `{{< file-excerpt >}}`, `{{< output >}}`,
+# and `{{< highlight ... >}}`.
+#
+# For a description (and unit tests) for these patterns see:
+# https://regex101.com/r/m9klBv/3/tests
+IgnorePatterns = (?s) *({{< output >}}.*?{{< ?/ ?output >}}), \
+(?s) *({{< ?file(?:-excerpt)? [^>]* ?>}}.*?{{< ?/ ?file(?:-excerpt)? ?>}}), \
+(?s) *({{< highlight \w+ >}}.*?{{< ?/ ?highlight >}})