Merge pull request #142 from mobify/npm-auto-publish

Slack publish (was "npm auto publish")

Author: jeremywiebe

CHANGELOG

@@ -0,0 +1,136 @@
+## 2.8.0 (May 3, 2017)
+- Adds new copyright-header management tool
+    
+## v2.7.4 (February 2, 2017)
+- Add new classname prefixes to CSS documentation: `pw-` and `qa-`
+- Add links to alternative CSSComb text editor plugins
+- Fix `lint-md` to work properly on Node.js v6+
+
+## v2.7.3
+- Temporarily disable `spaced-comment` errors, until Astro release builds comply
+  with this rule.
+
+## v2.7.2
+- Temporarily downgrade `spaced-comment` errors to warning level, until Astro
+  release builds comply with this rule.
+
+## v2.7.1
+- Re-organized and cleaned up markdown linting files
+- Switched to using `no-duplicate-headings-in-section` (instead of
+  `no-duplicate-headings`)
+- Add `spaced-comment` rule enforcement to ES5 and legacy (ESLint 1.x or lower)
+  linting [#132](https://github.com/mobify/mobify-code-style/pull/132)
+
+## v2.7.0
+- Remove `variable-for-property` rule from sass-lint
+- Adds markdown linting via `lint-md` script
+- Add ESLint and Atom Text integration how-to doc
+
+## v2.6.0
+- Remove `variable-for-property` rule from sass-lint
+  [#126](https://github.com/mobify/mobify-code-style/pull/126)
+- Add the eslint jsx-a11y plugin through a new `mobify-es6-react-a11y`
+  configuration [#129](https://github.com/mobify/mobify-code-style/pull/129)
+
+## v2.5.3
+- Fix #123 by using react/jsx-wrap-multilines rule
+- Migrate CSSComb documentation from Confluence to code style repo
+
+## v2.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
+
+## v2.5.1
+- Update line length to 200
+- Remove rule for no-unresolved import
+- Remove 'strict' rule for modules
+
+## v2.5.0
+- Add an ES6 and JSX standard with lint rules.
+
+## v2.4.4
+- Add a template for code-style PRs
+- Go meta! Add some templates of GitHub templates for contributing, issues, and
+  PRs that can be used on other Mobify repos
+
+## v2.4.3
+- Add eslint rule + doc entry regarding trailing commas
+
+## v2.4.2
+- Add/update documentation for Sass-Lint
+
+## v2.4.1
+- Fix some bugs with sass-lint config
+
+## v2.4.0
+- Add a sass-lint config file
+
+## v2.3.7
+- Add Writing Checklist
+- Fix doc error wrt function expression hoisting
+- Add some more JS code style to the docs
+
+## v2.3.6
+- Change CSScomb rule: null leading-zero rule due to CSScomb bug
+
+## v2.3.5
+- Add Sass documentation about placeholders and `@extends`
+- Add CSS documentation on l10n and i18n best practices
+
+## v2.3.4
+- Patch CSSComb and scss-lint rules for compatibility
+- LeadingZero aligned to enabled
+- Tweaked property ordering
+- NameFormat to match BEM
+- NestingDepth upped to 4
+- color and background-color properties no longer require explicit Sass
+  variables
+
+## v2.3.3
+- Change scss-lint rule: disable the quotes rules
+- Change CSScomb rule: disable the quotes rules
+
+## v2.3.2
+- Update documentation: "Tools & Frameworks" section in the CSS introduction
+
+## v2.3.1
+- Add an eslint config file for production-ready JS
+
+## v2.3.0
+- Add CSSComb
+- Update documentation
+- Update SCSS-lint to 0.42.2
+
+## v2.2.4
+- Remove the unnecessary parens rule
+
+## v2.2.3
+- Restrict the unnecessary parens rule to functions
+
+## v2.2.2
+- Remove enforcement of 'max-statements' and 'max-params' JS rules
+
+## v2.2.1
+- Cumulative patch release
+- Update SCSS-lint to 0.40.1
+
+## v2.2.0
+- Fixes eslint config to play nicely with Atom's linter-eslint package
+- Adds an eslint config reset file so that our ruleset is an override
+
+## v2.1.1
+- Re-publish to work-around NPM issue
+
+## v2.1.0
+- Add new rules to .eslintrc to closer match our JS style guidelines.
+
+## v2.0.1
+- Adds .eslintrc to allow usage of ESLint
+- Adds Java code style guide
+- Updates to CSS hybrid project conventions

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Mobify Code Style
 
-A repo to document code standards for different languages and provide tools for linting Mobify projects.
+A repo to document code standards for different languages and provide tools for
+linting Mobify projects.
 
 [![NPM version](https://badge.fury.io/js/mobify-code-style.svg)](http://badge.fury.io/js/mobify-code-style)
 [![CircleCI](https://circleci.com/gh/mobify/mobify-code-style/tree/develop.svg?style=svg)](https://circleci.com/gh/mobify/mobify-code-style/tree/develop)
@@ -14,11 +15,12 @@ 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. 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.
+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. 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.
 
 The `.eslintrc.yml` file should contain, to begin with:
 ```yaml
@@ -55,12 +57,15 @@ 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.
+please check the migration guides at [eslint.org](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
+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:
@@ -84,17 +89,19 @@ settings:
 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)
+- `eslint` > 3.0
+- `eslint-plugin-import`
+- `eslint-import-resolver-webpack`
+- `eslint-plugin-react` (for React/JSX linting only)
 
 ## ESLint and Atom
 
 Find out how to integrate [ESLint and Atom Text](./javascript/atom.md).
 
 ## CSS
-Our Client Services team's [CSS Style Guide](/css/Readme.md). Written with a lot of tender care by @kpeatt and @jeffkamo.
+
+Our Client Services team's [CSS Style Guide](/css/Readme.md). Written with a lot
+of tender care by @kpeatt and @jeffkamo.
 
 ## Python
 
@@ -103,11 +110,13 @@ instructions on using `pep8`, `pylint` and `pyflakes` to check Python code.
 
 ## Documentation
 
-See the [`docs`](docs) directory for setup and configuration of Markdown linting.
-
+See the [`docs`](docs) directory for setup and configuration of Markdown
+linting.
 
 ## Copyright Headers
 
-All Mobify source files should contain copyright headers at the beginning of the file.
+All Mobify source files should contain copyright headers at the beginning of the
+file.
 
-See the [`copyright`](copyright) directory for setup and configuration of the copyright manager tool
+See the [`copyright`](copyright) directory for setup and configuration of the
+copyright manager tool

README.md

@@ -1,15 +1,5 @@
-## 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).
+# Mobify Code Style - Release process
+
+Use Slack to release new versions of the Mobify Code Style. 
+
+`@mobitron release mobify-code-style [minor|patch]`

RELEASE.md

@@ -17,7 +17,7 @@
   },
   "homepage": "https://github.com/mobify/mobify-code-style",
   "scripts": {
-    "test": "cd docs/test; bash test.sh"
+    "test": "scripts/test.sh"
   },
   "dependencies": {
     "glob": "^7.1.1",

package.json

@@ -0,0 +1,21 @@
+#!/bin/bash -eu
+# -e Exit immediately if a command exits with a non-zero status.
+# -u Treat unset variables as an error when substituting.
+#  More info can be found by typing `help set` in any bash shell
+
+# the return value of a pipeline is the status of the last command to exit with a non-zero status, or zero if no command exited with a non-zero status
+set -o pipefail
+
+# Identifies the path that the script is in (http://stackoverflow.com/a/246128/11807)
+MYPATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+
+# ROOT is the root directory of your project. It isn't always needed if your script is at the root of your project, but its a useful convention to adopt so that your scripts can be moved and the only thing that needs to change then is ROOT. 
+ROOT=$MYPATH/..
+
+# We have to `cd` into the dir otherwise the diffs that we use for testing
+# fail due to paths of the test files not matching.
+pushd "$ROOT/docs/test"
+    bash test.sh
+popd
+
+"$ROOT/docs/bin/lint-md" "$ROOT/*.md"