neuroanatomy / BrainBox

BrainBox is a web application that lets you annotate and segment 3D brain imaging data in real time, collaboratively.
https://brainbox.pasteur.fr
Other
96 stars 46 forks source link

add eslint to BrainBox #158

Closed katjaq closed 6 years ago

katjaq commented 6 years ago

What is the current behaviour?

BrainBox does not yet have any test for achieving and maintaining a common code style.

What is the expected or desired behaviour?

We would like to use eslint on our files to adapt our code to common standards and make it easier for anyone to jump on board and work with us.

ginniecodes commented 6 years ago

Can I help you with this?

theevangelista commented 6 years ago

What about using xo ? Its easy to setup, uses eslint and come with predefined rules

r03ert0 commented 6 years ago

sounds good!

On Tuesday, October 17, 2017, João Pedro Evangelista < notifications@github.com> wrote:

What about using xo https://github.com/sindresorhus/xo ? Its easy to setup, uses eslint and come with predefined rules

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/OpenNeuroLab/BrainBox/issues/158#issuecomment-337268996, or mute the thread https://github.com/notifications/unsubscribe-auth/ACNCTJVhpcJ2sUbfrdjRke--zsQ--hCnks5stMoIgaJpZM4P8Rnz .

Danielsilveira98 commented 6 years ago

Do would you use eslint in grunt?

katjaq commented 6 years ago

what is the advantage compared with pure eslint or xo?

theevangelista commented 6 years ago

@Danielsilveira98 @katjaq Grunt is not useful here right now, you got everything covered on the npm scripts.

ginniecodes commented 6 years ago

@katjaq I think using xo means more dependencies but covers a lot of work configuring pure eslint. While eslint standalone needs to be configured for tests and others.

katjaq commented 6 years ago

Thank you very much for your replies! Last week-end, we started trying eslint on one of our projects (MicroDraw). We started with >2500 eslint errors ÖÖ and then started adding the .eslintrc file.

Maybe you could reuse these files and give a try to eslint? That would be nice.

theevangelista commented 6 years ago

Well, xo gives a widely accepted defaults, so you don't need an eslintrc file, also it CAN fix common mistakes with just a command. But if you want to use bare eslint you can have a default rc file to all the repositories.

Oh btw xo uses eslint under the hood, so you can customize it the same way you do with eslint

On Tue, Oct 17, 2017, 8:12 PM katja heuer notifications@github.com wrote:

Thank you very much for your replies! Last week-end, we started trying eslint on one of our projects (MicroDraw https://github.com/r03ert0/microdraw). We started with >2500 eslint errors ÖÖ and then started adding the .eslintrc file.

Maybe you could reuse these files and give a try to eslint? That would be nice.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/OpenNeuroLab/BrainBox/issues/158#issuecomment-337389617, or mute the thread https://github.com/notifications/unsubscribe-auth/AFA2B0Miqk7wTZL8vdJ1LYvvabACmS5Fks5stSZdgaJpZM4P8Rnz .

katjaq commented 6 years ago

ok!!! 😃 You made me all curious!! would you like to set it up with xo? I would like to give it a try and what you say sounds good!!

Thank you so much!!! looking forward to your pull request!! \ö//

we are new to all kind of testing. thank you very much for your input! <3

theevangelista commented 6 years ago

No problem at all!! I'm working on it! I'll leave the fix magic to you 😸