Merge pull request #22 from testthedocs/refactor

Add actions and merge various small changes

.travis.yml

@@ -4,8 +4,8 @@ python:
   - "3.6"
 install:
   # Install the latest release of Vale:
-  - wget https://github.com/errata-ai/vale/releases/download/v2.0.0-beta.2/vale_2.0.0-beta.2_Linux_64-bit.tar.gz
-  - mkdir bin && tar -xvzf vale_2.0.0-beta.2_Linux_64-bit.tar.gz -C bin
+  - wget https://github.com/errata-ai/vale/releases/download/v3.4.2/vale_3.4.2_Linux_64-bit.tar.gz
+  - mkdir bin && tar -xvzf vale_3.4.2_Linux_64-bit.tar.gz -C bin
   - export PATH=./bin:"$PATH"
 
   - bundle install --jobs=3

Openly/A11Y.yml

@@ -3,5 +3,7 @@ extends: substitution
 message: Consider using '%s' instead of '%s'
 ignorecase: true
 level: error
+action:
+  name: replace
 swap:
   (?:click|press): "'select'"

Openly/But.yml

@@ -3,5 +3,10 @@ extends: existence
 message: "Do not start a paragraph with a 'but'."
 level: error
 scope: paragraph
+action:
+  name: remove
+  params:
+    - remove
+    - '.?!'
 tokens:
   - ^But

Openly/GenderBias.yml

@@ -3,6 +3,8 @@ extends: substitution
 message: Consider using '%s' instead of '%s'
 ignorecase: true
 level: error
+action:
+  name: replace
 swap:
   (?:alumna|alumnus):          graduate
   (?:alumnae|alumni):          graduates

Openly/Hyphens.yml

@@ -2,6 +2,8 @@
 extends: substitution
 message: Use '%s' instead of '%s'
 level: warning
+action:
+  name: replace
 swap:
   African-American: African American
   Asian-American: Asian American

Openly/Punctuation.yml

@@ -5,6 +5,8 @@ level: error
 scope: text
 ignorecase: false
 nonword: true
+action:
+  name: replace
 swap:
   e\.g\.: eg
   i\.e\.: ie

Openly/Readability.yml

@@ -1,11 +1,8 @@
----
-extends: readability
-message: "Grade level (%s) too high!"
-level: warning
-grade: 10
-metrics:
-  - Flesch-Kincaid
-  - Gunning Fog
-  - Coleman-Liau
-  - SMOG
-  - Automated Readability
+extends: metric
+message: "Try to keep the Flesch reading ease score (%s) above 70."
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+
+formula: |
+  206.835 - (1.015 * (words / sentences)) - (84.6 * (syllables / words))
+
+condition: "< 70"

Openly/So.yml

@@ -3,5 +3,10 @@ extends: existence
 message: "Don't start a sentence with '%s'"
 ignorecase: true
 level: error
+action:
+  name: edit
+  params:
+    - remove
+    - '.?!'
 raw:
-  - '(?<=[.;?!]\s)(?:[.-]?\s*)so\b'
+  - '(?<=[.;?!]\s)(?:[.-]?\s*)so\b'

Openly/Spelling.yml

@@ -3,18 +3,24 @@ extends: spelling
 message: "Did you really mean '%s'?"
 level: error
 code: false
+action:
+  name: suggest
+  params:
+    - spellings
 ignore:
-  - Openly/tech-terms/security.txt
-  - Openly/tech-terms/blockchain.txt
-  - Openly/tech-terms/devops.txt
-  - Openly/tech-terms/general.txt
-  - Openly/tech-terms/techwriting.txt
-  - Openly/tech-terms/mobile.txt
-  - Openly/tech-terms/java.txt
-  - Openly/tech-terms/linux.txt
-  - Openly/tech-terms/tech-slang.txt
-  - Openly/tech-terms/csharp.txt
-  - Openly/tech-terms/ddd.txt
-  - Openly/tech-terms/business.txt
-  - Openly/tech-terms/monitoring.txt
-  - Openly/tech-terms/apis.txt
+  - openly/tech-terms/security.txt
+  - openly/tech-terms/blockchain.txt
+  - openly/tech-terms/devops.txt
+  - openly/tech-terms/general.txt
+  - openly/tech-terms/techwriting.txt
+  - openly/tech-terms/mobile.txt
+  - openly/tech-terms/java.txt
+  - openly/tech-terms/linux.txt
+  - openly/tech-terms/tech-slang.txt
+  - openly/tech-terms/csharp.txt
+  - openly/tech-terms/ddd.txt
+  - openly/tech-terms/business.txt
+  - openly/tech-terms/monitoring.txt
+  - openly/tech-terms/apis.txt
+  - openly/tech-terms/geospatial.txt
+  - openly/tech-terms/javascript.txt

Openly/tech-terms/javascript.txt

@@ -0,0 +1 @@
+axios

Openly/tech-terms/security.txt

@@ -1,3 +1,4 @@
 unencrypted
 tls
-keystore
+keystore
+reauthenticate

fixtures/basic/fail.md

@@ -1,6 +1,6 @@
 # HEADINGS!
 
-So, click the button to see what the computer thinks they will say. There is also right click of course. This is true.
+So, click the button to see what the computer thinks they will say. There is also right click of course. This is true. Also check this. Andthere is this
 
 But I'm telling you the truth is that it has the manpower and knows and arguably tries to assist you.