31109672

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/ec2843a9cea45da19a98ba72a2a133d0280a4cc1">ec2843a9c<a href="https://github.com/benmosher/eslint-plugin-import/commit/ec2843a9cea45da19a98ba72a2a133d0280a4cc1">">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/b6242b02548037223720657db4597f46b534dc87">b6242b025</a>">b6242b025</a><a href="https://github.com/benmosher/eslint-plugin-import/commit/ec2843a9cea45da19a98ba72a2a133d0280a4cc1"> into 41aaa1842">41aaa1842</a>

Run Details

1521 of 1669 branches covered (91.13%)

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

2161 of 2269 relevant lines covered (95.24%)

65.02 hits per line

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

98.96

/src/rules/no-duplicates.js

import resolve from 'eslint-module-utils/resolve'
import docsUrl from '../docsUrl'

function checkImports(imported, context) {
  for (const [module, nodes] of imported.entries()) {
    if (nodes.length > 1) {
      const message = `'${module}' imported multiple times.`
      const [first, ...rest] = nodes
      const sourceCode = context.getSourceCode()
      const fix = getFix(first, rest, sourceCode)

      context.report({
        node: first.source,
        message,
        fix, // Attach the autofix (if any) to the first import.
      })

      for (const node of rest) {
        context.report({
          node: node.source,
          message,
        })
      }
    }
  }
}

function getFix(first, rest, sourceCode) {
  // Sorry ESLint <= 3 users, no autofix for you. Autofixing duplicate imports
  // requires multiple `fixer.whatever()` calls in the `fix`: We both need to
  // update the first one, and remove the rest. Support for multiple
  // `fixer.whatever()` in a single `fix` was added in ESLint 4.1.
  // `sourceCode.getCommentsBefore` was added in 4.0, so that's an easy thing to
  // check for.
  if (typeof sourceCode.getCommentsBefore !== 'function') {
    return undefined
  }

  // Adjusting the first import might make it multiline, which could break
  // `eslint-disable-next-line` comments and similar, so bail if the first
  // import has comments. Also, if the first import is `import * as ns from
  // './foo'` there's nothing we can do.
  if (hasProblematicComments(first, sourceCode) || hasNamespace(first)) {
    return undefined
  }

  const defaultImportNames = new Set(
    [first, ...rest].map(getDefaultImportName).filter(Boolean)
  )

  // Bail if there are multiple different default import names – it's up to the
  // user to choose which one to keep.
  if (defaultImportNames.size > 1) {
    return undefined
  }

  // Leave it to the user to handle comments. Also skip `import * as ns from
  // './foo'` imports, since they cannot be merged into another import.
  const restWithoutComments = rest.filter(node => !(
    hasProblematicComments(node, sourceCode) ||
    hasNamespace(node)
  ))

  const specifiers = restWithoutComments
    .map(node => {
      const tokens = sourceCode.getTokens(node)
      const openBrace = tokens.find(token => isPunctuator(token, '{'))
      const closeBrace = tokens.find(token => isPunctuator(token, '}'))

      if (openBrace == null || closeBrace == null) {
        return undefined
      }

      return {
        importNode: node,
        text: sourceCode.text.slice(openBrace.range[1], closeBrace.range[0]),
        hasTrailingComma: isPunctuator(sourceCode.getTokenBefore(closeBrace), ','),
        isEmpty: !hasSpecifiers(node),
      }
    })
    .filter(Boolean)

  const unnecessaryImports = restWithoutComments.filter(node =>
    !hasSpecifiers(node) &&
    !hasNamespace(node) &&
    !specifiers.some(specifier => specifier.importNode === node)
  )

  const shouldAddDefault = getDefaultImportName(first) == null && defaultImportNames.size === 1
  const shouldAddSpecifiers = specifiers.length > 0
  const shouldRemoveUnnecessary = unnecessaryImports.length > 0

  if (!(shouldAddDefault || shouldAddSpecifiers || shouldRemoveUnnecessary)) {
    return undefined
  }

  return fixer => {
    const tokens = sourceCode.getTokens(first)
    const openBrace = tokens.find(token => isPunctuator(token, '{'))
    const closeBrace = tokens.find(token => isPunctuator(token, '}'))
    const firstToken = sourceCode.getFirstToken(first)
    const [defaultImportName] = defaultImportNames

    const firstHasTrailingComma =
      closeBrace != null &&
      isPunctuator(sourceCode.getTokenBefore(closeBrace), ',')
    const firstIsEmpty = !hasSpecifiers(first)

    const [specifiersText] = specifiers.reduce(
      ([result, needsComma], specifier) => {
        return [
          needsComma && !specifier.isEmpty
            ? `${result},${specifier.text}`
            : `${result}${specifier.text}`,
          specifier.isEmpty ? needsComma : true,
        ]
      },
      ['', !firstHasTrailingComma && !firstIsEmpty]
    )

    const fixes = []

    if (shouldAddDefault && openBrace == null && shouldAddSpecifiers) {
      // `import './foo'` → `import def, {...} from './foo'`
      fixes.push(
        fixer.insertTextAfter(firstToken, ` ${defaultImportName}, {${specifiersText}} from`)
      )
    } else if (shouldAddDefault && openBrace == null && !shouldAddSpecifiers) {
      // `import './foo'` → `import def from './foo'`
      fixes.push(fixer.insertTextAfter(firstToken, ` ${defaultImportName} from`))
    } else if (shouldAddDefault && openBrace != null && closeBrace != null) {
      // `import {...} from './foo'` → `import def, {...} from './foo'`
      fixes.push(fixer.insertTextAfter(firstToken, ` ${defaultImportName},`))
      if (shouldAddSpecifiers) {
        // `import def, {...} from './foo'` → `import def, {..., ...} from './foo'`
        fixes.push(fixer.insertTextBefore(closeBrace, specifiersText))
      }
    } else if (!shouldAddDefault && openBrace == null && shouldAddSpecifiers) {
      if (first.specifiers.length === 0) {
        // `import './foo'` → `import {...} from './foo'`
        fixes.push(fixer.insertTextAfter(firstToken, ` {${specifiersText}} from`))
      } else {
        // `import def from './foo'` → `import def, {...} from './foo'`
        fixes.push(fixer.insertTextAfter(first.specifiers[0], `, {${specifiersText}}`))
      }
    } else if (!shouldAddDefault && openBrace != null && closeBrace != null) {
      // `import {...} './foo'` → `import {..., ...} from './foo'`
      fixes.push(fixer.insertTextBefore(closeBrace, specifiersText))
    }

    // Remove imports whose specifiers have been moved into the first import.
    for (const specifier of specifiers) {
      fixes.push(fixer.remove(specifier.importNode))
    }

    // Remove imports whose default import has been moved to the first import,
    // and side-effect-only imports that are unnecessary due to the first
    // import.
    for (const node of unnecessaryImports) {
      fixes.push(fixer.remove(node))
    }

    return fixes
  }
}

function isPunctuator(node, value) {
  return node.type === 'Punctuator' && node.value === value
}

// Get the name of the default import of `node`, if any.
function getDefaultImportName(node) {
  const defaultSpecifier = node.specifiers
    .find(specifier => specifier.type === 'ImportDefaultSpecifier')
  return defaultSpecifier != null ? defaultSpecifier.local.name : undefined
}

// Checks whether `node` has a namespace import.
function hasNamespace(node) {
  const specifiers = node.specifiers
    .filter(specifier => specifier.type === 'ImportNamespaceSpecifier')
  return specifiers.length > 0
}

// Checks whether `node` has any non-default specifiers.
function hasSpecifiers(node) {
  const specifiers = node.specifiers
    .filter(specifier => specifier.type === 'ImportSpecifier')
  return specifiers.length > 0
}

// It's not obvious what the user wants to do with comments associated with
// duplicate imports, so skip imports with comments when autofixing.
function hasProblematicComments(node, sourceCode) {
  return (
    hasCommentBefore(node, sourceCode) ||
    hasCommentAfter(node, sourceCode) ||
    hasCommentInsideNonSpecifiers(node, sourceCode)
  )
}

// Checks whether `node` has a comment (that ends) on the previous line or on
// the same line as `node` (starts).
function hasCommentBefore(node, sourceCode) {
  return sourceCode.getCommentsBefore(node)
    .some(comment => comment.loc.end.line >= node.loc.start.line - 1)
}

// Checks whether `node` has a comment (that starts) on the same line as `node`
// (ends).
function hasCommentAfter(node, sourceCode) {
  return sourceCode.getCommentsAfter(node)
    .some(comment => comment.loc.start.line === node.loc.end.line)
}

// Checks whether `node` has any comments _inside,_ except inside the `{...}`
// part (if any).
function hasCommentInsideNonSpecifiers(node, sourceCode) {
  const tokens = sourceCode.getTokens(node)
  const openBraceIndex = tokens.findIndex(token => isPunctuator(token, '{'))
  const closeBraceIndex = tokens.findIndex(token => isPunctuator(token, '}'))
  // Slice away the first token, since we're no looking for comments _before_
  // `node` (only inside). If there's a `{...}` part, look for comments before
  // the `{`, but not before the `}` (hence the `+1`s).
  const someTokens = openBraceIndex >= 0 && closeBraceIndex >= 0
    ? tokens.slice(1, openBraceIndex + 1).concat(tokens.slice(closeBraceIndex + 1))
    : tokens.slice(1)
  return someTokens.some(token => sourceCode.getCommentsBefore(token).length > 0)
}

module.exports = {
  meta: {
    type: 'problem',
    docs: {
      url: docsUrl('no-duplicates'),
    },
    fixable: 'code',
    schema: [
      {
        type: 'object',
        properties: {
          considerQueryString: {
            type: 'boolean',
          },
        },
        additionalProperties: false,
      },
    ],
  },

  create: function (context) {
    // Prepare the resolver from options.
    const considerQueryStringOption = context.options[0] &&
      context.options[0]['considerQueryString']
    const defaultResolver = sourcePath => resolve(sourcePath, context) || sourcePath
    const resolver = considerQueryStringOption ? (sourcePath => {
      const parts = sourcePath.match(/^([^?]*)\?(.*)$/)
      if (!parts) {
        return defaultResolver(sourcePath)
      }
      return defaultResolver(parts[1]) + '?' + parts[2]
    }) : defaultResolver

    const imported = new Map()
    const nsImported = new Map()
    const typesImported = new Map()
    return {
      'ImportDeclaration': function (n) {
        // resolved path will cover aliased duplicates
        const resolvedPath = resolver(n.source.value)
        const importMap = n.importKind === 'type' ? typesImported :
          (hasNamespace(n) ? nsImported : imported)

        if (importMap.has(resolvedPath)) {
          importMap.get(resolvedPath).push(n)
        } else {
          importMap.set(resolvedPath, [n])
        }
      },

      'Program:exit': function () {
        checkImports(imported, context)
        checkImports(nsImported, context)
        checkImports(typesImported, context)
      },
    }
  },
}

