Merge!

Author: johnboxall

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+Linked PRs: (links to corresponding PRs, optional)
+
+## Changes
+- (changes here)
+
+## How To Test
+- (necessary config changes)
+- (necessary corresponding PRs)
+- (how to access the new / changed functionality -- fixtures, URLs)
+
+## Applicable Research Resources
+- (links, optional)
+
+## TODOs:
+- [ ] +1
+- [ ] Updated README
+- [ ] Updated CHANGELOG
+- [ ] (Other applicable TODOs)

.gitignore

@@ -1,2 +1,3 @@
+*.sw[a-z]
 .idea/
 node_modules

CHANGELOG

@@ -1,5 +1,25 @@
-2.4.4
+Pending Release
+    - Remove `variable-for-property` rule from sass-lint
     - Adds markdown linting
+2.5.3
+    - Fix #123 by using react/jsx-wrap-multilines rule
+    - Migrate CSSComb documentation from Confluence to code style repo
+2.5.2
+    - Fix #43 by updating all underlines in Sass code examples
+    - Fix #114 by removing invalid options from CSSComb config file
+    - Add a React rule to make sure propTypes are ordered, required ones declared first and callbacks (e.g. onChange) declared last.
+    - Update ES6 indent rule on switch statements
+    - Add ignore patterns for unused vars/args to the React configuration
+    - Ignore non-JS files and node_modules in the ES6 import module
+    - Add a new ES5 configuration ported to ESLint 2 and up
+2.5.1
+    - Update line length to 200
+    - Remove rule for no-unresolved import
+    - Remove 'strict' rule for modules
+2.5.0
+    - Add an ES6 and JSX standard with lint rules.
+2.4.4
+(??)
 2.4.3
     - Add eslint rule + doc entry regarding trailing commas
 2.4.2

README.md

