fix(deps): upgrade all dependencies and cleanup (#117)

Author: Kent C. Dodds

.eslintrc

@@ -0,0 +1,11 @@
+{
+  "extends": [
+    "kentcdodds",
+    "kentcdodds/prettier",
+    "kentcdodds/jest"
+  ],
+  "rules": {
+    "valid-jsdoc": "off",
+    "max-len": "off"
+  }
+}

.gitignore

@@ -1,6 +1,12 @@
-/node_modules
-.nyc_output
+node_modules
 coverage
 dist
 .opt-in
 .opt-out
+.DS_Store
+.eslintcache
+
+# these cause more harm than good
+# when working with contributors
+package-lock.json
+yarn.lock

.travis.yml

@@ -6,13 +6,12 @@ cache:
 notifications:
   email: false
 node_js:
-  - '6'
+  - '8'
 script:
-  - yarn start validate
+  - npm start validate
 after_success:
-  - yarn start report-coverage
-  - yarn start release
+  - npx codecov
+  - npm i -g semantic-release@7 && semantic-release pre && npm publish && semantic-release post
 branches:
   only:
     - master
-    - /^greenkeeper/.*$/

CONTRIBUTING.md

@@ -8,60 +8,77 @@ Thanks for being willing to contribute!
 ## Project setup
 
 1. Fork and clone the repo
-2. `$ yarn install` to install dependencies
-3. `$ yarn start validate` to validate you've got it working
+2. `$ npm install` to install dependencies
+3. `$ npm start validate` to validate you've got it working
 4. Create a branch for your PR
 
-This project uses [`nps`][nps] and you can run `yarn start` to see what scripts are available.
+This project uses [`nps`][nps] and you can run `npm start help` to see what
+scripts are available.
+
+> Tip: Keep your `master` branch pointing at the original repository and make
+> pull requests from branches on your fork. To do this, run:
+>
+> ```
+> git remote add upstream https://github.com/prettier/prettier-eslint.git
+> git fetch upstream
+> git branch --set-upstream-to=upstream/master master
+> ```
+>
+> This will add the original repository as a "remote" called "upstream,"
+> Then fetch the git information from that remote, then set your local `master`
+> branch to use the upstream master branch whenever you run `git pull`.
+> Then you can make all of your pull request branches based on this `master`
+> branch. Whenever you want to update your version of `master`, do a regular
+> `git pull`.
 
 ## Add yourself as a contributor
 
-This project follows the [all contributors][all-contributors] specification. To add yourself to the table of
-contributors on the README.md, please use the automated script as part of your PR:
+This project follows the [all contributors][all-contributors] specification.
+To add yourself to the table of contributors on the README.md, please use the
+automated script as part of your PR:
 
 ```console
-yarn start contributors.add
+npm start contributors.add
 ```
 
-Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run
-it again and select the added contribution type.
+Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
+If you've already added yourself to the list and are making
+a new type of contribution, you can run it again and select the added
+contribution type.
 
 ## Committing and Pushing changes
 
-This project uses [`semantic-release`][semantic-release] to do automatic releases and generate a changelog based on the
-commit history. So we follow [a convention][convention] for commit messages. Please follow this convention for your
-commit messages.
+This project uses [`semantic-release`][semantic-release] to do automatic
+releases and generate a changelog based on the commit history. So we follow
+[a convention][convention] for commit messages. You don't have to follow this
+convention if you don't like to. Just know that when we merge your commit, we'll
+probably use "Squash and Merge" so we can change the commit message :)
 
-You can use `commitizen` to help you to follow [the convention][convention]
-
-Once you are ready to commit the changes, please use the below commands
-
-1. `git add <files to be committed>`
-2. `$ yarn start commit`
-
-... and follow the instruction of the interactive prompt.
+Please make sure to run the tests before you commit your changes. You can run
+`npm start test.update` which will update any snapshots that need updating.
+Make sure to include those changes (if they exist) in your commit.
 
 ### opt into git hooks
 
-There are git hooks set up with this project that are automatically installed when you install dependencies. They're
-really handy, but are turned off by default (so as to not hinder new contributors). You can opt into these by creating
-a file called `.opt-in` at the root of the project and putting this inside:
+There are git hooks set up with this project that are automatically installed
+when you install dependencies. They're really handy, but are turned off by
+default (so as to not hinder new contributors). You can opt into these by
+creating a file called `.opt-in` at the root of the project and putting this
+inside:
 
 ```
-commit-msg
 pre-commit
 ```
 
 ## Help needed
 
-Please checkout the [ROADMAP.md][ROADMAP] and raise an issue to discuss
-any of the items in the want to do or might do list.
+Please checkout the [the open issues][issues]
 
 Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!
 
 [egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
 [semantic-release]: https://npmjs.com/package/semantic-release
 [convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
 [all-contributors]: https://github.com/kentcdodds/all-contributors
-[ROADMAP]: ./other/ROADMAP.md
-[nps]: https://npmjs.com/package/nps
+[issues]: https://github.com/prettier/prettier-eslint/issues
+[nps]: https://github.com/kentcdodds/nps

jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  testEnvironment: 'node',
+  collectCoverageFrom: ['src/**/*.js'],
+  testPathIgnorePatterns: ['/node_modules/', '/fixtures/', '/__mocks__/'],
+  coveragePathIgnorePatterns: ['/node_modules/', '/fixtures/', '/__mocks__/'],
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100,
+    },
+  },
+}

package-scripts.js

@@ -3,6 +3,7 @@ const npsUtils = require('nps-utils')
 const series = npsUtils.series
 const concurrent = npsUtils.concurrent
 const rimraf = npsUtils.rimraf
+const crossEnv = npsUtils.crossEnv
 
 module.exports = {
   scripts: {
@@ -16,39 +17,40 @@ module.exports = {
         script: 'all-contributors generate',
       },
     },
-    commit: {
-      description: 'This uses commitizen to help us generate well formatted commit messages',
-      script: 'git-cz',
-    },
     test: {
-      default: 'jest --coverage',
-      watch: 'jest --watch',
+      default: crossEnv('NODE_ENV=test jest --coverage'),
+      update: crossEnv('NODE_ENV=test jest --coverage --updateSnapshot'),
+      watch: crossEnv('NODE_ENV=test jest --watch'),
+      openCoverage: 'open coverage/lcov-report/index.html',
     },
     build: {
       description: 'delete the dist directory and run babel to build the files',
       script: series(
         rimraf('dist'),
-        'babel --copy-files --out-dir dist --ignore *.test.js,__mocks__ src'
+        'babel --copy-files --out-dir dist --ignore __tests__,__mocks__ src'
       ),
     },
     lint: {
       description: 'lint the entire project',
-      script: 'eslint .',
+      script: 'eslint . --cache',
     },
     reportCoverage: {
-      description: 'Report coverage stats to codecov. This should be run after the `test` script',
+      description:
+        'Report coverage stats to codecov. This should be run after the `test` script',
       script: 'codecov',
     },
     release: {
-      description: 'We automate releases with semantic-release. This should only be run on travis',
+      description:
+        'We automate releases with semantic-release. This should only be run on travis',
       script: series(
         'semantic-release pre',
         'npm publish',
         'semantic-release post'
       ),
     },
     validate: {
-      description: 'This runs several scripts to make sure things look good before committing or on clean install',
+      description:
+        'This runs several scripts to make sure things look good before committing or on clean install',
       script: concurrent.nps('lint', 'build', 'test'),
     },
     format: {

package.json

@@ -6,9 +6,7 @@
   "scripts": {
     "start": "nps",
     "test": "nps test",
-    "commitmsg": "opt --in commit-msg --exec \"validate-commit-msg\"",
-    "precommit": "opt --in pre-commit --exec \"npm start validate\"",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "precommit": "opt --in pre-commit --exec \"npm start validate\""
   },
   "files": [
     "dist"
@@ -19,70 +17,36 @@
   "dependencies": {
     "common-tags": "^1.4.0",
     "dlv": "^1.1.0",
-    "eslint": "^3.19.0",
-    "indent-string": "^3.1.0",
+    "eslint": "^4.5.0",
+    "indent-string": "^3.2.0",
     "lodash.merge": "^4.6.0",
     "loglevel-colored-level-prefix": "^1.0.0",
-    "prettier": "^1.5.0",
+    "prettier": "^1.6.0",
     "pretty-format": "^20.0.3",
     "require-relative": "^0.8.7"
   },
   "devDependencies": {
-    "all-contributors-cli": "^4.3.0",
-    "babel-cli": "^6.24.1",
+    "all-contributors-cli": "^4.4.0",
+    "babel-cli": "^6.26.0",
     "babel-jest": "^20.0.3",
-    "babel-polyfill": "^6.16.0",
-    "babel-preset-env": "^1.5.1",
+    "babel-polyfill": "^6.26.0",
+    "babel-preset-env": "^1.6.0",
     "babel-preset-stage-2": "^6.24.1",
-    "babel-register": "^6.24.1",
-    "chalk": "^1.1.3",
-    "codecov": "^2.2.0",
-    "commitizen": "^2.8.6",
-    "cz-conventional-changelog": "^2.0.0",
-    "eslint-config-kentcdodds": "^12.4.1",
-    "husky": "^0.13.4",
+    "babel-register": "^6.26.0",
+    "chalk": "^2.1.0",
+    "eslint-config-kentcdodds": "^12.4.2",
+    "husky": "^0.14.3",
     "jest-cli": "^20.0.4",
-    "nps": "^5.3.1",
-    "nps-utils": "^1.2.0",
-    "opt-cli": "^1.5.1",
-    "prettier-eslint-cli": "^4.0.3",
+    "nps": "^5.7.1",
+    "nps-utils": "^1.3.0",
+    "opt-cli": "^1.5.2",
+    "prettier-eslint-cli": "^4.2.1",
     "rimraf": "^2.5.4",
-    "semantic-release": "^6.3.2",
-    "strip-indent": "^2.0.0",
-    "validate-commit-msg": "^2.12.1"
+    "strip-indent": "^2.0.0"
   },
   "engines": {
     "node": ">=4.0.0"
   },
-  "eslintConfig": {
-    "extends": [
-      "kentcdodds",
-      "kentcdodds/jest"
-    ],
-    "rules": {
-      "valid-jsdoc": 0,
-      "max-len": [
-        2,
-        80
-      ]
-    }
-  },
-  "jest": {
-    "testEnvironment": "jest-environment-node",
-    "coverageThreshold": {
-      "global": {
-        "branches": 100,
-        "functions": 100,
-        "lines": 100,
-        "statements": 100
-      }
-    }
-  },
-  "config": {
-    "commitizen": {
-      "path": "node_modules/cz-conventional-changelog"
-    }
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/prettier/prettier-eslint.git"

src/__mocks__/eslint.js

@@ -18,14 +18,11 @@ module.exports = Object.assign(eslint, {
 
 function MockCLIEngine(...args) {
   global.__PRETTIER_ESLINT_TEST_STATE__.eslintPath = __filename
-  CLIEngine.apply(this, args)
-  // not sure why, but in some cases, this.executeOnText is undefined...
-  // so we create a fakeCLIEngine to get a copy of that function
-  // and call it with apply :)
-  const fakeCLIEngine = new CLIEngine(...args)
-  this.getConfigForFile = mockGetConfigForFileSpy
-  this._originalExecuteOnText = fakeCLIEngine.executeOnText
-  this.executeOnText = mockExecuteOnTextSpy
+  const cliEngine = new CLIEngine(...args)
+  cliEngine.getConfigForFile = mockGetConfigForFileSpy
+  cliEngine._originalExecuteOnText = cliEngine.executeOnText
+  cliEngine.executeOnText = mockExecuteOnTextSpy
+  return cliEngine
 }
 
 MockCLIEngine.prototype = Object.create(CLIEngine.prototype)