30864057

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/15367e3016f10535c5b0cc2bf834ebeb3b064507">15367e301<a href="https://github.com/benmosher/eslint-plugin-import/commit/15367e3016f10535c5b0cc2bf834ebeb3b064507">">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/060ea2c1f281593d83b703a04d6fad6b27daf0a2">060ea2c1f</a>">060ea2c1f</a><a href="https://github.com/benmosher/eslint-plugin-import/commit/15367e3016f10535c5b0cc2bf834ebeb3b064507"> into 12971f5ce">12971f5ce</a>

Run Details

1532 of 1685 branches covered (90.92%)

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

2187 of 2297 relevant lines covered (95.21%)

64.82 hits per line

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

90.91

/src/ExportMap.js

import fs from 'fs'

import doctrine from 'doctrine'

import debug from 'debug'

import { SourceCode } from 'eslint'

import parse, { visit } 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()
        if (innerMap == null) return { found: true, path: [this] }
        // 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
  }

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

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

  // check for and cache unambiguous modules
  if (!unambiguous.test(content)) {
    log('ignored path due to unambiguous regex:', 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
  }

  let hasDynamicImports = false

  let declarator = null
  visit(ast, path, context, {
    VariableDeclarator(node) {
      declarator = node
      if (node.id.type === 'Identifier') {
        log('Declarator', node.id.name)
      } else if (node.id.type === 'ObjectPattern') {
        log('Object pattern')
      }
    },
    'VariableDeclarator:Exit': function() {
      declarator = null
    },
    CallExpression(node) {
      log('CALL', node.callee.type)
      // log(JSON.stringify(node))
      if (node.callee.type === 'Import') {
        hasDynamicImports = true
        const p = remotePath(node.arguments[0].value)
        if (p == null) return null
        if (declarator) {
          log('IDDDDDDDD', declarator.id.name)
        }
          const importLiteral = node.arguments[0]
          const importedSpecifiers = new Set()
        if (declarator) {
          if (declarator.id.type === 'Identifier') {
            importedSpecifiers.add('ImportDefaultSpecifier')
          } else if (declarator.id.type === 'ObjectPattern') {
            for (const property of declarator.id.properties) {
              log('ADD PROPERTY', property.key.name)
              importedSpecifiers.add(property.key.name)
            }
          }
          }
          const getter = thunkFor(p, context)
          m.imports.set(p, {
            getter,
            source: {
              // capturing actual node reference holds full AST in memory!
              value: importLiteral.value,
              loc: importLiteral.loc,
            },
            importedSpecifiers,
          })
      }
    },
  })

  if (!unambiguous.isModule(ast) && !hasDynamicImports) {
    log('is not a module', path, hasDynamicImports)
    return null
  } else {
    log('is a module!', path)
  }

  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
    if (declaration.importKind === 'type') return null // skip Flow type imports
    const importedSpecifiers = new Set()
    const supportedTypes = new Set(['ImportDefaultSpecifier', 'ImportNamespaceSpecifier'])
    let hasImportedType = false
    if (declaration.specifiers) {
      declaration.specifiers.forEach(specifier => {
        const isType = specifier.importKind === 'type'
        hasImportedType = hasImportedType || isType

        if (supportedTypes.has(specifier.type) && !isType) {
          importedSpecifiers.add(specifier.type)
        }
        if (specifier.type === 'ImportSpecifier' && !isType) {
          importedSpecifiers.add(specifier.imported.name)
        }
      })
    }

    // only Flow types were imported
    if (hasImportedType && importedSpecifiers.size === 0) return null

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

benmosher / eslint-plugin-import / 30864057

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