Add standard-markdown to lint js code in markdown files

[manidlou]

Added standard-markdown to lint js code blocks inside our markdown files. Since standard-markdown uses standard, we have a consistent linter for both js and markdown files.

standard-markdown by default comes with a few eslint rules disabled. Just added one more rule handle-callback-err to the list of disabledRules in standard-markdown source code. I guess for us, it makes sense to disable that rule on markdown files.

[coveralls]

Coverage remained the same at 86.925% when pulling 01d10b3 on markdown-linter into 096a8e1 on master.

[manidlou]

Aah what a dumb I am! 😆 I have to work on it a little more. Need to find a way to programmatically add disabledRules to standard-markdown. Maybe I should fork it and apply changes based on our needs!

[coveralls]

Coverage remained the same at 86.925% when pulling 6c27b6f on markdown-linter into 096a8e1 on master.

[manidlou]

So Added tools directory to contain standard-markdown fork. Updated .gitignore and .npmignore accordingly. Please let me know if I am doing anything incorrectly here!

[coveralls]

Coverage remained the same at 86.925% when pulling 04b8933 on markdown-linter into 096a8e1 on master.

[manidlou]

Alright now it's fixed! 😁

[RyanZim]

Hey @manidlou; thanks for putting in the effort here.

I don't like the idea of maintaining a fork here though. I think perhaps we should propose that standard-markdown disables this rule globally, since it does make sense in some cases.

How many cases does this rule fail? If it's not too much work, I wouldn't mind changing a few examples to work around this.

[manidlou]

Thanks @RyanZim. I like your approach toward this since I essentially propose this as an idea

I don't like the idea of maintaining a fork here though. 👍

Yeah, I am with you on that

I think perhaps we should propose that standard-markdown disables this rule globally, since it does make sense in some cases.

That or propose the idea of make disabledRules configurable by the user; something like a property in package.json similar to standard.

How many cases does this rule fail? If it's not too much work, I wouldn't mind changing a few examples to work around this.

Currently, when I run it without disabling handle-callback-err, 16 of them get this error. Here is the output copied from my terminal:

Linting file 30 of 30


   docs/copy.md
         37:8:     Expected error to be handled.

   docs/emptyDir.md
         27:8:     Expected error to be handled.

   docs/ensureDir.md
         26:8:     Expected error to be handled.

   docs/ensureFile.md
         26:8:     Expected error to be handled.

   docs/ensureLink.md
         26:8:     Expected error to be handled.

   docs/ensureSymlink.md
         27:8:     Expected error to be handled.

   docs/move.md
         26:8:     Expected error to be handled.

   docs/outputFile.md
         19:29:    Expected error to be handled.
         30:8:     Expected error to be handled.

   docs/outputJson.md
         22:21:    Expected error to be handled.
         33:8:     Expected error to be handled.

   docs/readJson.md
         28:8:     Expected error to be handled.
         55:8:     Expected error to be handled.

   docs/remove.md
         31:8:     Expected error to be handled.

   docs/writeJson.md
         29:8:     Expected error to be handled.

   README.md
         75:10:    Expected error to be handled.

[manidlou]

For now, I will fix those cases.

[coveralls]

Coverage remained the same at 86.925% when pulling 0c22802 on markdown-linter into 096a8e1 on master.

[RyanZim]

LGTM; Thanks!

[RyanZim]

@manidlou Can you rebase this into one commit? We don't want the fork in the git history.

[RyanZim]

One thing I just noticed; your Travis config is running more containers than needed. Why don't you just add standard-markdown to the lint script & revert your .travis.yml changes?

[manidlou]

@manidlou Can you rebase this into one commit? We don't want the fork in the git history. 👍

One thing I just noticed; your Travis config is running more containers than needed. Why don't you just add standard-markdown to the lint script & revert your .travis.yml changes? 👍

Sure thing. Just don't have access to computer now. I'll do them when I go home tonight.

[coveralls]

Coverage remained the same at 86.925% when pulling c2ab3c5 on markdown-linter into 096a8e1 on master.

[manidlou]

Rebase is done. Please let me know if I missed anything 😜

[jprichardson]

Looks good @manidlou, thanks!