ESLint-4 prettier support.

[aichholzer]

Actual Behavior

My .codeclimate.yml file:

version: "2"
plugins:
  eslint:
    enabled: true
    channel: "eslint-4"
exclude_patterns:
  - "**.json"
  - "**.md"
  - "**.yml"

when trying to run codeclimate's analysis it fails:

/usr/src/app/lib/validate_config.js:18
        throw e;
        ^

TypeError: Cannot read property 'recommended' of undefined
Referenced from: /code/.eslintrc.json
    at loadConfigFile (/usr/local/node_modules/eslint/lib/config/config-file.js:211:40)
    at loadFromDisk (/usr/local/node_modules/eslint/lib/config/config-file.js:486:18)
    at load (/usr/local/node_modules/eslint/lib/config/config-file.js:550:20)
    at configExtends.reduceRight.e (/usr/local/node_modules/eslint/lib/config/config-file.js:421:36)
    at Array.reduceRight (native)
    at applyExtends (/usr/local/node_modules/eslint/lib/config/config-file.js:403:28)
    at loadFromDisk (/usr/local/node_modules/eslint/lib/config/config-file.js:514:22)
    at Object.load (/usr/local/node_modules/eslint/lib/config/config-file.js:550:20)
    at Config.getLocalConfigHierarchy (/usr/local/node_modules/eslint/lib/config.js:228:44)
    at Config.getConfigHierarchy (/usr/local/node_modules/eslint/lib/config.js:180:43)

This is the failing build.

Expected Behavior

It should run normally and pass, since according to this, you do support eslint-config-prettier, eslint-plugin-prettier and prettier in your ESLint-4 channel

Steps to reproduce

This is happening on the master branch, therefore, please feel free to fork it. Perhaps you want to take a look at the package.json file.

[aichholzer]

@toddmazierski -I also tried the stable and eslint-3 channels and the issue remains the same.

[toddmazierski]

Hi, @aichholzer! Sorry for the delay in getting back to you. I think there might be a syntax error in your .eslintrc. Mind trying the following change?

diff --git a/.eslintrc.json b/.eslintrc.json
index 226c7a7..589a212 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -3,7 +3,7 @@
     "es6": true,
     "mocha": true
   },
-  "extends": ["airbnb-base", "plugin:prettier/recommended"],
+  "extends": ["airbnb-base", "prettier/recommended"],
   "plugins": ["import", "prettier"],
   "rules": {
     "arrow-parens": ["error", "always"],

[aichholzer]

Hello @toddmazierski -Thank you for that and no worries for the delay.
I did not think it was a typo as it is the recommended configuration for the plug-in.

I did, however, try your suggestion which gave me an error locally when running npm test.

Cannot find module 'eslint-config-prettier/recommended'
Referenced from: .eslintrc.json

Any other suggestions?

[VictorKid]

@toddmazierski I also have the same issue,

this is my .eslintrc

{
  "parser": "babel-eslint",
  "extends": [
    "eslint:recommended",
    "plugin:prettier/recommended",
    "plugin:react/recommended"
  ],
  "rules": {
    "no-console": 0,
    "react/react-in-jsx-scope": "off"
  },
  "env": {
    "browser": true,
    "node": true,
    "es6": true,
    "jest": true
  }
}

this is .codeclimate.yml

version: "2"
plugins: 
  eslint:
    enabled: true
    channel: "eslint-4"
exclude_paths:
- "static/"
- "**/*-test.js"
- "src/config/"

[toddmazierski]

My apologies, @aichholzer—I was getting eslint-config-prettier and eslint-plugin-prettier mixed up. 🤦‍♂️

It looks like the version of eslint-plugin-prettier we currently support is 2.3.1:

codeclimate-eslint/package.json

Line 58 in c3494b8

"eslint-plugin-prettier": "2.3.1",

The installation recommendation for this version is slightly different than the one you linked to. Mind trying this change instead?

diff --git a/.eslintrc.json b/.eslintrc.json
index 226c7a7..7fd14c4 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -3,7 +3,7 @@
     "es6": true,
     "mocha": true
   },
