Skip to content
This repository has been archived by the owner on Feb 25, 2019. It is now read-only.

Code Conventions, Formatters, and Linting #116

Closed
christiansmith opened this issue Jul 3, 2015 · 2 comments
Closed

Code Conventions, Formatters, and Linting #116

christiansmith opened this issue Jul 3, 2015 · 2 comments

Comments

@christiansmith
Copy link
Member

Up to now it hasn't been difficult to maintain a consistent coding style for this project, but as more folks start contributing it's not a bad idea to formalize conventions, document them, and adopt tooling that helps us maintain them as easily as possible.

It may be that in the spirit of harmonious collaboration, both amongst ourselves and with the broader Node/JS community, we'll need to change some of the de facto conventions used throughout this code. I'm good with that, however I'd like to avoid contentious debates and bikeshedding as much as possible.

One option we have is to adopt JavaScript Standard Style. This option has two advantages. First, there are no configurable options, so there's no room for argument over trivial details. Second, that project includes an automatic formatter. After working with Golang, I've come to greatly appreciate the convenience of this kind of tooling.

Another option (going in the opposite direction) is ESLint. This option appears to have a more traction and offers an enormous amount of flexibility. At first glance I'm not sure if it has built in automated formatting or if there are formatters available.

Please share opinions and ideas, especially if you have experience with these tools.

@adalinesimonian
Copy link
Member

I like the simplicity of JS Standard Style. Right now (and later), we need to be working on building Connect with good code, not arguing over what it should look like. JSSS looks like the simplest solution, and even though the style is quite different from what I'm personally used to, I'll gladly get up to speed for the common good.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants