text-lint (#134)

* started text lint

* footnote order

* textlint

* some more checks

* Update README.md

* Update wordlist.txt

.github/workflows/main.yml

@@ -29,3 +29,18 @@ jobs:
         run: npm install
       - name: Test
         run: npm run lint
+
+  textlint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@master
+        with:
+          node-version: 13
+      - name: Install
+        run: npm install
+      - name: Test
+        run: npm run textlint

.textlintrc

@@ -0,0 +1,7 @@
+{
+  "filters": {},
+  "rules": {
+    "no-empty-section": true,
+    "footnote-order": true
+  }
+}

README.md

@@ -54,3 +54,12 @@ npm install
 npm run lint
 ```
 
+### Textlint
+
+We use [textlint](https://textlint.github.io/) for extra markdown verification. You can easily run this tool simply by using our `npm` package:
+
+```console
+npm install
+npm run textlint
+```
+

package.json

@@ -4,9 +4,13 @@
     "remark-cli": "^6.0.1",
     "remark-lint": "^6.0.2",
     "remark-preset-lint-recommended": "^3.0.2",
-    "remark-validate-links": "^10.0.0"
+    "remark-validate-links": "^10.0.0",
+    "textlint": "^11.6.3",
+    "textlint-rule-footnote-order": "^1.0.3",
+    "textlint-rule-no-empty-section": "^1.1.0"
   },
   "scripts": {
+    "textlint": "textlint specs/",
     "lint": "remark ."
   },
   "remarkConfig": {

specs/mvds-metadata.md

@@ -23,7 +23,7 @@ redirect_from:
 
 ## Abstract
 
-In this specification, we describe a method to construct message history that will aid the consistency guarantees of [MVDS](mvds.md). Additionally we explain how data sync can be used for more lightweight messages that do not require full synchronization.
+In this specification, we describe a method to construct message history that will aid the consistency guarantees of [MVDS](mvds.md). Additionally, we explain how data sync can be used for more lightweight messages that do not require full synchronization.
 
 ## Motivation
 

wordlist.txt

@@ -111,6 +111,7 @@ subprotocol
 subprotocols
 TBD
 TCP
+textlint
 Thorén
 tla
 tls