moved combineRules.js to a scripts directory

Author: joeycozza

README.md

@@ -20,3 +20,37 @@ We have a configuration for jsdoc rules that you can use if your team decides th
       "@fs/eslint-config-frontier-react/jsdoc"
     ],
     ```
+
+## CodeClimate Usage
+
+It is important to note that in order for CodeClimate to use this custom config, we have to work around their limitations a bit.
+
+1.  Add a prepare section to your .codeclimate.yml that will download this eslint-config file. [Prepare Docs](https://docs.codeclimate.com/docs/configuring-the-prepare-step)
+    - It should look like this
+      ```yaml
+      prepare:
+        fetch:
+          - url: 'https://raw.githubusercontent.com/fs-webdev/eslint-config-frontier-react/master/index.js'
+            path: 'eslint-config-frontier-react.js'
+      ```
+    - If you also opt into the jsdoc plugin we provide, you'll also need to make a prepare statement for that file.
+2.  Make a new eslintrc file for codeclimate to use (that way it can point to the `eslint-config-frontier-react.js` file that codeclimate will prepare in Step 1.)
+
+    1.  Copy your existing local eslintrc file and rename the copy to `.codeclimate.eslintrc.js` (or .json or .yml if you are using those filetypes)
+    2.  Change the `"extends": ["frontier"]` statement to point to the prepared file from Step 1. `"extends": ["./eslint-config-frontier-react.js"]`
+        (only do this in `.codeclimate.eslintrc.js` file, not your normal eslintrc)
+        - If you also opt into the jsdoc plugin we provide, you'll also need to add that downloaded file to the extends array
+
+3.  Tweak your .codeclimate.yml eslint section to point to the .codeclimate.eslintrc file instead of your default local eslintrc file
+    - Your plugin section in your .codeclimate.yml may be larger and more complicated, but the `config:` part should point to the new eslintrc file you made in step 2.
+    ```yaml
+    plugins:
+      eslint:
+        channel: eslint-4
+        config: # <- This line and the line below it are the important lines to add/tweak
+          config: .codeclimate.eslintrc.js # <- this line and the line above it are the important lines to add/tweak
+          extensions:
+            - .js
+            - .html
+        enabled: true
+    ```

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "echo \"Warning: no test specified\" && exit 0",
     "publish": "npmPublish",
-    "combineRules": "node combineRules.js"
+    "combineRules": "node scripts/combineRules.js"
   },
   "repository": {
     "type": "git",
@@ -51,8 +51,7 @@
   "devDependencies": {
     "@fs/npm-publisher": "^1.0.0",
     "eslint": "^5.10.0",
-    "husky": "^2.4.1",
-    "lint-staged": "^8.2.1"
+    "husky": "^2.4.1"
   },
   "husky": {
     "hooks": {

combineRules.js renamed to scripts/combineRules.js

@@ -1,15 +1,15 @@
 const fs = require('fs')
 const path = require('path')
 
-const index = require('./index')
+const index = require('../index')
 
 // the order of these configs is important and defined by the order of index.js,
 // jsdoc is opt-in, and to get that in codeclimate, they'll need to use a prepare statement for the
 // jsdoc.js file as well, we won't do that automatically here
 const configsToCombine = [
-  require('./es6'), // eslint-disable-line
-  require('./react'), // eslint-disable-line
-  require('./jest'), // eslint-disable-line
+  require('../es6'), // eslint-disable-line
+  require('../react'), // eslint-disable-line
+  require('../jest'), // eslint-disable-line
 ]
 
 const codeclimateConfig = {