About what is ESlint.... #936

Closed
richardpq opened this Issue May 26, 2014 · 4 comments

Projects

None yet

3 participants

@richardpq

I've seen some mentions about ESlint in some tweets and blogs, but it was until a few days ago that I decided to find what is it about, so I wen to the official web site, but I couldn't find what is it, what it does... even i the "about" page, there is no an explanation, there is a reference to another similar tools which helps to infer it, but I think it would be better a good explanation about, what it ESlint, for what I can use it and how it could help me in web development (for example).

Thanks

@nzakas
Member
nzakas commented May 26, 2014

It sounds like our about page relies too much on prior knowledge of JSHint and JSLint to describe ESLint. We should make it a bit more standalone. Here is JSHint's about page for reference:
http://jshint.com/about/

@jrajav
Contributor
jrajav commented May 26, 2014

Somewhere in there you could add something along the lines of:

A linter is a static code analysis tool that points out common mistakes and potential bugs in source code, as well as stylistic errors.

You could also include a brief explanation of its workings:

ESLint works by parsing the JavaScript source with Esprima, creating an Abstract Syntax Tree (AST) just like a browser would to interpret it, and then validating a series of rules on the syntax. You can change which of the rules are checked, how strict they are, or even add your own.

@richardpq

Wow.... that is a very good explanation. With that I think it will be very
clear what is ESlint.

On Sun, May 25, 2014 at 11:01 PM, jrajav notifications@github.com wrote:

Somewhere in there you could add something along the lines of:

A linter is a static code analysis tool that points out common mistakes
and potential bugs in source code, as well as stylistic errors.

You could also include a brief explanation of its workings:

ESLint works by parsing the JavaScript source with Esprima, creating an
Abstract Syntax Tree (AST) just like a browser would to interpret it, and
then validating a series of rules on the syntax. You can change which of
the rules are checked, how strict they are, or even add your own.


Reply to this email directly or view it on GitHubhttps://github.com/eslint/eslint/issues/936#issuecomment-44154846
.

Atte.
Richard R. Perez Q.

@nzakas nzakas closed this in 0da23b8 May 28, 2014
@richardpq

Great!!!

Thanks for adding the information
On May 27, 2014 7:40 PM, "Nicholas C. Zakas" notifications@github.com
wrote:

Closed #936 #936 via 0da23b80da23b8
.


Reply to this email directly or view it on GitHubhttps://github.com/eslint/eslint/issues/936#event-125357473
.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment