Coding Standards for Modern Web Development

[justin]

This is a meta-topic of several key topics for building a new app and having a set of best practice guidelines:

Ruby Coding Standards

• RailsOnMaui Ruby Coding Standards

JavaScript Coding Standards

• AirBnb Javascript

Git coding Standards

• Git Coding Standards

Sass Coding Standards

• Sass Guidelines by Hugo Giraudel
• Github Front End Guidelines

CoffeeScript or JavaScript

• Definitely Javascript, preferably with ES6 syntax

JavaScript UI Framework

• ReactJs

JavaScript Package Management and Modules

• Npm rather than Bower
• Webpack

Linters

Linting is extremely important to keep on track with any standard. I’m currently using the following tools:

Ruby

1. RuboCop
2. ESLint with the https://github.com/airbnb/javascript/blob/master/linters/.eslintrc
3. JSCS

I’ve posted samples of my configuration here:

Code Inspection

Remove Vendor, CoffeeScript, and Slim Right now, too many issues with code inspection of those. Too many false alarms. Scope: No Vendor No Coffeescript No Slim (replace rebar with your project name) file[rebar]:*/&&!file[rebar]:vendor//*&&!file[rebar]:*//*.js.coffee*&&!file[rebar]:*//*.slim Here’s the XML for the inspections I’m using:

Related Forum Topics

Best Practices for Ruby or Rails?

Any favorite links for Ruby or Rails best practices? Here's a few that come to mind: Thoughtbot Best Practices Github Ruby Style Guide AirBnb Ruby Style Guide bbatsov Style Guide I just went through the AirBnb one. So AWESOME! Lots of good Ruby tips, such as using named capture groups rather than $1, $2. Like this: /\$(?<dollars>\d+)\.(?<cents>\d+)/ =~ "$3.67" #=> 0 dollars #=> "3"

Fast Rich Client Rails Development With Webpack and the ES6 Transpiler

There has to be a better way to incorporate the JavaScript ecosystem into Rails. [image] Update August 19, 2015: I’m working on revising this article to reflect much progress in this area since the original publication of this article in 2014. I highly recommend seeing the README at https://github.com/justin808/react-webpack-rails-tutorial and the pull requests (both open and closed) of what’s been incorporated since this article was first published. Have you: Wondered if there’s…