24516273

Build Type

push

appveyor

Committed by GitHub

Commit Message

<a href="https://github.com/benmosher/eslint-plugin-import/commit/<a class=hub.com/benmosher/eslint-plugin-import/commit/f6fe1403c725171c242325b44ec137905095c9e1">f6fe1403c<a href="https://github.com/benmosher/eslint-plugin-import/commit/f6fe1403c725171c242325b44ec137905095c9e1">">Merge </a><a class="double-link" href="https://github.com/benmosher/eslint-plugin-import/commit/<a class="double-link" href="https://github.com/benmosher/eslint-plugin-import/commit/b52bf3e16bf399c5cf0681c198a3b362e6e7484b">b52bf3e16</a>">b52bf3e16</a><a href="https://github.com/benmosher/eslint-plugin-import/commit/f6fe1403c725171c242325b44ec137905095c9e1"> into 2f85fbea4">2f85fbea4</a>

Run Details

1310 of 1436 branches covered (91.23%)

10 of 10 new or added lines in 1 file covered. (100.0%)

1904 of 1997 relevant lines covered (95.34%)

49.99 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.47

/src/ExportMap.js

import fs from 'fs'

import doctrine from 'doctrine'

import debug from 'debug'

import SourceCode from 'eslint/lib/util/source-code'

import parse from 'eslint-module-utils/parse'
import resolve from 'eslint-module-utils/resolve'
import isIgnored, { hasValidExtension } from 'eslint-module-utils/ignore'

import { hashObject } from 'eslint-module-utils/hash'
import * as unambiguous from 'eslint-module-utils/unambiguous'

const log = debug('eslint-plugin-import:ExportMap')

const exportCache = new Map()

export default class ExportMap {
  constructor(path) {
    this.path = path
    this.namespace = new Map()
    // todo: restructure to key on path, value is resolver + map of names
    this.reexports = new Map()
    /**
     * star-exports
     * @type {Set} of () => ExportMap
     */
    this.dependencies = new Set()
    /**
     * dependencies of this module that are not explicitly re-exported
     * @type {Map} from path = () => ExportMap
     */
    this.imports = new Map()
    this.errors = []
  }

  get hasDefault() { return this.get('default') != null } // stronger than this.has

  get size() {
    let size = this.namespace.size + this.reexports.size
    this.dependencies.forEach(dep => {
      const d = dep()
      // CJS / ignored dependencies won't exist (#717)
      if (d == null) return
      size += d.size
    })
    return size
  }

  /**
   * Note that this does not check explicitly re-exported names for existence
   * in the base namespace, but it will expand all `export * from '...'` exports
   * if not found in the explicit namespace.
   * @param  {string}  name
   * @return {Boolean} true if `name` is exported by this module.
   */
  has(name) {
    if (this.namespace.has(name)) return true
    if (this.reexports.has(name)) return true

    // default exports must be explicitly re-exported (#328)
    if (name !== 'default') {
      for (let dep of this.dependencies) {
        let innerMap = dep()

        // todo: report as unresolved?
        if (!innerMap) continue

        if (innerMap.has(name)) return true
      }
    }

    return false
  }

  /**
   * ensure that imported name fully resolves.
   * @param  {[type]}  name [description]
   * @return {Boolean}      [description]
   */
  hasDeep(name) {
    if (this.namespace.has(name)) return { found: true, path: [this] }

    if (this.reexports.has(name)) {
      const reexports = this.reexports.get(name)
          , imported = reexports.getImport()

      // if import is ignored, return explicit 'null'
      if (imported == null) return { found: true, path: [this] }

      // safeguard against cycles, only if name matches
      if (imported.path === this.path && reexports.local === name) {
        return { found: false, path: [this] }
      }

      const deep = imported.hasDeep(reexports.local)
      deep.path.unshift(this)

      return deep
    }


    // default exports must be explicitly re-exported (#328)
    if (name !== 'default') {
      for (let dep of this.dependencies) {
        let innerMap = dep()
        // todo: report as unresolved?
        if (!innerMap) continue

        // safeguard against cycles
        if (innerMap.path === this.path) continue

        let innerValue = innerMap.hasDeep(name)
        if (innerValue.found) {
          innerValue.path.unshift(this)
          return innerValue
        }
      }
    }

    return { found: false, path: [this] }
  }

