Require that JS snippets use standard-js about standard-readme HOT 7 CLOSED

The readme should contain example's linted in the same way as the code is linted in the rest of the project. I think that is a reasonable assumption.

from standard-readme.

What if the user could provide the name of a linter program? Opt-in might be nice: perhaps look for a property named "lint" under "scripts" and run that?

from standard-readme.

Vote for suggestion. It not make sense to be requirement.

What if the user could provide the name of a linter program?

It is not standard-readme job, and it should not care.

from standard-readme.

We don't have any optional provisions for users, at the moment; there's no config for standard-readme, basically. So I'm not sure your suggestion works well, @noffle.

Suggestion makes the most sense, for me. But it is partially standard-readme's job; the code snippets are part of the README. What I don't want is to enforce standard in the code-base, though.

from standard-readme.

One trick might be to opt-in by embedding an HTML comment hint into your markdown. Something like:

<!--
lint: standard
-->
```js
var foo = require('foo')

console.log(foo(14))
```

This will prevent the hints from showing up in the rendered markdown, but make it easy to perform a pre-processing step in standard-readme that runs the program standard with the following code snippet on stdin. (This'd make a nice little stand-alone UNIXy module!)

from standard-readme.

Still don't make sense. It's not readme job. Exactly because there's already a tool for such thing, it's not make sense to couple tools - SoC for the win. :) JUst suggestion is enough and users simple will run it.

from standard-readme.

I am going to keep this language agnostic. I used @martinheidegger's suggestion, added it as a requirement.

from standard-readme.