Explicitly specify ESLint config path for editor plugins in package.json

[keyz]

Fixes#124. Notice that we need to change the path in package.json while ejecting since the config folder gets moved.

Tested with Atom (Nuclide) and Visual Studio Code and it works both before and after ejection. I'm not sure about Sublime Text -- seems like SublimeLinter-eslint only recognizes .eslintrc config. However, it could be fixed by configuring the linter plugin itself. Or even better, could someone who uses Sublime Text send a PR to let it recognize the eslintConfig field in package.json? :)

Edit: @kevinastone confirmed that Sublime Text works fine too.

[mxstbr]

Awesome! 👍

[eanplatter]

I might be totally wrong, but is it safe to use / since it's possible to be \ on windows? I think path.resolve works cross platform.

[keyz]

Thanks @eanplatter, I didn't notice that!

However, path.resolve produces an absolute path which is probably not what we want here (what if the user moves or renames the project folder?).

How about changing it to path.normalize('./') + path.normalize('config/eslint.js')? The first ./ (.\\ on windows) is required since Atom doesn't work without it.

[keyz]

@insin could you help to confirm if this is an issue on windows? Thanks!

[gaearon]

I actually think it won't be, Node fs functions treat / in platform independent way. I wrote some unnecessary path.joins in the code before I learned this.

[insin]

Yeah, / is fine in Node.js as an input path like this.

You only get problems if you're doing path stuff manually with / and you might have a path which has been made "native" by converting it to absolute or relative with path (which is why checking an absolute path with a RegExp can be a gotcha - 🎵 Gotta [\\/] 'Em All, Pathémon 🎵)

[eanplatter]

Awesome, thanks for clearing that up for me!

[kevinastone]

Sublime Text works as well with the eslintConfig within the package.json.

[gaearon]

Let’s remove unnecessary ./node_modules/ and I think this is good to go.

[keyz]

@gaearon haha i was just about to reply to you -- it doesn't work without ./node_modules/, at least for Nuclide. I think the issue here is editor plugins resolve the config file themselves and they might not actually use node's resolve.

[gaearon]

Oh okay then.

[gaearon]

Thanks.

[mareksuscak]

FYI: I know this has already been merged but it only works when you install eslint and all the plugins globally. AFAIK it's a good rule of thumb to install all the dependencies locally per project.

[weisjohn]

I'm trying to use this, and even when installing globally as @mareksuscak mentioned, I get an error in Atom:

ESLint
Error
Fatal Parsing error: The keyword 'import' is reservedat line 1 col 1
File 1Project 11 Issuesrc/App.js22:1
LFUTF-8JavaScriptfeature/boilerplate2+22
Error: Failed to load plugin react: Cannot find module 'eslint-plugin-react' Referenced from: /Users/john/mysrc/create-test/package.json
Error: Failed to load plugin react: Cannot find module 'eslint-plugin-react'
Referenced from: /Users/john/mysrc/create-test/package.json
at Function.Module._resolveFilename (module.js:338:15)
at Function.Module._load (module.js:289:25)
at Module.require (module.js:366:17)
at require (module.js:385:17)
at Object.module.exports.load (/Users/john/.atom/packages/linter-eslint/node_modules/eslint/lib/config/plugins.js:114:26)
at Array.forEach (native)
at Object.module.exports.loadAll (/Users/john/.atom/packages/linter-eslint/node_modules/eslint/lib/config/plugins.js:136:21)
at load (/Users/john/.atom/packages/linter-eslint/node_modules/eslint/lib/config/config-file.js:505:21)
at /Users/john/.atom/packages/linter-eslint/node_modules/eslint/lib/config/config-file.js:392:36
at Array.reduceRight (native)

[weisjohn]

If I symlink eslint.js -> node_modules/react-scripts/config/eslint.js and install eslint, eslint-plugin-react, and babel-eslint, things and then modify my package.json accordingly:

 "eslintConfig": {
"extends": "./eslint.js"
}

then all is well.

[keyz]

@mareksuscak sorry just saw this. I don't have a global ESLint or ESLint plugins installed and my Nuclide/Visual Studio Code works fine. Could you tell me more about your experience (editor, plugin, setup, etc.)? Thanks.

Edit: sorry you're right! Please track #247.

[gaearon]

@weisjohn Are you using npm 3? The fix would only work with it.

[weisjohn]

@gaearon

$ node -v && npm -v
v5.12.0
3.8.6