  get(name) {
    if (this.namespace.has(name)) return this.namespace.get(name)

    if (this.reexports.has(name)) {
      const reexports = this.reexports.get(name)
          , imported = reexports.getImport()

      // if import is ignored, return explicit 'null'
      if (imported == null) return null

      // safeguard against cycles, only if name matches
      if (imported.path === this.path && reexports.local === name) return undefined

      return imported.get(reexports.local)
    }

    // default exports must be explicitly re-exported (#328)
    if (name !== 'default') {
      for (let dep of this.dependencies) {
        let innerMap = dep()
        // todo: report as unresolved?
        if (!innerMap) continue

        // safeguard against cycles
        if (innerMap.path === this.path) continue

        let innerValue = innerMap.get(name)
        if (innerValue !== undefined) return innerValue
      }
    }

    return undefined
  }

  forEach(callback, thisArg) {
    this.namespace.forEach((v, n) =>
      callback.call(thisArg, v, n, this))

    this.reexports.forEach((reexports, name) => {
      const reexported = reexports.getImport()
      // can't look up meta for ignored re-exports (#348)
      callback.call(thisArg, reexported && reexported.get(reexports.local), name, this)
    })

    this.dependencies.forEach(dep => {
      const d = dep()
      // CJS / ignored dependencies won't exist (#717)
      if (d == null) return

      d.forEach((v, n) =>
        n !== 'default' && callback.call(thisArg, v, n, this))
    })
  }

  // todo: keys, values, entries?

  reportErrors(context, declaration) {
    context.report({
      node: declaration.source,
      message: `Parse errors in imported module '${declaration.source.value}': ` +
                  `${this.errors
                        .map(e => `${e.message} (${e.lineNumber}:${e.column})`)
                        .join(', ')}`,
    })
  }
}

/**
 * parse docs from the first node that has leading comments
 */
function captureDoc(source, docStyleParsers, ...nodes) {
  const metadata = {}

  // 'some' short-circuits on first 'true'
  nodes.some(n => {
    try {

      let leadingComments

      // n.leadingComments is legacy `attachComments` behavior
      if ('leadingComments' in n) {
        leadingComments = n.leadingComments
      } else if (n.range) {
        leadingComments = source.getCommentsBefore(n)
      }

      if (!leadingComments || leadingComments.length === 0) return false

      for (let name in docStyleParsers) {
        const doc = docStyleParsers[name](leadingComments)
        if (doc) {
          metadata.doc = doc
        }
      }

      return true
    } catch (err) {
      return false
    }
  })

  return metadata
}

const availableDocStyleParsers = {
  jsdoc: captureJsDoc,
  tomdoc: captureTomDoc,
}

/**
 * parse JSDoc from leading comments
 * @param  {...[type]} comments [description]
 * @return {{doc: object}}
 */
function captureJsDoc(comments) {
  let doc

  // capture XSDoc
  comments.forEach(comment => {
    // skip non-block comments
    if (comment.type !== 'Block') return
    try {
      doc = doctrine.parse(comment.value, { unwrap: true })
    } catch (err) {
      /* don't care, for now? maybe add to `errors?` */
    }
  })

  return doc
}

/**
  * parse TomDoc section from comments
  */
function captureTomDoc(comments) {
  // collect lines up to first paragraph break
  const lines = []
  for (let i = 0; i < comments.length; i++) {
    const comment = comments[i]
    if (comment.value.match(/^\s*$/)) break
    lines.push(comment.value.trim())
  }

  // return doctrine-like object
  const statusMatch = lines.join(' ').match(/^(Public|Internal|Deprecated):\s*(.+)/)
  if (statusMatch) {
    return {
      description: statusMatch[2],
      tags: [{
        title: statusMatch[1].toLowerCase(),
        description: statusMatch[2],
      }],
    }
  }
}

ExportMap.get = function (source, context) {
  const path = resolve(source, context)
  if (path == null) return null

  return ExportMap.for(childContext(path, context))
}

ExportMap.for = function (context) {
  const { path } = context

  const cacheKey = hashObject(context).digest('hex')
  let exportMap = exportCache.get(cacheKey)

  // 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) {
      return exportMap
    }
    // future: check content equality?
  }

  // check valid extensions first
  if (!hasValidExtension(path, context)) {
    exportCache.set(cacheKey, null)
    return null
  }

  const content = fs.readFileSync(path, { encoding: 'utf8' })

  // check for and cache ignore
  if (isIgnored(path, context) || !unambiguous.test(content)) {
    log('ignored path due to unambiguous regex or ignore settings:', path)
    exportCache.set(cacheKey, null)
    return null
  }

  log('cache miss', cacheKey, 'for path', path)
  exportMap = ExportMap.parse(path, content, context)

  // ambiguous modules return null
  if (exportMap == null) return null

  exportMap.mtime = stats.mtime

  exportCache.set(cacheKey, exportMap)
  return exportMap
}


ExportMap.parse = function (path, content, context) {
  var m = new ExportMap(path)

  try {
    var ast = parse(path, content, context)
  } catch (err) {
    log('parse error:', path, err)
    m.errors.push(err)
    return m // can't continue
  }

  if (!unambiguous.isModule(ast)) return null

  const docstyle = (context.settings && context.settings['import/docstyle']) || ['jsdoc']
  const docStyleParsers = {}
  docstyle.forEach(style => {
    docStyleParsers[style] = availableDocStyleParsers[style]
  })

  // attempt to collect module doc
  if (ast.comments) {
    ast.comments.some(c => {
      if (c.type !== 'Block') return false
      try {
        const doc = doctrine.parse(c.value, { unwrap: true })
        if (doc.tags.some(t => t.title === 'module')) {
          m.doc = doc
          return true
        }
      } catch (err) { /* ignore */ }
      return false
    })
  }

  const namespaces = new Map()

  function remotePath(value) {
    return resolve.relative(value, path, context.settings)
  }

  function resolveImport(value) {
    const rp = remotePath(value)
    if (rp == null) return null
    return ExportMap.for(childContext(rp, context))
  }

  function getNamespace(identifier) {
    if (!namespaces.has(identifier.name)) return

    return function () {
      return resolveImport(namespaces.get(identifier.name))
    }
  }

  function addNamespace(object, identifier) {
    const nsfn = getNamespace(identifier)
    if (nsfn) {
      Object.defineProperty(object, 'namespace', { get: nsfn })
    }

    return object
  }

  function captureDependency(declaration) {
    if (declaration.source == null) return null
    const importedSpecifiers = new Set()
    const supportedTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier'])
    if (declaration.specifiers) {
      declaration.specifiers.forEach(specifier => {
        if (supportedTypes.has(specifier.type)) {
          importedSpecifiers.add(specifier.type)
        }
        if (specifier.type === 'ImportSpecifier') {
          importedSpecifiers.add(specifier.imported.name)
        }
      })
    }

    const p = remotePath(declaration.source.value)
    if (p == null) return null
    const existing = m.imports.get(p)
    if (existing != null) return existing.getter

    const getter = thunkFor(p, context)
    m.imports.set(p, {
      getter,
      source: {  // capturing actual node reference holds full AST in memory!
        value: declaration.source.value,
        loc: declaration.source.loc,
      },
      importedSpecifiers,
    })
    return getter
  }

  const source = makeSourceCode(content, ast)

  ast.body.forEach(function (n) {

    if (n.type === 'ExportDefaultDeclaration') {
      const exportMeta = captureDoc(source, docStyleParsers, n)
      if (n.declaration.type === 'Identifier') {
        addNamespace(exportMeta, n.declaration)
      }
      m.namespace.set('default', exportMeta)
      return
    }

    if (n.type === 'ExportAllDeclaration') {
      const getter = captureDependency(n)
      if (getter) m.dependencies.add(getter)
      return
    }

    // capture namespaces in case of later export
    if (n.type === 'ImportDeclaration') {
      captureDependency(n)
      let ns
      if (n.specifiers.some(s => s.type === 'ImportNamespaceSpecifier' && (ns = s))) {
        namespaces.set(ns.local.name, n.source.value)
      }
      return
    }

    if (n.type === 'ExportNamedDeclaration') {
      // capture declaration
      if (n.declaration != null) {
        switch (n.declaration.type) {
          case 'FunctionDeclaration':
          case 'ClassDeclaration':
          case 'TypeAlias': // flowtype with babel-eslint parser
          case 'InterfaceDeclaration':
          case 'DeclareFunction':
          case 'TSDeclareFunction':
          case 'TSEnumDeclaration':
          case 'TSTypeAliasDeclaration':
          case 'TSInterfaceDeclaration':
          case 'TSAbstractClassDeclaration':
          case 'TSModuleDeclaration':
            m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n))
            break
          case 'VariableDeclaration':
            n.declaration.declarations.forEach((d) =>
              recursivePatternCapture(d.id,
                id => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n))))
            break
        }
      }

      const nsource = n.source && n.source.value
      n.specifiers.forEach((s) => {
        const exportMeta = {}
        let local

        switch (s.type) {
          case 'ExportDefaultSpecifier':
            if (!n.source) return
            local = 'default'
            break
          case 'ExportNamespaceSpecifier':
            m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {
              get() { return resolveImport(nsource) },
            }))
            return
          case 'ExportSpecifier':
            if (!n.source) {
              m.namespace.set(s.exported.name, addNamespace(exportMeta, s.local))
              return
            }
            // else falls through
          default:
            local = s.local.name
            break
        }

        // todo: JSDoc
        m.reexports.set(s.exported.name, { local, getImport: () => resolveImport(nsource) })
      })
    }

    // This doesn't declare anything, but changes what's being exported.
    if (n.type === 'TSExportAssignment') {
      const moduleDecl = ast.body.find((bodyNode) =>
        bodyNode.type === 'TSModuleDeclaration' && bodyNode.id.name === n.expression.name
      )
      if (moduleDecl && moduleDecl.body && moduleDecl.body.body) {
        moduleDecl.body.body.forEach((moduleBlockNode) => {
          // Export-assignment exports all members in the namespace, explicitly exported or not.
          const exportedDecl = moduleBlockNode.type === 'ExportNamedDeclaration' ?
            moduleBlockNode.declaration :
            moduleBlockNode

          if (exportedDecl.type === 'VariableDeclaration') {
            exportedDecl.declarations.forEach((decl) =>
              recursivePatternCapture(decl.id,(id) => m.namespace.set(
                id.name,
                captureDoc(source, docStyleParsers, decl, exportedDecl, moduleBlockNode))
              )
            )
          } else {
            m.namespace.set(
              exportedDecl.id.name,
              captureDoc(source, docStyleParsers, moduleBlockNode))
          }
        })
      }
    }
  })

  return m
}

