Merge pull request #132 from benmosher/jsnext

benmosher · benmosher · commit a44341b40428 · 2015-11-30T20:27:52.000-05:00
jsnext:main
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,7 @@ build/Release
 # Commenting this out is preferred by some people, see
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
 node_modules
+!tests/**/node_modules/
 
 # Users Environment Variables
 .lock-wscript
diff --git a/.npmignore b/.npmignore
@@ -1,11 +1,11 @@
 # files
-src/
 reports/
 resolvers/
 
 # config
 .eslintrc
 .travis.yml
+appveyor.yml
 .editorconfig
 .gitignore
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -2,11 +2,12 @@
 environment:
   NODE_PATH: ./lib
   # NODE_PATH: ./lib
-  matrix:
-  - nodejs_version: "0.10"
-  - nodejs_version: "0.12"
-  - nodejs_version: "4"
-  - nodejs_version: "5"
+  nodejs_version: "4"
+  # killing build matrix in the interest of turnaround time
+  # matrix:
+  # - nodejs_version: "0.10"
+  # - nodejs_version: "0.12"
+  # - nodejs_version: "5"
 
   # - nodejs_version: "2"
 
diff --git a/package.json b/package.json
@@ -42,11 +42,12 @@
     "chai": "^3.4.0",
     "coveralls": "^2.11.4",
     "eslint": ">=1.8.0",
+    "eslint-import-resolver-node": "file:./resolvers/node",
+    "eslint-import-resolver-webpack": "file:./resolvers/webpack",
     "istanbul": "^0.4.0",
     "mocha": "^2.2.1",
-    "remap-istanbul": "^0.4.0",
-    "eslint-import-resolver-webpack": "file:./resolvers/webpack",
-    "eslint-import-resolver-node": "file:./resolvers/node"
+    "redux": "^3.0.4",
+    "remap-istanbul": "^0.4.0"
   },
   "peerDependencies": {
     "eslint": ">=1.4.0"
diff --git a/resolvers/node/index.js b/resolvers/node/index.js
@@ -9,9 +9,18 @@ exports.resolveImport = function resolveImport(source, file, config) {
 }
 
 function opts(basedir, config) {
-  return assign( {}
-               , config
-               , { basedir: basedir }
-               )
+  return assign({},
+    config,
+    {
+      basedir: basedir,
+      packageFilter: packageFilter,
+
+    })
 }
 
+function packageFilter(pkg) {
+  if (pkg['jsnext:main']) {
+    pkg['main'] = pkg['jsnext:main']
+  }
+  return pkg
+}
diff --git a/resolvers/node/package.json b/resolvers/node/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-import-resolver-node",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Node default behavior import resolution plugin for eslint-plugin-import.",
   "main": "index.js",
   "scripts": {
diff --git a/resolvers/webpack/index.js b/resolvers/webpack/index.js
@@ -2,6 +2,7 @@ var findRoot = require('find-root')
   , path = require('path')
   , resolve = require('resolve')
   , get = require('lodash.get')
+  , find = require('array-find')
 
 var resolveAlias = require('./resolve-alias')
 
@@ -60,6 +61,7 @@ exports.resolveImport = function resolveImport(source, file, settings) {
       || ['web_modules', 'node_modules'],
 
     paths: paths,
+    packageFilter: packageFilter.bind(null, webpackConfig),
   })
 }
 
@@ -85,3 +87,32 @@ function findExternal(source, externals) {
   // else, vanilla object
   return Object.keys(externals).some(function (e) { return source === e })
 }
