Document/add programmatic use?

[bcomnes]

I'm trying to write some tests for standard-format and want to run standard against some strings inside the test. So far the CLI seems to be the only thing documented. It would be nice to have some documentation on how/what I can do once I require('standard'). I'll try to contribute some after I get my head wrapped around what is available and opening this issue in the meantime.

[bcomnes]

For example, it would be great to have some kind of interface that lets me pass in a file or string to standard, and get back an array of error objects or something. Right now there is a runner that uses spawn: https://github.com/maxogden/standard-format/blob/master/test/standard-runner.js

[feross]

There is some documentation here: https://github.com/feross/standard/blob/master/index.js#L37-L47

Right now require('standard') doesn't let you test strings. Only stdin, or a list of file paths. I'd accept a PR that makes it support testing strings, though you'd need to get this working with eslint and jscs.

Also, index.js currently prints to stdout instead of returning an array of errors. We should change this to do the printing in cmd.js.

PRs welcome!

[bcomnes]

I'll see what I can do sometime soon.

[feross]

If you get this done in the next day or two, we can include this in the v3.0.0 release.

[bcomnes]

I'm going to try and look at it in the morning tomorrow. Don't wait around for me though ;)

Bret Comnes
http://bret.io
Sent from my mobile

On Mar 11, 2015, at 8:41 PM, Feross Aboukhadijeh notifications@github.com wrote:

If you get this done in the next day or two, we can include this in the v3.0.0 release.

—
Reply to this email directly or view it on GitHub.

[bcomnes]

I have checking of strings working in jscs here: https://github.com/bcomnes/standard/blob/dev/lib/checkString.js Ill try for eslint tomorrow.

[bcomnes]

Arg... getting distracted over here. I think im going to finish up https://github.com/bcomnes/sublime-standard-format before I can get to this issue so please dont wait for me.

[feross]

This is done! But it's currently on the speed branch. We'll merge into master soon, but feel free to give it a try now and confirm that it works for your purposes 👍

standard now exports two functions: lintText and lintFiles. They are documented inline in the source.

[bcomnes]

Thanks maaan! Sorry I couldn't pull through on this. Will help with writing standard-format tests.

[feross]

No problem 👍

[feross]

Let's leave this open until speed is merged into master.

[bcomnes]

Oh derp. Good point

[feross]

This is released as 3.3.0.

[bcomnes]

Boo ya!