/**
 * The creation of this closure is isolated from other scopes
 * to avoid over-retention of unrelated variables, which has
 * caused memory leaks. See #1266.
 */
function thunkFor(p, context) {
  return () => ExportMap.for(childContext(p, context))
}


/**
 * Traverse a pattern/identifier node, calling 'callback'
 * for each leaf identifier.
 * @param  {node}   pattern
 * @param  {Function} callback
 * @return {void}
 */
export function recursivePatternCapture(pattern, callback) {
  switch (pattern.type) {
    case 'Identifier': // base case
      callback(pattern)
      break

    case 'ObjectPattern':
      pattern.properties.forEach(p => {
        recursivePatternCapture(p.value, callback)
      })
      break

    case 'ArrayPattern':
      pattern.elements.forEach((element) => {
        if (element == null) return
        recursivePatternCapture(element, callback)
      })
      break

    case 'AssignmentPattern':
      callback(pattern.left)
      break
  }
}

/**
 * don't hold full context object in memory, just grab what we need.
 */
function childContext(path, context) {
  const { settings, parserOptions, parserPath } = context
  return {
    settings,
    parserOptions,
    parserPath,
    path,
  }
}


/**
 * sometimes legacy support isn't _that_ hard... right?
 */
function makeSourceCode(text, ast) {
  if (SourceCode.length > 1) {
    // ESLint 3
    return new SourceCode(text, ast)
  } else {
    // ESLint 4, 5
    return new SourceCode({ text, ast })
  }
}