@@ -4,17 +4,29 @@ A repo to document code standards for different languages and provide tools for
 
 [![NPM version](https://badge.fury.io/js/mobify-code-style.svg)](http://badge.fury.io/js/mobify-code-style)
 
-## JavaScript
+## JavaScript (ES5) with Grunt
 
-Typically, we lint our javascript files using [Grunt](http://gruntjs.com/) and [grunt-eslint](https://github.com/sindresorhus/grunt-eslint). grunt-eslint is a Grunt helper for the [ESLint](http://eslint.org/) linter.
+Typically, we lint our javascript files using
+[Grunt](http://gruntjs.com/) and
+[grunt-eslint](https://github.com/sindresorhus/grunt-eslint). grunt-eslint
+is a Grunt helper for the [ESLint](http://eslint.org/) linter.
 
 To add javascript linting to your project:
 
  1. Install the NPM `mobify-code-style` and `grunt-eslint` modules.
- 2. Create a [Gruntfile](http://gruntjs.com/sample-gruntfile) if you don't have one already.
- 3. In the initConfig of your gruntfile, add a section for eslint pointing to the correct linting file.
+ 2. Create a [Gruntfile](http://gruntjs.com/sample-gruntfile) if you
+    don't have one already.
+ 3. Create an `.eslintrc.yml` file in the root of your project directory
+ 4. In the initConfig of your gruntfile, add a section for eslint pointing to the correct linting file.
 
-Sample eslint config:
+The `.eslintrc.yml` file should contain, to begin with:
+```yaml
+extends:
+  - './node_modules/mobify-code-style/es5/mobify-es5.yml'
+```
+
+
+Sample eslint Grunt config:
 
 ```javascript
 eslint:{
@@ -24,11 +36,59 @@ eslint:{
             // When true, eslint will test _only_ the rules set in the provided
             // configuration file
             reset: false,
-            config: 'node_modules/mobify-code-style/javascript/.eslintrc'
+            configFile: './.eslintrc.yml'
         }
     }
 }
 ```
+
+### Migrating from ESLint 0.x or 1.x to ESlint 2.x or 3.x
+
+If you upgrade the version of `grunt-eslint` you use from one that
+pulls in ESLint 1.x or lower to one that pulls
+in ESLint 2.x or greater, you must modify the configuration files to
+include the new style of configuration.
+
+If the Grunt config includes the default config
+`./node_modules/mobify-code-style/javascript/.eslintrc`, replace that
+with `./.eslintrc.yml`, and add an `.eslintrc.yml` to the project root
+as described above.
+
+If there are modifications to the lint configuration in the project,
+please check the migration guides at [http://eslint.org/] to port the
+modified lint config to ESLint 3.x.
+
+## ES6/JSX
+
+We use [ESLint](http://eslint.org/) to lint ES6 and React/JSX code. If ESLint is installed in a project, we can use the configuration from this module by creating a file in the project root named `.eslintrc.yml`. If the project does not use JSX, the file contents should be
+
+```yaml
+extends:
+  - './node_modules/mobify-code-style/es6/mobify-es6.yml'
+```
+
+and for a React/JSX project:
+
+```yaml
+extends:
+  - './node_modules/mobify-code-style/es6/mobify-es6-react.yml'
+```
+
+If using a custom Webpack configuration, add the lines:
+```yaml
+settings:
+  import/resolver:
+    webpack:
+      config: '<path-to-webpack-config>'
+```
+to the `.eslintrc.yml`
+
+Make sure to install the following NPM modules:
+ - `eslint` > 3.0
+ - `eslint-plugin-import`
+ - `eslint-import-resolver-webpack`
+ - `eslint-plugin-react` (for React/JSX linting only)
+
 ## CSS
 Our Client Services team's [CSS Style Guide](/css/Readme.md). Written with a lot of tender care by @kpeatt and @jeffkamo.
 

RELEASE.md

@@ -0,0 +1,15 @@
+## Mobify Code Style
+- [ ] Branch off of `develop` and create a `release-vX.Y.Z` branch.
+- [ ] Create a new pull request with the following settings:
+      * Base: `master`
+      * Compare: `release-vX.Y.Z`
+      Paste the contents of this checklist into this pull request.
+- [ ] Increment the version in `package.json`.
+- [ ] In the CHANGELOG.md file of this release branch, change the 'To be released' header to 'vX.Y.Z'.
+- [ ] Merge `release-vX.Y.Z` into `master` using the pull request, then delete the release branch.
+- [ ] [Publish to npm](https://docs.npmjs.com/cli/publish) from the `master` branch.
+- [ ] Draft a new Github release with the following settings:
+      * Tag version: `X.Y.Z` @ `master`
+      * Release title: `X.Y.Z`
+      * Description: Use highlights from the CHANGELOG.md (only pick out the most significant changes)
+- [ ] Merge `master` into `develop` (no need for review on PR, just merge).

assets/csscomb.gif

@@ -13,11 +13,9 @@
     "combinator-space": [" ", " "],
     "element-case": "lower",
     "eof-newline": true,
-    "leading-zero": null,
     "rule-indent": "    ",
     "stick-brace": " ",
     "unitless-zero": true,
-    "quotes": false,
     "remove-empty-rulesets": true,
     "space-before-closing-brace": "\n",
     "space-before-colon": "",
@@ -29,7 +27,7 @@
     "space-after-selector-delimiter": "\n",
     "space-before-selector-delimiter": "",
     "strip-spaces": true,
-    "tab-size": true,
+    "tab-size": 4,
     "unitless-zero": true,
     "sort-order": [
         [

css/.csscomb.json

@@ -323,9 +323,7 @@ rules:
   trailing-semicolon: 2
   url-quotes: 1 # Only warn here, since sass-lint doesn't understand helpers in urls
   variable-for-property:
-    - 2
-    - properties:
-        - font
+    - 0
   variable-name-format:
     - 2
     - allow-leading-underscore: true

css/.sass-lint.yml

@@ -45,5 +45,8 @@
 * [Sass-Lint](sass-lint/readme.md)
     * [Using Sass-Lint with Atom](sass-lint/readme.md#using-sass-lint-with-atom)
     * [Using Sass-Lint with Sublime Text](sass-lint/readme.md#using-sass-lint-with-sublime-text)
+* [CSSComb](csscomb/readme.md)
+    * [Using CSSComb with Atom](csscomb/readme.md#atom)
+    * [Using CSSComb with Sublime Text](csscomb/readme.md#sublime-text)
 
 Continue on to [the Introduction →](introduction#introduction)