Add Linting

[jwasilgeo]

esri-leaflet is wired up with semistandard linting (here, here), but I haven't yet identified that this repo enforces linting via an npm script or a Grunt task.

Since we're already using Grunt here, does anyone have a preference on the latest and greatest in that ecosystem? I admittedly haven't been staying up to date with that lately.

[jwasilgeo]

I dug a little deeper into the 🐇 🕳 and found that grunt-contrib-jshint is already in the npm packages devDependencies, but seems to be unused yet by Grunt.

https://github.com/Esri/esri-leaflet-doc/blob/master/package.json#L26

I'll attempt to wire it up into our Grunt tasks. I'll keep on researching what the best solution is these days in the Grunt ecosystem for both code correctness and consistent styling while introducing the least amount of changes (thus prettier might be a bit too much right now).

Implementing this approach:

• grunt
  • grunt-eslint
  • eslint-config-semistandard
  • eslint-plugin-markdown
  • eslint-plugin-html OR eslint-plugin-script-tags

[jwasilgeo]

Work is underway in branch 241-add-linting.

• [x] wired up eslint with grunt docs 'watch'
• [x] verify if eslint needs to be wired up anywhere else in other grunt tasks (build/deploy tasks?)
• [x] find out why the grunt docs:build task calls 'sass' twice; can we insert 'eslint' anywhere here?
• [x] eslint applied to high-level src/helpers and src/js .js files
• [x] eslint applied to src/pages/examples .hbs files
• [x] eslint applied to src/pages/tutorials .md files
• [x] eslint applied to src/pages/api-reference .md files
• [x] decide if we want to ignore some remaining eslint errors in src/pages/tutorials .md files
• [x] decide if we want to ignore some remaining eslint errors in src/pages/api-reference .md files
  • It was decided between @gavinr and @jwasilgeo to routinely lint more commonly edited source files ('src/**/*.js', 'src/**/*.hbs'), while setting aside fully comprehensive linting to include 'src/**/*.md' files by calling a separate grunt task currently wired up as lint:all. These .md files have been linted and fixed manually but the remaining errors can be ignored for the purpose of the tutorials' conversation-style docs.
• [x] misc. maintenance: changed src/ links that used "http://" to "https://" and also updated redirecting or deprecated pages that were being linked to
• [x] misc. maintenance: added the "Quickstart" demo page to the top of the examples ToC

❌ IMPORTANT NOTE: I have not consistently linted code snippets housed in <code> blocks in src/pages/api-reference .md files. If someone wants to figure that out as part of eslint, by all means.

So far eslint and the plugins I have wired up deal with actual .js files, or blocks of js within <script> tags in .hbs files, or blocks of js within markdown code blocks in .md files.

[gavinr]

@jwasilgeo re:

1.

find out why the grunt docs:build task calls 'sass' twice; can we insert 'eslint' anywhere here?

I think this is due to sass being listed twice here. @jgravois do you happen to know/remember if this was done on purpose or perhaps it's simply a mistaken duplication.

---

2.

decide if we want to ignore some remaining eslint errors in src/pages/tutorials .md files decide if we want to ignore some remaining eslint errors in src/pages/api-reference .md files

I think my changes here addressed these, correct?

[jgravois]

never attribute to malice what is adequately explained by john's carelessness or stupidity on john's part. 😇 - Hanlon's Razor (amended)

[jwasilgeo]

1. @jgravois 😆😆; @gavinr shall we strike one of those sass listings and figure out where to add in eslint without its own error reporting forcing an early exit during the given grunt task(s)?

2. Perfect, thanks again for that @gavinr. I'll check off those items in the todo list above.

[jwasilgeo]

The more I look at it the less sure I am about which sass to remove on this line. @jgravois @gavinr I might just leave it alone for right now.

[jgravois]

The more I look at it the less sure I am about which sass to remove.

I wouldn't expect it to matter which one you remove. are you seeing something weird locally?

[jwasilgeo]

Nah, I'm just tracking too many changes and subtopics in my mind and getting a little turned around. I'll strike one and commit the change. Thank you!

[jwasilgeo]

Closed via PR #244.