1	import fs from 'fs'
2
3	import doctrine from 'doctrine'
4
5	import debug from 'debug'
6
7	import SourceCode from 'eslint/lib/util/source-code'
8
9	import parse from 'eslint-module-utils/parse'
10	import resolve from 'eslint-module-utils/resolve'
11	import isIgnored, { hasValidExtension } from 'eslint-module-utils/ignore'
12
13	import { hashObject } from 'eslint-module-utils/hash'
14	import * as unambiguous from 'eslint-module-utils/unambiguous'
15
16	const log = debug('eslint-plugin-import:ExportMap')	1✔
17
18	const exportCache = new Map()	1✔
19
20	export default class ExportMap {
21	constructor(path) {
22	this.path = path	123✔
23	this.namespace = new Map()	123✔
24	// todo: restructure to key on path, value is resolver + map of names
25	this.reexports = new Map()	123✔
26	/**
27	* star-exports
28	* @type {Set} of () => ExportMap
29	*/
30	this.dependencies = new Set()	123✔
31	/**
32	* dependencies of this module that are not explicitly re-exported
33	* @type {Map} from path = () => ExportMap
34	*/
35	this.imports = new Map()	123✔
36	this.errors = []	123✔
37	}
38
39	get hasDefault() { return this.get('default') != null } // stronger than this.has	×
40
41	get size() {
42	let size = this.namespace.size + this.reexports.size	62✔
43	this.dependencies.forEach(dep => {	62✔
44	const d = dep()	3✔
45	// CJS / ignored dependencies won't exist (#717)
46	if (d == null) return	3!
47	size += d.size	3✔
48	})
49	return size	62✔
50	}
51
52	/**
53	* Note that this does not check explicitly re-exported names for existence
54	* in the base namespace, but it will expand all `export * from '...'` exports
55	* if not found in the explicit namespace.
56	* @param {string} name
57	* @return {Boolean} true if `name` is exported by this module.
58	*/
59	has(name) {
60	if (this.namespace.has(name)) return true	149✔
61	if (this.reexports.has(name)) return true	35✔
62
63	// default exports must be explicitly re-exported (#328)
64	if (name !== 'default') {	29✔
65	for (let dep of this.dependencies) {	28✔
66	let innerMap = dep()	1✔
67
68	// todo: report as unresolved?
69	if (!innerMap) continue	1!
70
71	if (innerMap.has(name)) return true	1!
72	}
73	}
74
75	return false	28✔
76	}
77
78	/**
79	* ensure that imported name fully resolves.
80	* @param {[type]} name [description]
81	* @return {Boolean} [description]
82	*/
83	hasDeep(name) {
84	if (this.namespace.has(name)) return { found: true, path: [this] }	148✔
85
86	if (this.reexports.has(name)) {	59✔
87	const reexports = this.reexports.get(name)	16✔
88	, imported = reexports.getImport()	16✔
89
90	// if import is ignored, return explicit 'null'
91	if (imported == null) return { found: true, path: [this] }	16✔
92
93	// safeguard against cycles, only if name matches
94	if (imported.path === this.path && reexports.local === name) {	13✔
95	return { found: false, path: [this] }	1✔
96	}
97
98	const deep = imported.hasDeep(reexports.local)	12✔
99	deep.path.unshift(this)	12✔
100
101	return deep	12✔
102	}
103
104
105	// default exports must be explicitly re-exported (#328)
106	if (name !== 'default') {	43✔
107	for (let dep of this.dependencies) {	41✔
108	let innerMap = dep()	10✔
109	// todo: report as unresolved?
110	if (!innerMap) continue	10!
111
112	// safeguard against cycles
113	if (innerMap.path === this.path) continue	10!
114
115	let innerValue = innerMap.hasDeep(name)	10✔
116	if (innerValue.found) {	10✔
117	innerValue.path.unshift(this)	7✔
118	return innerValue	7✔
119	}
120	}
121	}
122
123	return { found: false, path: [this] }	36✔
124	}
125
126	get(name) {
127	if (this.namespace.has(name)) return this.namespace.get(name)	213✔
128
129	if (this.reexports.has(name)) {	21✔
130	const reexports = this.reexports.get(name)	14✔
131	, imported = reexports.getImport()	14✔
132
133	// if import is ignored, return explicit 'null'
134	if (imported == null) return null	14✔
135
136	// safeguard against cycles, only if name matches
137	if (imported.path === this.path && reexports.local === name) return undefined	7!
138
139	return imported.get(reexports.local)	7✔
140	}
141
142	// default exports must be explicitly re-exported (#328)
143	if (name !== 'default') {	7!
144	for (let dep of this.dependencies) {	×
145	let innerMap = dep()	×
146	// todo: report as unresolved?
147	if (!innerMap) continue	×
148
149	// safeguard against cycles
150	if (innerMap.path === this.path) continue	×
151
152	let innerValue = innerMap.get(name)	×
153	if (innerValue !== undefined) return innerValue	×
154	}
155	}
156
157	return undefined	7✔
158	}
159
160	forEach(callback, thisArg) {
161	this.namespace.forEach((v, n) =>	9✔
162	callback.call(thisArg, v, n, this))	6✔
163
164	this.reexports.forEach((reexports, name) => {	9✔
165	const reexported = reexports.getImport()	1✔
166	// can't look up meta for ignored re-exports (#348)
167	callback.call(thisArg, reexported && reexported.get(reexports.local), name, this)	1!
168	})
169
170	this.dependencies.forEach(dep => {	9✔
171	const d = dep()	3✔
172	// CJS / ignored dependencies won't exist (#717)
173	if (d == null) return	3!
174
175	d.forEach((v, n) =>	3✔
176	n !== 'default' && callback.call(thisArg, v, n, this))	3✔
177	})
178	}
179
180	// todo: keys, values, entries?
181
182	reportErrors(context, declaration) {
183	context.report({	6✔
184	node: declaration.source,
185	message: `Parse errors in imported module '${declaration.source.value}': ` +
186	`${this.errors
187	.map(e => `${e.message} (${e.lineNumber}:${e.column})`)	6✔
188	.join(', ')}`,
189	})
190	}
191	}
192
193	/**
194	* parse docs from the first node that has leading comments
195	*/
196	function captureDoc(source, docStyleParsers, ...nodes) {
197	const metadata = {}	222✔
198
199	// 'some' short-circuits on first 'true'
200	nodes.some(n => {	222✔
201	try {	291✔
202
203	let leadingComments
204
205	// n.leadingComments is legacy `attachComments` behavior
206	if ('leadingComments' in n) {	291✔
207	leadingComments = n.leadingComments	29✔
208	} else if (n.range) {	262!
209	leadingComments = source.getCommentsBefore(n)	262✔
210	}
211
212	if (!leadingComments \|\| leadingComments.length === 0) return false	291✔
213
214	for (let name in docStyleParsers) {	97✔
215	const doc = docStyleParsers[name](leadingComments)	104✔
216	if (doc) {	104✔
217	metadata.doc = doc	51✔
218	}
219	}
220
221	return true	97✔
222	} catch (err) {
223	return false	×
224	}
225	})
226
227	return metadata	222✔
228	}
229
230	const availableDocStyleParsers = {	1✔
231	jsdoc: captureJsDoc,
232	tomdoc: captureTomDoc,
233	}
234
235	/**
236	* parse JSDoc from leading comments
237	* @param {...[type]} comments [description]
238	* @return {{doc: object}}
239	*/
240	function captureJsDoc(comments) {
241	let doc
242
243	// capture XSDoc
244	comments.forEach(comment => {	86✔
245	// skip non-block comments
246	if (comment.type !== 'Block') return	115✔
247	try {	52✔
248	doc = doctrine.parse(comment.value, { unwrap: true })	52✔
249	} catch (err) {
250	/* don't care, for now? maybe add to `errors?` */
251	}
252	})
253
254	return doc	86✔
255	}
256
257	/**
258	* parse TomDoc section from comments
259	*/
260	function captureTomDoc(comments) {
261	// collect lines up to first paragraph break
262	const lines = []	18✔
263	for (let i = 0; i < comments.length; i++) {	18✔
264	const comment = comments[i]	28✔
265	if (comment.value.match(/^\s*$/)) break	28✔
266	lines.push(comment.value.trim())	25✔
267	}
268
269	// return doctrine-like object
270	const statusMatch = lines.join(' ').match(/^(Public\|Internal\|Deprecated):\s*(.+)/)	18✔
271	if (statusMatch) {	18✔
272	return {	4✔
273	description: statusMatch[2],
274	tags: [{
275	title: statusMatch[1].toLowerCase(),
276	description: statusMatch[2],
277	}],
278	}
279	}
280	}
281
282	ExportMap.get = function (source, context) {	1✔
283	const path = resolve(source, context)	353✔
284	if (path == null) return null	353✔
285
286	return ExportMap.for(childContext(path, context))	340✔
287	}
288
289	ExportMap.for = function (context) {	1✔
290	const { path } = context	488✔
291
292	const cacheKey = hashObject(context).digest('hex')	488✔
293	let exportMap = exportCache.get(cacheKey)	488✔
294
295	// return cached ignore
296	if (exportMap === null) return null	488✔
297
298	const stats = fs.statSync(path)	462✔
299	if (exportMap != null) {	462✔
300	// date equality check
301	if (exportMap.mtime - stats.mtime === 0) {	337✔
302	return exportMap	335✔
303	}
304	// future: check content equality?
305	}
306
307	// check valid extensions first
308	if (!hasValidExtension(path, context)) {	127✔
309	exportCache.set(cacheKey, null)	7✔
310	return null	7✔
311	}
312
313	const content = fs.readFileSync(path, { encoding: 'utf8' })	120✔
314
315	// check for and cache ignore
316	if (isIgnored(path, context) \|\| !unambiguous.test(content)) {	120✔
317	log('ignored path due to unambiguous regex or ignore settings:', path)	10✔
318	exportCache.set(cacheKey, null)	10✔
319	return null	10✔
320	}
321
322	log('cache miss', cacheKey, 'for path', path)	110✔
323	exportMap = ExportMap.parse(path, content, context)	110✔
324
325	// ambiguous modules return null
326	if (exportMap == null) return null	110!
327
328	exportMap.mtime = stats.mtime	110✔
329
330	exportCache.set(cacheKey, exportMap)	110✔
331	return exportMap	110✔
332	}
333
334
335	ExportMap.parse = function (path, content, context) {	1✔
336	var m = new ExportMap(path)	123✔
337
338	try {	123✔
339	var ast = parse(path, content, context)	123✔
340	} catch (err) {
341	log('parse error:', path, err)	3✔
342	m.errors.push(err)	3✔
343	return m // can't continue	3✔
344	}
345
346	if (!unambiguous.isModule(ast)) return null	120!
347
348	const docstyle = (context.settings && context.settings['import/docstyle']) \|\| ['jsdoc']	120✔
349	const docStyleParsers = {}	120✔
350	docstyle.forEach(style => {	120✔
351	docStyleParsers[style] = availableDocStyleParsers[style]	121✔
352	})
353
354	// attempt to collect module doc
355	if (ast.comments) {	120!
356	ast.comments.some(c => {	120✔
357	if (c.type !== 'Block') return false	120✔
358	try {	56✔
359	const doc = doctrine.parse(c.value, { unwrap: true })	56✔
360	if (doc.tags.some(t => t.title === 'module')) {	89✔
361	m.doc = doc	5✔
362	return true	5✔
363	}
364	} catch (err) { /* ignore */ }
365	return false	51✔
366	})
367	}
368
369	const namespaces = new Map()	120✔
370
371	function remotePath(value) {
372	return resolve.relative(value, path, context.settings)	166✔
373	}
374
375	function resolveImport(value) {
376	const rp = remotePath(value)	115✔
377	if (rp == null) return null	115!
378	return ExportMap.for(childContext(rp, context))	115✔
379	}
380
381	function getNamespace(identifier) {
382	if (!namespaces.has(identifier.name)) return	69✔
383
384	return function () {	12✔
385	return resolveImport(namespaces.get(identifier.name))	50✔
386	}
387	}
388
389	function addNamespace(object, identifier) {
390	const nsfn = getNamespace(identifier)	69✔
391	if (nsfn) {	69✔
392	Object.defineProperty(object, 'namespace', { get: nsfn })	12✔
393	}
394
395	return object	69✔
396	}
397
398	function captureDependency(declaration) {
399	if (declaration.source == null) return null	51!
400	const importedSpecifiers = new Set()	51✔
401	const supportedTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier'])	51✔
402	if (declaration.specifiers) {	51✔
403	declaration.specifiers.forEach(specifier => {	45✔
404	if (supportedTypes.has(specifier.type)) {	45✔
405	importedSpecifiers.add(specifier.type)	31✔
406	}
407	if (specifier.type === 'ImportSpecifier') {	45✔
408	importedSpecifiers.add(specifier.imported.name)	14✔
409	}
410	})
411	}
412
413	const p = remotePath(declaration.source.value)	51✔
414	if (p == null) return null	51✔
415	const existing = m.imports.get(p)	50✔
416	if (existing != null) return existing.getter	50✔
417
418	const getter = thunkFor(p, context)	47✔
419	m.imports.set(p, {	47✔
420	getter,
421	source: { // capturing actual node reference holds full AST in memory!
422	value: declaration.source.value,
423	loc: declaration.source.loc,
424	},
425	importedSpecifiers,
426	})
427	return getter	47✔
428	}
429
430	const source = makeSourceCode(content, ast)	120✔
431
432	ast.body.forEach(function (n) {	120✔
433
434	if (n.type === 'ExportDefaultDeclaration') {	345✔
435	const exportMeta = captureDoc(source, docStyleParsers, n)	39✔
436	if (n.declaration.type === 'Identifier') {	39✔
437	addNamespace(exportMeta, n.declaration)	4✔
438	}
439	m.namespace.set('default', exportMeta)	39✔
440	return	39✔
441	}
442
443	if (n.type === 'ExportAllDeclaration') {	306✔
444	const getter = captureDependency(n)	6✔
445	if (getter) m.dependencies.add(getter)	6✔
446	return	6✔
447	}
448
449	// capture namespaces in case of later export
450	if (n.type === 'ImportDeclaration') {	300✔
451	captureDependency(n)	45✔
452	let ns
453	if (n.specifiers.some(s => s.type === 'ImportNamespaceSpecifier' && (ns = s))) {	45✔
454	namespaces.set(ns.local.name, n.source.value)	14✔
455	}
456	return	45✔
457	}
458
459	if (n.type === 'ExportNamedDeclaration') {	255✔
460	// capture declaration
461	if (n.declaration != null) {	198✔
462	switch (n.declaration.type) {	126✔
463	case 'FunctionDeclaration':
464	case 'ClassDeclaration':
465	case 'TypeAlias': // flowtype with babel-eslint parser
466	case 'InterfaceDeclaration':
467	case 'DeclareFunction':
468	case 'TSDeclareFunction':
469	case 'TSEnumDeclaration':
470	case 'TSTypeAliasDeclaration':
471	case 'TSInterfaceDeclaration':
472	case 'TSAbstractClassDeclaration':
473	case 'TSModuleDeclaration':
474	m.namespace.set(n.declaration.id.name, captureDoc(source, docStyleParsers, n))	86✔
475	break	86✔
476	case 'VariableDeclaration':
477	n.declaration.declarations.forEach((d) =>	39✔
478	recursivePatternCapture(d.id,	83✔
479	id => m.namespace.set(id.name, captureDoc(source, docStyleParsers, d, n))))	83✔
480	break	39✔
481	}
482	}
483
484	const nsource = n.source && n.source.value	198✔
485	n.specifiers.forEach((s) => {	198✔
486	const exportMeta = {}	99✔
487	let local
488
489	switch (s.type) {	99✔
490	case 'ExportDefaultSpecifier':
491	if (!n.source) return	8!
492	local = 'default'	8✔
493	break	8✔
494	case 'ExportNamespaceSpecifier':
495	m.namespace.set(s.exported.name, Object.defineProperty(exportMeta, 'namespace', {	5✔
496	get() { return resolveImport(nsource) },	30✔
497	}))
498	return	5✔
499	case 'ExportSpecifier':
500	if (!n.source) {	86✔
501	m.namespace.set(s.exported.name, addNamespace(exportMeta, s.local))	65✔
502	return	65✔
503	}
504	// else falls through
505	default:
506	local = s.local.name	21✔
507	break	21✔
508	}
509
510	// todo: JSDoc
511	m.reexports.set(s.exported.name, { local, getImport: () => resolveImport(nsource) })	35✔
512	})
513	}
514
515	// This doesn't declare anything, but changes what's being exported.
516	if (n.type === 'TSExportAssignment') {	255✔
517	const moduleDecl = ast.body.find((bodyNode) =>	2✔
518	bodyNode.type === 'TSModuleDeclaration' && bodyNode.id.name === n.expression.name	4✔
519	)
520	if (moduleDecl && moduleDecl.body && moduleDecl.body.body) {	2!
521	moduleDecl.body.body.forEach((moduleBlockNode) => {	2✔
522	// Export-assignment exports all members in the namespace, explicitly exported or not.
523	const exportedDecl = moduleBlockNode.type === 'ExportNamedDeclaration' ?	14✔
524	moduleBlockNode.declaration :
525	moduleBlockNode
526
527	if (exportedDecl.type === 'VariableDeclaration') {	14!
528	exportedDecl.declarations.forEach((decl) =>	×
529	recursivePatternCapture(decl.id,(id) => m.namespace.set(	×
530	id.name,
531	captureDoc(source, docStyleParsers, decl, exportedDecl, moduleBlockNode))
532	)
533	)
534	} else {
535	m.namespace.set(	14✔
536	exportedDecl.id.name,
537	captureDoc(source, docStyleParsers, moduleBlockNode))
538	}
539	})
540	}
541	}
542	})
543
544	return m	120✔
545	}
546
547	/**
548	* The creation of this closure is isolated from other scopes
549	* to avoid over-retention of unrelated variables, which has
550	* caused memory leaks. See #1266.
551	*/
552	function thunkFor(p, context) {
553	return () => ExportMap.for(childContext(p, context))	47✔
554	}
555
556
557	/**
558	* Traverse a pattern/identifier node, calling 'callback'
559	* for each leaf identifier.
560	* @param {node} pattern
561	* @param {Function} callback
562	* @return {void}
563	*/
564	export function recursivePatternCapture(pattern, callback) {
565	switch (pattern.type) {	182✔
566	case 'Identifier': // base case
567	callback(pattern)	118✔
568	break	118✔
569
570	case 'ObjectPattern':
571	pattern.properties.forEach(p => {	32✔
572	recursivePatternCapture(p.value, callback)	34✔
573	})
574	break	32✔
575
576	case 'ArrayPattern':
577	pattern.elements.forEach((element) => {	20✔
578	if (element == null) return	34✔
579	recursivePatternCapture(element, callback)	22✔
580	})
581	break	20✔
582
583	case 'AssignmentPattern':
584	callback(pattern.left)	12✔
585	break	12✔
586	}
587	}
588
589	/**
590	* don't hold full context object in memory, just grab what we need.
591	*/
592	function childContext(path, context) {
593	const { settings, parserOptions, parserPath } = context	488✔
594	return {	488✔
595	settings,
596	parserOptions,
597	parserPath,
598	path,
599	}
600	}
601
602
603	/**
604	* sometimes legacy support isn't _that_ hard... right?
605	*/
606	function makeSourceCode(text, ast) {
607	if (SourceCode.length > 1) {	120!
608	// ESLint 3
609	return new SourceCode(text, ast)	120✔
610	} else {
611	// ESLint 4, 5
612	return new SourceCode({ text, ast })	×
613	}
614	}

benmosher / eslint-plugin-import / 24516273

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous