search

pouchdb / pouchdb

:kangaroo: - PouchDB is a pocket-sized database.
https://pouchdb.com/
Apache License 2.0
16.9k stars 1.47k forks source link

Code style guide is not enforced by jshint anymore #4871

Closed sgenoud closed 8 years ago

sgenoud commented 8 years ago

The maintainer of JShint has decided to take it in a direction where it focuses on and do not implement coding style, see this SO answer (and the post it links to)

Why does that matter? Because pouchdb relies on jshint to enforce its coding style. Typically with the current version used the indent of 2 spaces does not show up in the posttest phase.

jshint proposes to use jscs for the task: http://jscs.info/overview, seems good enough to me (I spent a bit of time running it on the project: https://github.com/pouchdb/pouchdb/compare/master...sgenoud:adding-jscs I guess we should probably ignore the style for the comments (that adds lots of not that necessary changes).

NickColley commented 8 years ago

This sounds good to me, wonder if this'd be a decent time to explore the option of using 'standard' etc?

sgenoud commented 8 years ago

wonder if this'd be a decent time to explore the option of using 'standard' etc

I am not sure I understand want you mean, can you explain me?

NickColley commented 8 years ago

We've changed our linting and code style a few times, if we used something like https://www.npmjs.com/package/standard (https://github.com/Flet/semistandard) we wouldn't have to maintain this side of the project.

If that's too drastic I'm :+1: for your approach though, see what everyone else thinks.

daleharvey commented 8 years ago

I do think it would be preferable to have a single tool to handle this, semistandard may be ok although we could never use standard and worried about semistandard being similiarly obnoxious. Using eslint directly also seems like a possibility.

marten-de-vries commented 8 years ago

eslint config file I use for pouchdb plugins, of which the code style is relatively similar I think: https://github.com/pouchdb/pouchdb-plugin-helper/blob/master/eslint (no support for ES6 import/export, see https://github.com/pouchdb/pouchdb-plugin-helper/blob/master/eslint-test for an example of that, but that one's too broad, because also other ES6 features are supported.)

nolanlawson commented 8 years ago

What's wrong with just pinning our JSHint version where it is? Not sure there's always a burning need to "upgrade" every dependency, especially if they start going in a wildly different direction.

daleharvey commented 8 years ago

Fixed in https://github.com/pouchdb/pouchdb/commit/d2d339f722e365cb797dcd6d25f355db0e8f911b

sgenoud commented 8 years ago

Nice!

NickColley commented 8 years ago

Thanks @sgenoud for getting this going :+1: