codeclimate
diff --git a/‎.codeclimate.yml
+1-1 b/‎.codeclimate.yml
+1-1
diff --git a/‎.eslintrc
+2-1 b/‎.eslintrc
+2-1
diff --git a/‎CONTRIBUTING.md
+40 b/‎CONTRIBUTING.md
+40
diff --git a/‎Dockerfile
+18-7 b/‎Dockerfile
+18-7
diff --git a/‎README.md
+46-8 b/‎README.md
+46-8
diff --git a/‎bin/eslint.js
+17-2 b/‎bin/eslint.js
+17-2
diff --git a/‎bin/yarn
+6 b/‎bin/yarn
+6
diff --git a/‎circle.yml
+1-1 b/‎circle.yml
+1-1
@@ -9,7 +9,7 @@ engines:
 ratings:
   paths:
   - bin/eslint.js
-  - lib/checks.js
+  - lib/*.js
 exclude_paths:
 - "node_modules/**"
 - "test/**"
@@ -1,7 +1,8 @@
 {
   "env": {
     "node": true,
-    "mocha": true
+    "mocha": true,
+    "es6": true
   },
   "rules": {
     "block-spacing": 2,
 
@@ -0,0 +1,40 @@
+# Contributing
+
+## Adding and upgrading plugins
+
+When adding or upgrading a plugin, we should see changes in both `package.json`
+and `yarn.lock`.
+
+Make sure to run `make image` before running these commands.
+
+Add a plugin:
+
+```
+bin/yarn add eslint-config-google
+```
+
+Upgrade a plugin:
+
+```
+bin/yarn upgrade eslint-config-google
+```
+
+## Testing Changes
+
+Changes made to the engine can be tested locally.
+
+1. Install [the CodeClimate CLI](https://github.com/codeclimate/codeclimate).
+1. Create the image (customizing the `IMAGE_NAME` as needed):
+```bash
+IMAGE_NAME=codeclimate/codeclimate-eslint-test make image
+```
+1. Add the engine to your test `.codeclimate.yml`:
+```yaml
+engines:
+  eslint-test:
+    enabled: true
+```
+1. Run analyze via the CLI:
+```bash
+codeclimate analyze --dev
+```
@@ -1,15 +1,26 @@
-FROM mhart/alpine-node:5.4
+FROM node:6.5.0-slim
 MAINTAINER Code Climate <[email protected]>
 
 WORKDIR /usr/src/app
-COPY npm-shrinkwrap.json /usr/src/app/
-COPY package.json /usr/src/app/
+COPY package.json yarn.lock /usr/src/app/
 
-RUN apk --update add git && \
-    npm install && \
-    apk del --purge git
+RUN apt-key adv --fetch-keys http://dl.yarnpkg.com/debian/pubkey.gpg && \
+    echo "deb http://nightly.yarnpkg.com/debian/ nightly main" | tee /etc/apt/sources.list.d/yarn-nightly.list && \
+    apt-get update && \
+    apt-get install -y git jq yarn && \
+    yarn install && \
+    git clone https://github.com/eslint/eslint.git && \
+    ESLINT_DOCS_VERSION=`npm -j ls eslint | jq -r .dependencies.eslint.version` && \
+    cd eslint && \
+    git checkout v$ESLINT_DOCS_VERSION && \
+    cd .. && \
+    mkdir -p /usr/src/app/lib/docs/rules/ && \
+    cp ./eslint/docs/rules/* /usr/src/app/lib/docs/rules/ && \
+    rm -rf eslint && \
+    apt-get purge -y git jq && \
+    apt-get autoremove -y
 
-RUN adduser -u 9000 -D app
+RUN adduser -u 9000 --gecos "" --disabled-password app
 COPY . /usr/src/app
 RUN chown -R app:app /usr/src/app
 
 
@@ -1,19 +1,57 @@
 # Code Climate ESLint Engine
 
-[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-eslint/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-eslint)
+[![Code Climate][badge]][repo]
 
-`codeclimate-eslint` is a Code Climate engine that wraps [ESLint](https://github.com/eslint/eslint). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.
+[badge]: https://codeclimate.com/github/codeclimate/codeclimate-eslint/badges/gpa.svg
+[repo]: https://codeclimate.com/repos/github/codeclimate-eslint
 
-ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It can be configured using a [configuration file](https://github.com/eslint/eslint#usage).
+`codeclimate-eslint` is a Code Climate engine that wraps [ESLint][]. You can run
+it on your command line using the Code Climate CLI, or on our hosted analysis
+platform.
+
+ESLint is a tool for identifying and reporting on patterns found in
+ECMAScript/JavaScript code. It can be configured using a [configuration
+file][config].
+
+[config]: http://eslint.org/docs/user-guide/configuring#using-configuration-files
 
 ### Installation
 
-1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
-2. Run `codeclimate engines:enable eslint`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
-3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
+1. If you haven't already, [install the Code Climate CLI][CLI]
+
+2. Run `codeclimate engines:enable eslint`. This command both installs the
+   engine and enables it in your `.codeclimate.yml` file
+
+3. You're ready to analyze! Browse into your project's folder and run
+   `codeclimate analyze`
+
+[cli]: https://github.com/codeclimate/codeclimate
+
+### Configuration
+
+#### `ignore_warnings`
+
+By default, this engine will emit both ESLint errors and warnings as Code
+Climate issues. If you prefer, you can ignore warning-level violations by
+setting the `ignore_warnings` configuration option:
+
+```yaml
+eslint:
+  enabled: true
+  config:
+    ignore_warnings: true
+```
 
 ### Need help?
 
-For help with ESLint, [check out their documentation](https://github.com/eslint/eslint).
+For help with ESLint, [check out their documentation][eslint-docs].
+
+If you're running into a Code Climate issue, first look over this project's
+[GitHub Issues][issues], as your question may have already been covered. If not,
+[go ahead and open a support ticket with us][help].
+
+[issues]: https://github.com/codeclimate/codeclimate-eslint/issues
+[help]: https://codeclimate.com/help
 
-If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-eslint/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
+[eslint]: http://eslint.org
+[eslint-docs]: http://eslint.org/docs/user-guide/
@@ -8,17 +8,22 @@ process.chdir(CODE_DIR);
 var stdout = console.log;
 console.log = console.error;
 
-var CLIEngine = require("eslint").CLIEngine;
-var docs = require("eslint").docs;
+var eslint = require('../lib/eslint-patch')(require('eslint'));
+
+var CLIEngine = eslint.CLIEngine;
+var docs = eslint.docs;
 var fs = require("fs");
 var glob = require("glob");
 var options = { extensions: [".js"], ignore: true, reset: false, useEslintrc: true };
 var cli; // instantiation delayed until after options are (potentially) modified
 var debug = false;
 var BatchSanitizer = require("../lib/batch_sanitizer");
+var ignoreWarnings = false;
+var ESLINT_WARNING_SEVERITY = 1;
 var checks = require("../lib/checks");
 var validateConfig = require("../lib/validate_config");
 var computeFingerprint = require("../lib/compute_fingerprint");
+const ConfigUpgrader = require("../lib/config_upgrader");
 
 // a wrapper for emitting perf timing
 function runWithTiming(name, fn) {
@@ -172,6 +177,10 @@ runWithTiming("engineConfig", function () {
       options.ignorePath = userConfig.ignore_path;
     }
 
+    if (userConfig.ignore_warnings) {
+      ignoreWarnings = true;
+    }
+
     if (userConfig.debug) {
       debug = true;
     }
@@ -207,6 +216,8 @@ function analyzeFiles() {
         var path = result.filePath.replace(/^\/code\//, "");
 
         result.messages.forEach(function(message) {
+          if (ignoreWarnings && message.severity === ESLINT_WARNING_SEVERITY) { return; }
+
           var issueJson = buildIssueJson(message, path);
           process.stdout.write(issueJson + "\u0000\n");
         });
@@ -225,6 +236,10 @@ function analyzeFiles() {
 if (validateConfig(options.configFile)) {
   console.error("ESLint is running with the " + cli.getConfigForFile(null).parser + " parser.");
 
+  for (const line of ConfigUpgrader.upgradeInstructions(analysisFiles, process.cwd())) {
+    console.error(line);
+  }
+
   analyzeFiles();
 } else {
   console.error("No rules are configured. Make sure you have added a config file with rules enabled.");
 
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+
+IMAGE_NAME=${IMAGE_NAME:-codeclimate/codeclimate-eslint}
+docker run --rm --volume "$PWD:/usr/src/app" "$IMAGE_NAME" sh -c "cd /usr/src/app && yarn $*"
@@ -20,7 +20,7 @@ test:
 
 deployment:
   registry:
-    branch: master
+    branch: /master|channel\/[\w-]+/
     commands:
       - >
         docker run