mrdoobapproves

Does MrDoob Approve?

"MrDoob Approves" is a browser-based Javascript code style checker/validator/formatter/editor/tool. Initially created for Mr.doob's Code Style™, it is assembled with code-mirror and node-jscs. Previously, a modified version of jscs by gero3 was used before the jscs library shipped with auto-fixing.

Run the editor here

About

This tool helps to check if your code is in Mr.doob's Code Style™ and can help you auto-format it. This is useful if you are making a pull-request to mrdoob's javascript projects like three.js. More about this in this blog post

Releases

Planned features for version 3

• Minimalistic linting engine
• JSCS Rule Editing
• JSCS library 2 (supporting ES6 with babel)

2.0 - 1 Dec 2015

• JSCS library with autofix (v1.13.1, last offical version without Babel)
• Updated MDCS rules - space checks
• Ability to chose other presets
• Simplier Autofix Button

1.0 - 12 Jan 2015

• Mr.doob's Code Style™ validator
• Check as you type
• Gutter hinting
• JS syntax highlighting using code mirror
• Auto-formatting with diff editor
• Jump to error
• Trailing spaces hinting
• Open file

Development

This project uses some of these philosophy

• TDDD style - TODO Driven Development.
• Open open-source model - Significant contributors gets commit access to github repo
• Release early, release often - main branch is gh-pages

Instructions for this project's workflow

You need npm, git, webpack to be able to create a compressed bundle. Clean install:

npm run install

will install webpack with npm install -g webpack and run npm install to update dependencies.

use webpack -p or npm run bundle to create bundles for release.

use webpack --watch or npm run watch if you are testing bundles locally.

Disclaimer

p.s. This project, its name or code was neither approved or endorsed by mrdoob.