add markdown linting using remark (transloadit#2181)

* build: add markdown linting

* build: support markdown front matter

* build: fail remark lint on warnings

* Fix markdown lint warnings

* changelog: fix markdown errors, allow literal URLs

* ci: add markdown lint step

* website: regenerate contributing.md

* build: properly ignore vendor and built files from remark-lint

* build: add private packages to lerna config

.github/CONTRIBUTING.md

@@ -145,7 +145,7 @@ To quickly summarize:
 
 #### Utilities
 
-Syntax: u-[sm-|md-|lg-]<utilityName>
+Syntax: `u-[sm-|md-|lg-]<utilityName>`
 
 ```css
 .u-utilityName
@@ -155,7 +155,7 @@ Syntax: u-[sm-|md-|lg-]<utilityName>
 
 #### Components
 
-Syntax: [<namespace>-]<ComponentName>[-descendentName][--modifierName]
+Syntax: `[<namespace>-]<ComponentName>[-descendentName][--modifierName]`
 
 ```css
 .twt-Button /* Namespaced component */

.gitignore

@@ -13,6 +13,7 @@ dist/
 lib/
 coverage/
 examples/dev/bundle.js
+examples/aws-presigned-url/vendor/*
 test/endtoend/create-react-app/build/
 test/endtoend/create-react-app/coverage/
 uppy-*.tgz

.travis.yml

@@ -37,10 +37,17 @@ jobs:
     - name: 'Run unit tests on Node.js 10'
       node_js: 10
       script: npm run test:unit
-    - name: 'Run Linting and type tests'
+    - name: 'Run Linting'
       node_js: 10
       script:
         - npm run lint
+    - name: 'Run Markdown Linting'
+      node_js: 10
+      script:
+        - npm run lint:markdown
+    - name: 'Run type tests'
+      node_js: 10
+      script:
         # Need to do a bunch of work to generate the locale typings 🙃
         - npm run build:lib
         - npm run build:companion

CHANGELOG.md

@@ -1,3 +1,7 @@
+# Changelog
+
+<!--lint disable no-literal-urls-->
+
 Our combined changelog and roadmap. It contains todos as well as dones.
 
 Items can be optionally be tagged tagged by GitHub owner issue if discussion
@@ -319,7 +323,7 @@ This release adds `@uppy/onedrive` to `uppy`’s `package.json`, fixing the bug
 - build: Actually check types. Use tsd so our typings test files can actually assert that types are correct (#1918 / @goto-bus-stop )
 - @uppy/companion: Only set cookies for providers that need it (#2055 / @ifedapoolarewaju)
 - docs: Add Content-Type header to presigned url example (#2061 / @scherroman)
-- uppy: Add onedrive to uppy package.json ([349247607513bc6b33bf2a90ab0b82f8f2e81d78](https://github.com/transloadit/uppy/commit/349247607513bc6b33bf2a90ab0b82f8f2e81d78 / @arturi))
+- uppy: Add onedrive to uppy package.json ([349247607513bc6b33bf2a90ab0b82f8f2e81d78](https://github.com/transloadit/uppy/commit/349247607513bc6b33bf2a90ab0b82f8f2e81d78) / @arturi)
 
 ## 1.9.1
 
@@ -1269,7 +1273,7 @@ New versions in this release:
 
 Changes:
 
-- build: Add initial version table script [skip ci] (@goto-bus-stop)
+- build: Add initial version table script (@goto-bus-stop)
 - build: Add more checks to release script (#1050 / @goto-bus-stop)
 - build: start companion once in tests (#1052 / @ifedapoolarewaju)
 - buid: set companion config values when running test (@ifedapoolarewaju)
@@ -1524,7 +1528,7 @@ Changed strings:
 
 Released: 2018-05-14.
 
-- core: Pass `allowedFileTypes` and `maxNumberOfFiles` to input[type=file] in UI components: Dashboard, DragDrop, FileInput (#814 / @arturi)
+- core: Pass `allowedFileTypes` and `maxNumberOfFiles` to `input[type=file]` in UI components: Dashboard, DragDrop, FileInput (#814 / @arturi)
 - transloadit: Update Transloadit plugin's Uppy Server handling (#804 / @goto-bus-stop)
 - tus: respect `limit` option for upload parameter requests (#817 / @ap--)
 - docs: Explain name `metadata` vs. `$_FILES[]["name"]` (#1c1bf2e / @goto-bus-stop)
@@ -1987,7 +1991,7 @@ Favorite Uppy Server version: 0.5.0.
 - website: try on a Github ribbon http://tholman.com/github-corners/ (@arturi / #150)
 - website: different meta description for pages and post (@arturi)
 - server: well documented README (@ifedapoolarewaju)
-- react: [WIP] High-level React Components (@goto-bus-stop / #170)
+- react: High-level React Components (@goto-bus-stop / #170)
 - core: add `uppy.close()` for tearing down an Uppy instance (@goto-bus-stop / #182)
 - core: replace `babel-preset-es2015-loose` by standard es2015 preset with `loose` option (@goto-bus-stop / #174)
 

lerna.json

@@ -4,6 +4,7 @@
     "website",
     "examples/*",
     "packages/*",
-    "packages/@uppy/*"
+    "packages/@uppy/*",
+    "private/*"
   ]
 }