google / eslint-config-google

ESLint shareable config for the Google JavaScript style guide
Apache License 2.0
1.74k stars 140 forks source link

More prominent note that this is for the ES6 style guide? #44

Closed EffinMaggie closed 7 years ago

EffinMaggie commented 7 years ago

Most searches for the Google JS style guide seem to point to this one: https://google.github.io/styleguide/javascriptguide.xml - but really this config is for the ES6 style guide here: https://google.github.io/styleguide/jsguide.html

It's not obvious from the readme which of the two style guides this config is for, and they disagree on some key issues (e.g. 'var' vs 'let' and 'const'). It'd be a good idea to clarify this.

I know there's a link at the top, but just rewording that to clarify it's the ES6 style guide would help since users who find the style guide first and then try to find a linter for it would otherwise be greatly surprised and are unlikely to check the link's target.

philipwalton commented 7 years ago

Good suggestion. Added!