-  "extends": ["airbnb-base", "plugin:prettier/recommended"],
+  "extends": ["airbnb-base"],
   "plugins": ["import", "prettier"],
   "rules": {
     "arrow-parens": ["error", "always"],

[aichholzer]

@toddmazierski -Absolutely no worries, I appreciate you digging into this issue with me.
I made the new change you suggested and I got another error, from ESLint this time;

Unexpected newline between object and [ of property access  no-unexpected-multiline

The newline, however, is what prettier expects. Removing the plugin extension from the .eslintrc.json file is ignoring prettier in the linting process.

I also tried downgrading the version of the plugin I am using to 2.3.1 and making your suggested change, but I still got the same issue.

I guess I will just hold my horses with this until you guys upgrade the version you support.

[VictorKid]

@toddmazierski is it possible to upgrade eslint-config-prettier and eslint-plugin-prettier, to support "extends": ["plugin:prettier/recommended"]

[toddmazierski]

@aichholzer, interesting! Are you able to reproduce this with the codeclimate CLI and/or on the website? I've been using the CLI to reproduce and test the suggested changes.

Without the change

codeclimate analyze -e eslint
Starting analysis
Running eslint: Done!
error: (CC::CLI::Analyze::EngineFailure) engine eslint failed with status 1 and stderr
/usr/src/app/lib/validate_config.js:18
        throw e;
        ^

TypeError: Cannot read property 'recommended' of undefined
Referenced from: /code/.eslintrc.json
    at loadConfigFile (/usr/local/node_modules/eslint/lib/config/config-file.js:211:40)
    at loadFromDisk (/usr/local/node_modules/eslint/lib/config/config-file.js:486:18)
    at load (/usr/local/node_modules/eslint/lib/config/config-file.js:550:20)
    at configExtends.reduceRight.e (/usr/local/node_modules/eslint/lib/config/config-file.js:421:36)
    at Array.reduceRight (native)
    at applyExtends (/usr/local/node_modules/eslint/lib/config/config-file.js:403:28)
    at loadFromDisk (/usr/local/node_modules/eslint/lib/config/config-file.js:514:22)
    at Object.load (/usr/local/node_modules/eslint/lib/config/config-file.js:550:20)
    at Config.getLocalConfigHierarchy (/usr/local/node_modules/eslint/lib/config.js:228:44)
    at Config.getConfigHierarchy (/usr/local/node_modules/eslint/lib/config.js:180:43)

With the change I last suggested

codeclimate analyze -e eslint
Starting analysis
Running eslint: Done!

== app/index.js (1 issue) ==
35: Replace `(error)` with `error` [eslint]

== app/lib/parse.js (2 issues) ==
7: Replace `(data)` with `data` [eslint]
24: Replace `(req)` with `req` [eslint]

…

Analysis complete! Found 95 issues.

Without the prettier plugin at all

codeclimate analyze -e eslint
Starting analysis
Running eslint: Done!

== app/streams/response.js (1 issue) ==
40: Unexpected newline between object and [ of property access. [eslint]

Analysis complete! Found 1 issue.

[aichholzer]

@toddmazierski -I am running my tests on the Codeclimate site and locally just using npm test (which runs ESLint and Prettier as part of the pipeline).

• The first error is exactly the same one I get, where it seems the prettier plugin cannot extend what it needs; plugin:prettier/recommended.

• The second error, after your suggested change, is ignoring the Prettier config completely, which is making ESLint complain. My Prettier config:

  "prettier/prettier": [
    "error",
    {
      "semi": true,
      "printWidth": 100,
      "singleQuote": true,
      "arrowParens": "always"
    }
   ]

  ESLint ignores "arrowParens": "always" setting when running. This error, however, should not even appear since the .eslintrc file has the "arrow-parens": ["error", "always"] rule. Interestingly strange... 🤔

• And the third error is from ESLint failing on something the Prettier format does on file save. The strange thing here is that in this case ESLint did respect the "arrow-parens": ["error", "always"] rule as defined in the .eslintrc file.

Looks like there is a Ghost in the Machine doing it's thing around here.

Locally, I am running "eslint-plugin-prettier": "^2.6.0" and everything plays in unison and harmony. I don't think this is a Codeclimate issue, but rather due to the plugin version. Furthermore, I don't think it's worth to put all this effort into investigating where the culprit may be.

For the time being, I will take Codeclimate out of my pipeline and remain until you guys upgrade you support for this particular plugin.

So far, thank you very much @toddmazierski
(Feel free to close this issue at your discretion.)

👍

[toddmazierski]

@aichholzer, darn. Sorry that didn't help! I also suspect it's some incompatibility between these plugins.

For next steps, I'll close this particular issue, but also add upgrading (#351) to our work queue. It seems like that pull request has gone stale.

[vgrbr]

It seems that upgrading did not fix the problem with prettier. I'm still having the same issue :(