1	import resolve from 'eslint-module-utils/resolve'
2	import docsUrl from '../docsUrl'
3
4	function checkImports(imported, context) {
5	for (const [module, nodes] of imported.entries()) {	204✔
6	if (nodes.length > 1) {	79✔
7	const message = `'${module}' imported multiple times.`	38✔
8	const [first, ...rest] = nodes	38✔
9	const sourceCode = context.getSourceCode()	38✔
10	const fix = getFix(first, rest, sourceCode)	38✔
11
12	context.report({	38✔
13	node: first.source,
14	message,
15	fix, // Attach the autofix (if any) to the first import.
16	})
17
18	for (const node of rest) {	38✔
19	context.report({	44✔
20	node: node.source,
21	message,
22	})
23	}
24	}
25	}
26	}
27
28	function getFix(first, rest, sourceCode) {
29	// Sorry ESLint <= 3 users, no autofix for you. Autofixing duplicate imports
30	// requires multiple `fixer.whatever()` calls in the `fix`: We both need to
31	// update the first one, and remove the rest. Support for multiple
32	// `fixer.whatever()` in a single `fix` was added in ESLint 4.1.
33	// `sourceCode.getCommentsBefore` was added in 4.0, so that's an easy thing to
34	// check for.
35	if (typeof sourceCode.getCommentsBefore !== 'function') {	38!
36	return undefined	×
37	}
38
39	// Adjusting the first import might make it multiline, which could break
40	// `eslint-disable-next-line` comments and similar, so bail if the first
41	// import has comments. Also, if the first import is `import * as ns from
42	// './foo'` there's nothing we can do.
43	if (hasProblematicComments(first, sourceCode) \|\| hasNamespace(first)) {	38✔
44	return undefined	4✔
45	}
46
47	const defaultImportNames = new Set(	34✔
48	[first, ...rest].map(getDefaultImportName).filter(Boolean)
49	)
50
51	// Bail if there are multiple different default import names – it's up to the
52	// user to choose which one to keep.
53	if (defaultImportNames.size > 1) {	34✔
54	return undefined	4✔
55	}
56
57	// Leave it to the user to handle comments. Also skip `import * as ns from
58	// './foo'` imports, since they cannot be merged into another import.
59	const restWithoutComments = rest.filter(node => !(	36✔
60	hasProblematicComments(node, sourceCode) \|\|	64✔
61	hasNamespace(node)
62	))
63
64	const specifiers = restWithoutComments	30✔
65	.map(node => {
66	const tokens = sourceCode.getTokens(node)	28✔
67	const openBrace = tokens.find(token => isPunctuator(token, '{'))	67✔
68	const closeBrace = tokens.find(token => isPunctuator(token, '}'))	108✔
69
70	if (openBrace == null \|\| closeBrace == null) {	28✔
71	return undefined	5✔
72	}
73
74	return {	23✔
75	importNode: node,
76	text: sourceCode.text.slice(openBrace.range[1], closeBrace.range[0]),
77	hasTrailingComma: isPunctuator(sourceCode.getTokenBefore(closeBrace), ','),
78	isEmpty: !hasSpecifiers(node),
79	}
80	})
81	.filter(Boolean)
82
83	const unnecessaryImports = restWithoutComments.filter(node =>	30✔
84	!hasSpecifiers(node) &&	28✔
85	!hasNamespace(node) &&
86	!specifiers.some(specifier => specifier.importNode === node)	8✔
87	)
88
89	const shouldAddDefault = getDefaultImportName(first) == null && defaultImportNames.size === 1	30✔
90	const shouldAddSpecifiers = specifiers.length > 0	30✔
91	const shouldRemoveUnnecessary = unnecessaryImports.length > 0	30✔
92
93	if (!(shouldAddDefault \|\| shouldAddSpecifiers \|\| shouldRemoveUnnecessary)) {	30✔
94	return undefined	8✔
95	}
96
97	return fixer => {	22✔
98	const tokens = sourceCode.getTokens(first)	22✔
99	const openBrace = tokens.find(token => isPunctuator(token, '{'))	54✔
100	const closeBrace = tokens.find(token => isPunctuator(token, '}'))	84✔
101	const firstToken = sourceCode.getFirstToken(first)	22✔
102	const [defaultImportName] = defaultImportNames	22✔
103
104	const firstHasTrailingComma =
105	closeBrace != null &&	22✔
106	isPunctuator(sourceCode.getTokenBefore(closeBrace), ',')
107	const firstIsEmpty = !hasSpecifiers(first)	22✔
108
109	const [specifiersText] = specifiers.reduce(	22✔
110	([result, needsComma], specifier) => {
111	return [	23✔
112	needsComma && !specifier.isEmpty	60✔
113	? `${result},${specifier.text}`
114	: `${result}${specifier.text}`,
115	specifier.isEmpty ? needsComma : true,	23✔
116	]
117	},
118	['', !firstHasTrailingComma && !firstIsEmpty]	43✔
119	)
120
121	const fixes = []	22✔
122
123	if (shouldAddDefault && openBrace == null && shouldAddSpecifiers) {	22✔
124	// `import './foo'` → `import def, {...} from './foo'`
125	fixes.push(	1✔
126	fixer.insertTextAfter(firstToken, ` ${defaultImportName}, {${specifiersText}} from`)
127	)
128	} else if (shouldAddDefault && openBrace == null && !shouldAddSpecifiers) {	21✔
129	// `import './foo'` → `import def from './foo'`
130	fixes.push(fixer.insertTextAfter(firstToken, ` ${defaultImportName} from`))	1✔
131	} else if (shouldAddDefault && openBrace != null && closeBrace != null) {	20✔
132	// `import {...} from './foo'` → `import def, {...} from './foo'`
133	fixes.push(fixer.insertTextAfter(firstToken, ` ${defaultImportName},`))	3✔
134	if (shouldAddSpecifiers) {	3✔
135	// `import def, {...} from './foo'` → `import def, {..., ...} from './foo'`
136	fixes.push(fixer.insertTextBefore(closeBrace, specifiersText))	1✔
137	}
138	} else if (!shouldAddDefault && openBrace == null && shouldAddSpecifiers) {	17✔
139	if (first.specifiers.length === 0) {	4✔
140	// `import './foo'` → `import {...} from './foo'`
141	fixes.push(fixer.insertTextAfter(firstToken, ` {${specifiersText}} from`))	3✔
142	} else {
143	// `import def from './foo'` → `import def, {...} from './foo'`
144	fixes.push(fixer.insertTextAfter(first.specifiers[0], `, {${specifiersText}}`))	1✔
145	}
146	} else if (!shouldAddDefault && openBrace != null && closeBrace != null) {	13✔
147	// `import {...} './foo'` → `import {..., ...} from './foo'`
148	fixes.push(fixer.insertTextBefore(closeBrace, specifiersText))	12✔
149	}
150
151	// Remove imports whose specifiers have been moved into the first import.
152	for (const specifier of specifiers) {	22✔
153	fixes.push(fixer.remove(specifier.importNode))	23✔
154	}
155
156	// Remove imports whose default import has been moved to the first import,
157	// and side-effect-only imports that are unnecessary due to the first
158	// import.
159	for (const node of unnecessaryImports) {	22✔
160	fixes.push(fixer.remove(node))	5✔
161	}
162
163	return fixes	22✔
164	}
165	}
166
167	function isPunctuator(node, value) {
168	return node.type === 'Punctuator' && node.value === value	794✔
169	}
170
171	// Get the name of the default import of `node`, if any.
172	function getDefaultImportName(node) {
173	const defaultSpecifier = node.specifiers	104✔
174	.find(specifier => specifier.type === 'ImportDefaultSpecifier')	82✔
175	return defaultSpecifier != null ? defaultSpecifier.local.name : undefined	104✔
176	}
177
178	// Checks whether `node` has a namespace import.
179	function hasNamespace(node) {
180	const specifiers = node.specifiers	192✔
181	.filter(specifier => specifier.type === 'ImportNamespaceSpecifier')	174✔
182	return specifiers.length > 0	192✔
183	}
184
185	// Checks whether `node` has any non-default specifiers.
186	function hasSpecifiers(node) {
187	const specifiers = node.specifiers	73✔
188	.filter(specifier => specifier.type === 'ImportSpecifier')	58✔
189	return specifiers.length > 0	73✔
190	}
191
192	// It's not obvious what the user wants to do with comments associated with
193	// duplicate imports, so skip imports with comments when autofixing.
194	function hasProblematicComments(node, sourceCode) {
195	return (	74✔
196	hasCommentBefore(node, sourceCode) \|\|	213✔
197	hasCommentAfter(node, sourceCode) \|\|
198	hasCommentInsideNonSpecifiers(node, sourceCode)
199	)
200	}
201
202	// Checks whether `node` has a comment (that ends) on the previous line or on
203	// the same line as `node` (starts).
204	function hasCommentBefore(node, sourceCode) {
205	return sourceCode.getCommentsBefore(node)	74✔
206	.some(comment => comment.loc.end.line >= node.loc.start.line - 1)	4✔
207	}
208
209	// Checks whether `node` has a comment (that starts) on the same line as `node`
210	// (ends).
211	function hasCommentAfter(node, sourceCode) {
212	return sourceCode.getCommentsAfter(node)	71✔
213	.some(comment => comment.loc.start.line === node.loc.end.line)	7✔
214	}
215
216	// Checks whether `node` has any comments _inside,_ except inside the `{...}`
217	// part (if any).
218	function hasCommentInsideNonSpecifiers(node, sourceCode) {
219	const tokens = sourceCode.getTokens(node)	68✔
220	const openBraceIndex = tokens.findIndex(token => isPunctuator(token, '{'))	174✔
221	const closeBraceIndex = tokens.findIndex(token => isPunctuator(token, '}'))	269✔
222	// Slice away the first token, since we're no looking for comments _before_
223	// `node` (only inside). If there's a `{...}` part, look for comments before
224	// the `{`, but not before the `}` (hence the `+1`s).
225	const someTokens = openBraceIndex >= 0 && closeBraceIndex >= 0	68✔
226	? tokens.slice(1, openBraceIndex + 1).concat(tokens.slice(closeBraceIndex + 1))
227	: tokens.slice(1)
228	return someTokens.some(token => sourceCode.getCommentsBefore(token).length > 0)	223✔
229	}
230
231	module.exports = {	1✔
232	meta: {
233	type: 'problem',
234	docs: {
235	url: docsUrl('no-duplicates'),
236	},
237	fixable: 'code',
238	schema: [
239	{
240	type: 'object',
241	properties: {
242	considerQueryString: {
243	type: 'boolean',
244	},
245	},
246	additionalProperties: false,
247	},
248	],
249	},
250
251	create: function (context) {
252	// Prepare the resolver from options.
253	const considerQueryStringOption = context.options[0] &&	68✔
254	context.options[0]['considerQueryString']
255	const defaultResolver = sourcePath => resolve(sourcePath, context) \|\| sourcePath	123✔
256	const resolver = considerQueryStringOption ? (sourcePath => {	68✔
257	const parts = sourcePath.match(/^([^?])\?(.)$/)	6✔
258	if (!parts) {	6✔
259	return defaultResolver(sourcePath)	2✔
260	}
261	return defaultResolver(parts[1]) + '?' + parts[2]	4✔
262	}) : defaultResolver
263
264	const imported = new Map()	68✔
265	const nsImported = new Map()	68✔
266	const typesImported = new Map()	68✔
267	return {	68✔
268	'ImportDeclaration': function (n) {
269	// resolved path will cover aliased duplicates
270	const resolvedPath = resolver(n.source.value)	123✔
271	const importMap = n.importKind === 'type' ? typesImported :	123✔
272	(hasNamespace(n) ? nsImported : imported)	119✔
273
274	if (importMap.has(resolvedPath)) {	123✔
275	importMap.get(resolvedPath).push(n)	44✔
276	} else {
277	importMap.set(resolvedPath, [n])	79✔
278	}
279	},
280
281	'Program:exit': function () {
282	checkImports(imported, context)	68✔
283	checkImports(nsImported, context)	68✔
284	checkImports(typesImported, context)	68✔
285	},
286	}
287	},
288	}

benmosher / eslint-plugin-import / 31109672

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