New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Follow the JavaScript Standard style #26

Open
bmpvieira opened this Issue Apr 4, 2015 · 6 comments

Comments

5 participants
@bmpvieira
Member

bmpvieira commented Apr 4, 2015

The standard style is used probably a lot in Bionode (and Node.js) but currently not enforced in Bionode. I think having the same style across all modules makes it easier for the team to review the code and contribute.
The standard module should be added to the dependencies and to the tests of all bionode modules.

WIP:

@amanjeev

This comment has been minimized.

amanjeev commented May 9, 2016

There are some nice code linters that can be used so the codebase is always in the correct standard. Something like http://jscs.info/.

@amanjeev

This comment has been minimized.

amanjeev commented May 17, 2016

I meant to say something that is part of the build process and informs the contributor of the style (or stylizes itself). What I like about JSCS is that has presets but I have used it only once. It can also auto configure based on how your source code is styled currently.

@amanjeev

This comment has been minimized.

amanjeev commented May 17, 2016

ah! I see what that tool is that you mention! :-)

@bmpvieira bmpvieira added chore and removed enhancement ready labels Mar 29, 2017

Rudani added a commit to bionode/bionode-fasta that referenced this issue Apr 10, 2017

@Rudani Rudani moved this from Next to In Progress in Bionode Project Board Apr 10, 2017

@Rudani Rudani self-assigned this Apr 10, 2017

@Rudani

This comment has been minimized.

Member

Rudani commented Apr 10, 2017

@bmpvieira moved this comment (list of modules) to first one for tracking.

Rudani added a commit to bionode/fasta-parser that referenced this issue Apr 11, 2017

@bmpvieira bmpvieira referenced this issue May 24, 2017

Closed

Mozilla's Global Sprint (June 1st and 2nd 2017) #44

7 of 17 tasks complete
@tiagofilipe12

This comment has been minimized.

Member

tiagofilipe12 commented May 27, 2017

You could provide an example implementation for the upcoming Moz sprint, like you did for instance for bionode-ncbi.

@bmpvieira

This comment has been minimized.

Member

bmpvieira commented May 30, 2017

Do:

git clone git@github.com:bionode/MODULE_NAME.git
cd MODULE_NAME
npm install --save-dev standard

Then add standard to tests. and do npm test to get all the style errors.

You can also install standard as a global tool and do:

npm install standard -g
standard

However, if you get too many errors, the best is to install standard in your IDE so that they get highlighted automatically:

You could also just do standard --fix to fix all errors automatically, but that might not always behave the way you would expect and could introduce other errors, so I recommend you manually inspect and fix every error caught by IDE or tests.

@bmpvieira bmpvieira added the mozsprint label May 30, 2017

@bmpvieira bmpvieira assigned StuntsPT and unassigned Rudani Jun 2, 2017

@bmpvieira bmpvieira moved this from In Progress to Next in Bionode Project Board Aug 22, 2017

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