Advanced linting with spellcheck corrections (ember-learn#327)

* added remark/retext linting

* additional corrections

* added comments for reviewers

* fixed Github -> GitHub

* backticks, consistency to 2.16

* add testing to travis.yml

* updated readme & contributing

* update test

* bumped dictionary

* fixed errors from conflict cleanup

Author: maxwondercorn

.local.dic

@@ -0,0 +1,119 @@
+30KB
+accessor
+activations
+acyclic
+ActiveSupport
+asynchronicity
+Americentric
+assistive
+asynchrony
+autocomplete
+auto-rollup
+autoruns
+backend
+backends
+beforeEach
+blogPost
+bookmarklet
+breakpoint
+Browserlist
+camelize
+chainable
+Checkboxes
+checkboxes
+CoffeeScript
+componentized
+Ctrl-C
+customizations
+D3
+dasherize
+datepicker
+de
+debounce
+deps
+deserialization
+deserializing
+draggable
+durations
+enumerables
+ember-cli-deprecation-workflow
+ember-cli-cjs-transform
+ember-cli-mirage.
+ember-cli-tutorial-style
+ember-debug-handlers-polyfill
+ember-qunit
+erroring
+Evented
+facto
+falsy
+frontend
+fullname
+geocode
+geocoding
+Geolocation
+globbing
+*google
+hardcode
+hashchange
+Hoc
+htmlbars
+htmlbars-inline-precompile
+interop
+interoperable
+IndexedDB
+Inflector
+instantiation
+jquery-integration
+keyCode
+linters
+lookups
+Mapbox
+mixin
+mixins
+modularity
+naïve
+nav
+*NPM
+Param
+param
+params
+PascalCased
+pipelining
+Polymorphism
+polymorphism
+PR
+PRs
+preload
+prepend
+pre-transition
+readme
+readonly
+relayout
+repo
+rerender
+rerendering
+routable
+runtime
+sandboxed
+scp
+selectable
+serializer
+serializers
+singularize
+SSR
+stateful
+subclassing
+subdomain
+subexpression
+suboptimal
+substate
+substates
+teardown
+templating
+todo
+todos
+typeahead
+unsilence
+untrusted
+usecase
+viewport

.remarkignore

@@ -0,0 +1,30 @@
+CONTRIBUTING.*
+README.*
+MAINTAINERS.md
+guides/v1.10.0/**/*.md
+guides/v1.11.0/**/*.md
+guides/v1.12.0/**/*.md
+guides/v1.13.0/**/*.md
+guides/v2.0.0/**/*.md
+guides/v2.1.0/**/*.md
+guides/v2.2.0/**/*.md
+guides/v2.3.0/**/*.md
+guides/v2.4.0/**/*.md
+guides/v2.5.0/**/*.md
+guides/v2.6.0/**/*.md
+guides/v2.7.0/**/*.md
+guides/v2.8.0/**/*.md
+guides/v2.9.0/**/*.md
+guides/v2.10.0/**/*.md
+guides/v2.11.0/**/*.md
+guides/v2.12.0/**/*.md
+guides/v2.13.0/**/*.md
+guides/v2.14.0/**/*.md
+guides/v2.15.0/**/*.md
+guides/v2.16.0/**/*.md
+guides/v2.17.0/**/*.md
+guides/v2.18.0/**/*.md
+guides/v3.0.0/**/*.md
+guides/v3.1.0/**/*.md
+guides/v3.2.0/**/*.md
+guides/v3.3.0/**/*.md

.remarkrc.js

@@ -0,0 +1,30 @@
+// .remarkrc.js
+/* eslint-env node */
+const unified = require("unified");
+const read = require("fs").readFileSync;
+const ember = require("ember-dictionary");
+
+exports.plugins = [
+  [
+    require("remark-retext"),
+    unified().use({
+      plugins: [
+        [require("retext-contractions"), { straight: true }],
+        require("retext-english"),
+        require("retext-indefinite-article"),
+        require("retext-repeated-words"),
+        require("retext-syntax-urls"),
+        [
+          require("retext-spell"),
+          {
+            dictionary: ember,
+            personal: read("./.local.dic")
+          }
+        ]
+      ]
+    })
+  ],
+  "remark-preset-lint-consistent",
+  "remark-preset-lint-recommended",
+  ["remark-lint-list-item-indent", "space"]
+];

.travis.yml

@@ -2,12 +2,32 @@ language: node_js
 node_js:
 - '8'
 
+sudo: false
+dist: trusty
+
+addons:
+  chrome: stable
+
+cache:
+  directories:
+    - $HOME/.npm
+
 env:
   global:
     - secure: "uh/i3/82ECzpG2ozoEpRsvdMO9o2WG8KSR4csIIDNB9kIxsvacB1xfrOStj6HM1XCTwZgcGa6zLG0rjvdZqNTFZOGT75u7mVJ7hJsReGi6rCncSNmxdWC6KUZw5LxO4Sm+G10F+ysUcdBhiW8UdeLrNTNw75DOCC3U28HWtO84/DsIzZNRgZjzLzOMGEr3E28VJvEZx6znRJyDujb57y3QCER5AE83dQ+t+Wmn0L+vG78q5waO6qSFK2Aib3bpNw57duRwALwaErRAWfi3pBzFf/WjnRGoAXnXBjKI7GRoNOxSTq0MgzE0SZHfF4jb3uplxtAL9T0I1QSp4wkjBU21OzKcYI8sznQq9sUwPyyB98ASvLYpfZEkxBsC1IAvhHBFXIqP8CcLef8nfNdEuHW11KpDdjc0X+zSzH5bj2Ske0Ip2OHmARsLQawQELneNNelYoUmMMuJTy7HtPcX925S0Z2YWjIWja1xQjfWR8Be1ReUYVEYoYyCkttMe6Qa9hobdf+Yy3dwAwIpZUZX+ZPw68TzkQdjNWSC9Nn8Su1yGnyzgOwd4kBNmiluvjcYhKU82x0I025e3zEsHR3jVbuu/KrnVOtSfqFimPbtL1oUeR5e1Yg6fFF8sbnSXeR3lCXpQFXrv9OowvbWqD4lhCUwE3Jovx5QOVZwubL1EScyo="
 
+before_install:
+  - npm config set spin false
+  - npm i -g npm@6
+
+script:
+  - set -o errexit
+  - npm run lint:md
+  - npm run test
+  
 # deploy:
   # provider: script
   # script: notify-guides-app.sh
   # on:
   #   branch: master
+

CONTRIBUTING.md

@@ -124,6 +124,31 @@ When linking to API pages:
 (api link)
 * include parenthesis when linking to an API method, i.e., <code>&#96;store.push()&#96;</code>
 
+## Spellchecking/linting
+
+The guides are spellchecked and linted for markdown consistency. You can test your contributions by running `npm run lint::md`. Linting and spellchecking must pass or they will fail in Travis-CI. 
+
+Markdown issues that will generate errors include:
+- Lists and text must be left justified, otherwise the linter will generate indentation errors
+- URL references must be followed by empty brackets `[]`.  See example below
+- Unused URL reference definitions - comment them out if using them later
+- Missing URL reference definitions
+
+Most other markdown errors should be self explanatory.
+
+URL reference and definition:
+```markdown
+This is a link to [something][]
+
+[something]: https:\\www.something.com
+```
+
+Spellchecking uses a custom [ember-dictionary][] with words and terms common to the Ember community, such as `SemVer`. Words and terms that are associated with a specific guide can be placed in the `.local.dic` dictionary file. 
+
+See the [ember-dictionary][] GitHub repo for specifics on using the local dictionary and adding words to the standard dictionary.
+
+## Writing
+
 Write once, edit twice (at least!) before opening a PR. When you edit your own writing, ask yourself:
 
 * Am I using proper grammar and spelling?
@@ -132,3 +157,5 @@ Write once, edit twice (at least!) before opening a PR. When you edit your own w
 * Did I include links where appropriate?
 
 You'll be amazed at how much better your writing gets as you edit and re-edit!
+
+[ember-dictionary]: https://github.com/maxwondercorn/ember-dictionary

README.md

@@ -27,6 +27,10 @@ want a buddy to pair with, you can join the
 [dev-ember-learning channel](https://discordapp.com/channels/480462759797063690/480777444203429888)
 in the [Ember Community Discord](https://discordapp.com/invite/zT3asNS).
 
+## Linting/spellchecking
+
+The guides are spellchecked and linted for markdown consistency. You can test your contributions by running `npm run lint::md`. Linting and spellchecking must pass or they will fail in Travis-CI.  See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on linting and spellchecking.
+
 ## Project layout
 
 The Guides content takes the form of Markdown files (just like most READMEs).

guides/v1.10.0/cookbook/client_server_interaction/serving_compiled_templates_using_nodejs.md

@@ -105,7 +105,7 @@ without hardcoding your paths throughout your config file.
 
 
 The second two objects are configuration objects for the ```emberTemplates``` and ```watch``` tasks.
-details on the options and configuration of these tasks is found in their respective github
+details on the options and configuration of these tasks is found in their respective GitHub
 repositories.  Grunt tasks typically have easily read README.md files that explain the options 
 and configurations for that package.
 
@@ -138,4 +138,4 @@ tutorial is based on is found at http://www.github.com/stevekane/precompiled-tem
 As a bonus, if you are interested in using ```Emblem.js``` which has a HAML-like syntax to 
 build your templates, there is a grunt task for precompiling emblem.js templates called 
 ```grunt-emblem```.  The steps needed to configure this task are similar to the ones shown
-but be sure to refer to the projects github repository for details.
+but be sure to refer to the projects GitHub repository for details.

guides/v1.10.0/cookbook/contributing/participating_if_you_dont_know_ember.md

@@ -10,4 +10,4 @@ recipe suggestions. You can suggest a recipe by forking this repository and subm
 (see _Suggesting a Recipe_). Once we have written recipes, we'll be asking for help to proofread and test
 them.
 
-See ["Watch a project"](https://help.github.com/articles/be-social#watch-a-project) on Github for information on watching projects.
+See ["Watch a project"](https://help.github.com/articles/be-social#watch-a-project) on GitHub for information on watching projects.

guides/v1.10.0/cookbook/contributing/suggesting_a_recipe.md

@@ -18,7 +18,7 @@ it blank. These sections will be created in a later phase of the Cookbook projec
 The filename of your suggested recipe should be the lowercase, underscored version of your recipe's name. The
 filename name for this recipe &nash; "Suggesting a Recipe" – would be `suggesting_a_recipe.mdown`.
 
-When you are ready to submit your recipe, push your local branch to the remote branch on your Github fork and
+When you are ready to submit your recipe, push your local branch to the remote branch on your GitHub fork and
 submit a pull request. Before submitting a pull request, make sure someone hasn't already submitted a similar
 recipe and that your recipe is a good fit for the Cookbook (see _Deciding If A Recipe Is A Good Fit_).
 

guides/v1.10.0/cookbook/helpers_and_components/adding_google_analytics_tracking.md

@@ -6,7 +6,7 @@ You want to add analytics to your Ember application.
 Subscribe to the `didTransition` event inside your application router.
 
 In the following examples we're using Google Analytics but it could be any other analytics product.
-Add google analytic's base code to the html file that renders your ember app.
+Add Google analytic's base code to the html file that renders your ember app.
 
 ```html
 <html lang="en">

guides/v1.10.0/getting-started/adding-a-route-and-template.md

@@ -37,7 +37,7 @@ Next, update your `index.html` to wrap the inner contents of `<body>` in a Handl
 
   </script>
 
-  <!-- ... Ember.js and other javascript dependencies ... -->
+  <!-- ... Ember.js and other JavaScript dependencies ... -->
   <script src="js/application.js"></script>
   <script src="js/router.js"></script>
 </body>

guides/v1.10.0/testing/test-runners.md

@@ -64,7 +64,7 @@ npm install -g --save-dev testem
 That's it. Everything you need is installed and configured. Let's go over the configuration in more detail.
 
 * `framework`
- - This represents the testing framework that you are going to be using. Qunit is what we are using in this example. `Testem` takes care of getting the qunit library loaded up so you don't have to worry about it.
+ - This represents the testing framework that you are going to be using. QUnit is what we are using in this example. `Testem` takes care of getting the QUnit library loaded up so you don't have to worry about it.
 * `src_files`
  - This represents which of your source files (including both production and test code) that you want `testem` to load when running tests.
 * `launch_in_dev`
@@ -111,7 +111,7 @@ To get started using `karma` you will need to install a few node modules. Here i
 }
 ```
 
-The three dependencies are `karma` itself, `karma-qunit` which includes everything that you will need to run qunit tests and `karma-phantomjs-launcher` which is what `karma` will use to fire up an instance of the headless PhantomJS browser to run your tests in. There are a number of different launchers that you can plug into the `karma` test runner including but not limited to Google Chrome, FireFox, Safari, IE, and even [Sauce Labs][sauce_labs]. To see a complete list of all of the available launchers check out [Karma's Github][karma_github].
+The three dependencies are `karma` itself, `karma-qunit` which includes everything that you will need to run qunit tests and `karma-phantomjs-launcher` which is what `karma` will use to fire up an instance of the headless PhantomJS browser to run your tests in. There are a number of different launchers that you can plug into the `karma` test runner including but not limited to Google Chrome, FireFox, Safari, IE, and even [Sauce Labs][sauce_labs]. To see a complete list of all of the available launchers check out [Karma's GitHub][karma_github].
 
 Now that you've got a `package.json` containing everything that you will need to get started with `karma` run the following command (in the same directory as your `package.json` file) to download and install everything.
 

guides/v1.10.0/understanding-ember/dependency-injection-and-service-lookup.md

@@ -139,7 +139,7 @@ When an Ember application starts running, it will create and use a single instan
 
 Factory names have two parts segmented by a `:`. The first segment is the framework component type, and the second is the name of the component requested. Hence, an application view would be named `view:application`.
 
-If the container does not already have a requested factory, it uses a resolver to discover that factory. The resolver is responsible for mapping the factory name of `view:application` to the global variable of `App.ApplicationView`. Tools like ember-cli may use alternative rules for resolving factories. After optionally adding dependencies to the requested factory, that factory is cached and returned.
+If the container does not already have a requested factory, it uses a resolver to discover that factory. The resolver is responsible for mapping the factory name of `view:application` to the global variable of `App.ApplicationView`. Tools like Ember CLI may use alternative rules for resolving factories. After optionally adding dependencies to the requested factory, that factory is cached and returned.
 
 Ember's container should be viewed as an implementation detail, and is not part of the supported public API.
 
@@ -161,7 +161,7 @@ App.register('logger:main', {
 App.inject('route', 'logger', 'logger:main');
 ```
 
-But ember-cli applications (and libraries) will need to use a more flexible hook, an initializer:
+But Ember CLI applications (and libraries) will need to use a more flexible hook, an initializer:
 
 ```javascript
 Ember.Application.initializer({
@@ -254,7 +254,7 @@ application.inject('route:index', 'logger', 'logger:main');
 
 Injections can be made onto all of Ember's major framework classes, including views, helpers, components, controllers, routes, and the router.
 
-**Note:** For injections into models (if not using ember-cli), you need to enable the `MODEL_FACTORY_INJECTIONS` 
+**Note:** For injections into models (if not using Ember CLI), you need to enable the `MODEL_FACTORY_INJECTIONS` 
 flag before you initialize your application. You can do this like so:
 
 ```javascript

guides/v1.11.0/cookbook/contributing/participating_if_you_dont_know_ember.md

@@ -10,4 +10,4 @@ recipe suggestions. You can suggest a recipe by forking this repository and subm
 (see _Suggesting a Recipe_). Once we have written recipes, we'll be asking for help to proofread and test
 them.
 
-See ["Watch a project"](https://help.github.com/articles/be-social#watch-a-project) on Github for information on watching projects.
+See ["Watch a project"](https://help.github.com/articles/be-social#watch-a-project) on GitHub for information on watching projects.

guides/v1.11.0/cookbook/contributing/suggesting_a_recipe.md

@@ -18,7 +18,7 @@ it blank. These sections will be created in a later phase of the Cookbook projec
 The filename of your suggested recipe should be the lowercase, underscored version of your recipe's name. The
 filename name for this recipe &nash; "Suggesting a Recipe" – would be `suggesting_a_recipe.mdown`.
 
-When you are ready to submit your recipe, push your local branch to the remote branch on your Github fork and
+When you are ready to submit your recipe, push your local branch to the remote branch on your GitHub fork and
 submit a pull request. Before submitting a pull request, make sure someone hasn't already submitted a similar
 recipe and that your recipe is a good fit for the Cookbook (see _Deciding If A Recipe Is A Good Fit_).
 

guides/v1.11.0/cookbook/helpers_and_components/adding_google_analytics_tracking.md

@@ -6,7 +6,7 @@ You want to add analytics to your Ember application.
 Subscribe to the `didTransition` event inside your application router.
 
 In the following examples we're using Google Analytics but it could be any other analytics product.
-Add google analytic's base code to the html file that renders your ember app.
+Add Google analytic's base code to the html file that renders your ember app.
 
 ```html
 <html lang="en">