eslint-module-utils: filePath in parserOptions

CHANGELOG.md

@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
 - [`no-anonymous-default-export`] rule: report anonymous default exports ([#712], thanks [@duncanbeevers]).
 - Add new value to [`order`]'s `newlines-between` option to allow newlines inside import groups ([#627], [#628], thanks [@giodamelio])
 - Add `count` option to the [`newline-after-import`] rule to allow configuration of number of newlines expected ([#742], thanks [@ntdb])
+- Add `filePath` into `parserOptions` passed to `parser` ([#839], thanks [@sompylasar])
 
 ### Changed
 - [`no-extraneous-dependencies`]: use `read-pkg-up` to simplify finding + loading `package.json` ([#680], thanks [@wtgtybhertgeghgtwtg])

package.json

@@ -81,7 +81,7 @@
     "debug": "^2.2.0",
     "doctrine": "1.5.0",
     "eslint-import-resolver-node": "^0.2.0",
-    "eslint-module-utils": "^2.0.0",
+    "eslint-module-utils": "^2.1.0",
     "has": "^1.0.1",
     "lodash.cond": "^4.3.0",
     "minimatch": "^3.0.3",

tests/src/core/parse.js

@@ -2,7 +2,7 @@ import * as fs from 'fs'
 import { expect } from 'chai'
 import parse from 'eslint-module-utils/parse'
 
-import { getFilename } from '../utils'
+import { getFilename, makeNaiveSpy } from '../utils'
 
 describe('parse(content, { settings, ecmaFeatures })', function () {
   const path = getFilename('jsx.js')
@@ -21,4 +21,21 @@ describe('parse(content, { settings, ecmaFeatures })', function () {
       .not.to.throw(Error)
   })
 
+  it('passes expected parserOptions to custom parser', function () {
+    const parseSpy = makeNaiveSpy()
+    const parserOptions = { ecmaFeatures: { jsx: true } }
+    require('./parseStubParser').parse = parseSpy
+    parse(path, content, { settings: {}, parserPath: require.resolve('./parseStubParser'), parserOptions: parserOptions })
+    expect(parseSpy.callCount).to.equal(1)
+    expect(parseSpy.lastCallArguments[0]).to.equal(content)
+    expect(parseSpy.lastCallArguments[1]).to.be.an('object')
+    expect(parseSpy.lastCallArguments[1]).to.not.equal(parserOptions)
+    expect(parseSpy.lastCallArguments[1])
+      .to.have.property('ecmaFeatures')
+        .that.is.eql(parserOptions.ecmaFeatures)
+        .and.is.not.equal(parserOptions.ecmaFeatures)
+    expect(parseSpy.lastCallArguments[1]).to.have.property('attachComment', true)
+    expect(parseSpy.lastCallArguments[1]).to.have.property('filePath', path)
+  })
+
 })

tests/src/core/parseStubParser.js

@@ -0,0 +1,4 @@
+// this stub must be in a separate file to require from parse via moduleRequire
+module.exports = {
+  parse: function () {},
+}

tests/src/utils.js

@@ -28,6 +28,20 @@ export function getFilename(file) {
   return path.join(__dirname, '..', 'files', file || 'foo.js')
 }
 
+/**
+ * naive implementation of a function spy
+ * for more robust spy, consider replacing with sinon or chai-spies
+ * @return {function}
+ */
+export function makeNaiveSpy() {
+  const spy = function () {
+    spy.callCount += 1
+    spy.lastCallArguments = arguments
+  }
+  spy.callCount = 0
+  return spy
+}
+
 /**
  * to be added as valid cases just to ensure no nullable fields are going
  * to crash at runtinme

utils/CHANGELOG.md

@@ -3,9 +3,13 @@ All notable changes to this module will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 This change log adheres to standards from [Keep a CHANGELOG](http://keepachangelog.com).
 
-## v2 - 2016-11-07
+## v2.1.0 - 2017-05-20
+### Added
+- `parse` now additionally passes `filePath` to `parser` in `parserOptions` like `eslint` core does
+
+## v2.0.0 - 2016-11-07
 ### Changed
 - `unambiguous` no longer exposes fast test regex
 
 ### Fixed
-- `unambiguous.test()` regex is now properly in multiline mode
+- `unambiguous.test()` regex is now properly in multiline mode

utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-module-utils",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Core utilities to support eslint-plugin-import and other module-related plugins.",
   "engines": {
     "node": ">=4"

utils/parse.js

@@ -22,6 +22,10 @@ exports.default = function parse(path, content, context) {
   // always attach comments
   parserOptions.attachComment = true
 
+  // provide the `filePath` like eslint itself does, in `parserOptions`
+  // https://github.com/eslint/eslint/blob/3ec436ee/lib/linter.js#L637
+  parserOptions.filePath = path
+
   // require the parser relative to the main module (i.e., ESLint)
   const parser = moduleRequire(parserPath)