+
+/**
+ * webpack defaults: http://webpack.github.io/docs/configuration.html#resolve-packagemains
+ * @type {Array}
+ */
+var defaultMains = [
+  'webpack', 'browser', 'web', 'browserify', ['jam', 'main'], 'main',
+]
+
+function packageFilter(config, pkg) {
+  var altMain
+
+  // check for rollup-style first
+  if (pkg['jsnext:main']) {
+    pkg['main'] = pkg['jsnext:main']
+  } else {
+    // check for configured/default alternative main fields
+    altMain = find(
+      get(config, ['resolve', 'packageMains']) || defaultMains,
+      function (m) { return typeof get(pkg, m) === 'string' })
+
+    if (altMain) {
+      pkg['main'] = get(pkg, altMain)
+    }
+  }
+
+
+  return pkg
+}
diff --git a/resolvers/webpack/package.json b/resolvers/webpack/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-import-resolver-webpack",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Resolve paths to dependencies, given a webpack.config.js. Plugin for eslint-plugin-import.",
   "main": "index.js",
   "scripts": {
@@ -24,6 +24,7 @@
   },
   "homepage": "https://github.com/benmosher/eslint-plugin-import#readme",
   "dependencies": {
+    "array-find": "^1.0.0",
     "find-root": "^0.1.1",
     "lodash.get": "^3.7.0",
     "resolve": "^1.1.6"
diff --git a/resolvers/webpack/test/package-mains/jam/index.js b/resolvers/webpack/test/package-mains/jam/index.js
diff --git a/resolvers/webpack/test/package-mains/jam/jam.js b/resolvers/webpack/test/package-mains/jam/jam.js
diff --git a/resolvers/webpack/test/package-mains/jam/package.json b/resolvers/webpack/test/package-mains/jam/package.json
@@ -0,0 +1,4 @@
+{
+  "jam": { "main": "jam.js" },
+  "main": "index.js"
+}
diff --git a/resolvers/webpack/test/package-mains/jsnext/package.json b/resolvers/webpack/test/package-mains/jsnext/package.json
@@ -0,0 +1,4 @@
+{
+  "main": "lib/index.js",
+  "jsnext:main": "src/index.js"
+}
diff --git a/resolvers/webpack/test/package-mains/jsnext/src/index.js b/resolvers/webpack/test/package-mains/jsnext/src/index.js
diff --git a/resolvers/webpack/test/package-mains/package.json b/resolvers/webpack/test/package-mains/package.json
@@ -0,0 +1 @@
+{ "dummy": true }
diff --git a/resolvers/webpack/test/package-mains/webpack.alt.config.js b/resolvers/webpack/test/package-mains/webpack.alt.config.js
@@ -0,0 +1,3 @@
+exports.resolve = {
+  packageMains: ["main"], // override
+}
diff --git a/resolvers/webpack/test/package-mains/webpack.config.js b/resolvers/webpack/test/package-mains/webpack.config.js
diff --git a/resolvers/webpack/test/package-mains/webpack/index.js b/resolvers/webpack/test/package-mains/webpack/index.js
diff --git a/resolvers/webpack/test/package-mains/webpack/package.json b/resolvers/webpack/test/package-mains/webpack/package.json
@@ -0,0 +1,4 @@
+{
+  "webpack": "webpack.js",
+  "main": "index.js"
+}
diff --git a/resolvers/webpack/test/package-mains/webpack/webpack.js b/resolvers/webpack/test/package-mains/webpack/webpack.js
diff --git a/resolvers/webpack/test/packageMains.js b/resolvers/webpack/test/packageMains.js
@@ -0,0 +1,37 @@
+var chai = require('chai')
+  , expect = chai.expect
+  , path = require('path')
+
+var webpack = require('../')
+
+var file = path.join(__dirname, 'package-mains', 'dummy.js')
+
+
+describe("packageMains", function () {
+
+  it("captures jsnext", function () {
+    expect(webpack.resolveImport('./jsnext', file))
+      .to.equal(path.join(__dirname, 'package-mains', 'jsnext', 'src', 'index.js'))
+  })
+
+  it("captures webpack", function () {
+    expect(webpack.resolveImport('./webpack', file))
+      .to.equal(path.join(__dirname, 'package-mains', 'webpack', 'webpack.js'))
+  })
+
+  it("captures jam (array path)", function () {
+    expect(webpack.resolveImport('./jam', file))
+      .to.equal(path.join(__dirname, 'package-mains', 'jam', 'jam.js'))
+  })
+
+  it("uses configured packageMains, if provided", function () {
+    expect(webpack.resolveImport('./webpack', file, { config: 'webpack.alt.config.js' }))
+      .to.equal(path.join(__dirname, 'package-mains', 'webpack', 'index.js'))
+  })
+
+  it("always defers to jsnext:main, regardless of config", function () {
+    expect(webpack.resolveImport('./jsnext', file, { config: 'webpack.alt.config.js' }))
+      .to.equal(path.join(__dirname, 'package-mains', 'jsnext', 'src', 'index.js'))
+  })
+
+})
diff --git a/src/core/getExports.js b/src/core/getExports.js
@@ -25,14 +25,13 @@ export default class ExportMap {
   static get(source, context) {
 
     var path = resolve(source, context)
-    if (path == null || isIgnored(path, context)) return null
+    if (path == null) return null
 
     return ExportMap.for(path, context)
   }
 
   static for(path, context) {
     let exportMap
-    const stats = fs.statSync(path)
 
     const cacheKey = hashObject(context.settings)
     let exportCache = exportCaches.get(cacheKey)
@@ -42,6 +41,10 @@ export default class ExportMap {
     }
 
     exportMap = exportCache.get(path)
+    // return cached ignore
+    if (exportMap === null) return null
+
+    const stats = fs.statSync(path)
     if (exportMap != null) {
       // date equality check
       if (exportMap.mtime - stats.mtime === 0) {
@@ -51,9 +54,14 @@ export default class ExportMap {
     }
 
     exportMap = ExportMap.parse(path, context)
+    exportMap.mtime = stats.mtime
+
+    // ignore empties, optionally
+    if (exportMap.named.size === 0 && isIgnored(path, context)) {
+      exportMap = null
+    }
 
     exportCache.set(path, exportMap)
-    exportMap.mtime = stats.mtime
 
     return exportMap
   }
diff --git a/tests/files/node_modules/a/index.js b/tests/files/node_modules/a/index.js
diff --git a/tests/files/node_modules/es6-module/index.js b/tests/files/node_modules/es6-module/index.js
diff --git a/tests/src/rules/named.js b/tests/src/rules/named.js
@@ -32,8 +32,6 @@ ruleTester.run('named', rule, {
 
     test({ code: 'import { foo, bar } from "./common"'
          , settings: { 'import/ignore': ['common'] } }),
-    test({ code: 'import { baz } from "./bar"'
-         , settings: { 'import/ignore': ['bar'] } }),
 
     // ignore core modules by default
     test({ code: 'import { foo } from "crypto"' }),
@@ -44,11 +42,6 @@ ruleTester.run('named', rule, {
     // node_modules/a only exports 'foo', should be ignored though
     test({ code: 'import { zoob } from "a"' }),
 
-    // parses / correctly verifies if settings remove node_modules
-    // from ignore list
-    test({ code: 'import { foo } from "a"'
-         , settings: { 'import/ignore': [] } }),
-
     // export tests
     test({ code: 'export { foo } from "./bar"' }),
     test({ code: 'export { foo as bar } from "./bar"' }),
@@ -83,6 +76,19 @@ ruleTester.run('named', rule, {
       settings: { 'import/parse-options': { plugins: [ 'flow' ] } },
     }),
 
+    // jsnext
+    test({
+      code: '/*jsnext*/ import { createStore } from "redux"',
+      settings: { 'import/ignore': [] },
+    }),
+    // should work without ignore
+    test({
+      code: '/*jsnext*/ import { createStore } from "redux"',
+    }),
+
+    // ignore is ignored if exports are found
+    test({ code: 'import { foo } from "es6-module"' }),
+
   ],
 
   invalid: [
@@ -164,5 +170,28 @@ ruleTester.run('named', rule, {
         message: "MissingType not found in './flowtypes'",
         type: 'Identifier',
       }]}),
+
+    // jsnext
+    test({
+      code: '/*jsnext*/ import { createSnorlax } from "redux"',
+      settings: { 'import/ignore': [] },
+      errors: ["createSnorlax not found in 'redux'"],
+    }),
+    // should work without ignore
+    test({
+      code: '/*jsnext*/ import { createSnorlax } from "redux"',
+      errors: ["createSnorlax not found in 'redux'"],
+    }),
+
+    // ignore is ignored if exports are found
+    test({
+      code: 'import { baz } from "es6-module"',
+      errors: ["baz not found in 'es6-module'"],
+    }),
+    test({
+      code: 'import { baz } from "./bar"',
+      settings: { 'import/ignore': ['bar'] },
+      errors: ["baz not found in './bar'"],
+    }),
   ],
 })

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-import-resolver-node",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.1.1",`
`4`	`4`	`"description": "Node default behavior import resolution plugin for eslint-plugin-import.",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"scripts": {`