19512361

Build # 19512361

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/5993efac30b3004b615b28cd57605fc4b4b9501c">5993efac3<a href="https://github.com/benmosher/eslint-plugin-import/commit/5993efac30b3004b615b28cd57605fc4b4b9501c">">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/73969b67dc85254823894c8118a61d7e7489e68e">73969b67d</a>">73969b67d</a><a href="https://github.com/benmosher/eslint-plugin-import/commit/5993efac30b3004b615b28cd57605fc4b4b9501c"> into b4a2f11fc">b4a2f11fc</a>

Run Details

1037 of 1150 branches covered (90.17%)

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

1475 of 1560 relevant lines covered (94.55%)

42.03 hits per line

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

96.7

/src/rules/rename-default-import.js

/**
 * @fileoverview Rule to enforce aliases for default imports
 * @author Michał Kołodziejski
 */

import docsUrl from '../docsUrl'


function isDefaultImport(specifier) {
  if (specifier.type === 'ImportDefaultSpecifier') {
    return true
  } else if (specifier.type === 'ImportSpecifier' && specifier.imported.name === 'default') {
    return true
  }
  return false
}

function isCommonJSImport(declaration) {
  const variableInit = declaration.init
  if (variableInit.type === 'CallExpression') {
    return variableInit.callee.name === 'require'
  }
  return false
}

function handleImport(context, node, specifierOrDeclaration, packageName, importAlias) {
  const mappings = context.options[0] || {}

  if (Object.keys(mappings).indexOf(packageName) === -1) {
    return
  }

  if (mappings[packageName] !== importAlias) {
    context.report({
      node: node,
      message: `Default import from '${packageName}' should be aliased to `
              + `${mappings[packageName]}, not ${importAlias}`,
      fix: fixImportOrRequire(specifierOrDeclaration, mappings[packageName]),
    })

    let declaredVariables
    if (specifierOrDeclaration.type === 'VariableDeclarator') {
      declaredVariables = context.getDeclaredVariables(specifierOrDeclaration.parent)[0]
    } else {
      declaredVariables = context.getDeclaredVariables(specifierOrDeclaration)[0]
    }

    for (const variableReference of declaredVariables.references) {
      if (specifierOrDeclaration.type === 'VariableDeclarator' && variableReference.init) {
        continue
      }

      context.report({
        node: variableReference.identifier,
        message: `Using incorrect binding name '${variableReference.identifier.name}' `
                + `instead of ${mappings[packageName]} for `
                + `default import from package ${packageName}`,
        fix: fixer => {
          if (variableReference.identifier.parent.type !== 'ExportSpecifier') {
            return fixer.replaceText(variableReference.identifier, mappings[packageName])
          }
        },
      })
    }
  }
}

function fixImportOrRequire(node, text) {
  return function(fixer) {
    let newAlias = text
    let nodeOrToken
    if (node.type === 'VariableDeclarator') {
      nodeOrToken = node.id
      newAlias = text
    } else {
      nodeOrToken = node
      if (node.imported && node.imported.name === 'default') {
        newAlias = `default as ${text}`
      } else {
        newAlias = text
      }
    }

    return fixer.replaceText(nodeOrToken, newAlias)
  }
}

module.exports = {
  meta: {
    docs: {
      url: docsUrl('rename-default-import'),
      recommended: false,
    },
    schema: [
      {
        type: 'object',
      },
    ],
    fixable: 'code',
  },
  create: function(context) {
    return {
      'ImportDeclaration': function(node) {
        const {source, specifiers} = node
        const {options} = context

        if (options.length === 0 || Object.keys(options[0]).length === 0) {
          return
        }

        for (const specifier of specifiers) {
          if (!isDefaultImport(specifier)) {
            continue
          }

          handleImport(context, source, specifier, source.value, specifier.local.name)
        }
      },
      'VariableDeclaration': function(node) {
        const {declarations} = node
        const {options} = context

        if (options.length === 0 || Object.keys(options[0]).length === 0) {
          return
        }

        for (const declaration of declarations) {
          if (!isCommonJSImport(declaration)) {
            continue
          }

          handleImport(
            context,
            node,
            declaration,
            declaration.init.arguments[0].value,
            declaration.id.name
          )
        }
      },
    }
  },
}

1	/**
2	* @fileoverview Rule to enforce aliases for default imports
3	* @author Michał Kołodziejski
4	*/
5
6	import docsUrl from '../docsUrl'
7
8
9	function isDefaultImport(specifier) {
10	if (specifier.type === 'ImportDefaultSpecifier') {	20✔
11	return true	10✔
12	} else if (specifier.type === 'ImportSpecifier' && specifier.imported.name === 'default') {	10✔
13	return true	4✔
14	}
15	return false	6✔
16	}
17
18	function isCommonJSImport(declaration) {
19	const variableInit = declaration.init	12✔
20	if (variableInit.type === 'CallExpression') {	12✔
21	return variableInit.callee.name === 'require'	5✔
22	}
23	return false	7✔
24	}
25
26	function handleImport(context, node, specifierOrDeclaration, packageName, importAlias) {
27	const mappings = context.options[0] \|\| {}	17!
28
29	if (Object.keys(mappings).indexOf(packageName) === -1) {	17✔
30	return	1✔
31	}
32
33	if (mappings[packageName] !== importAlias) {	16✔
34	context.report({	11✔
35	node: node,
36	message: `Default import from '${packageName}' should be aliased to `
37	+ `${mappings[packageName]}, not ${importAlias}`,
38	fix: fixImportOrRequire(specifierOrDeclaration, mappings[packageName]),
39	})
40
41	let declaredVariables
42	if (specifierOrDeclaration.type === 'VariableDeclarator') {	11✔
43	declaredVariables = context.getDeclaredVariables(specifierOrDeclaration.parent)[0]	2✔
44	} else {
45	declaredVariables = context.getDeclaredVariables(specifierOrDeclaration)[0]	9✔
46	}
47
48	for (const variableReference of declaredVariables.references) {	11✔
49	if (specifierOrDeclaration.type === 'VariableDeclarator' && variableReference.init) {	11✔
50	continue	2✔
51	}
52
53	context.report({	9✔
54	node: variableReference.identifier,
55	message: `Using incorrect binding name '${variableReference.identifier.name}' `
56	+ `instead of ${mappings[packageName]} for `
57	+ `default import from package ${packageName}`,
58	fix: fixer => {
59	if (variableReference.identifier.parent.type !== 'ExportSpecifier') {	9✔
60	return fixer.replaceText(variableReference.identifier, mappings[packageName])	8✔
61	}
62	},
63	})
64	}
65	}
66	}
67
68	function fixImportOrRequire(node, text) {
69	return function(fixer) {	11✔
70	let newAlias = text	11✔
71	let nodeOrToken
72	if (node.type === 'VariableDeclarator') {	11✔
73	nodeOrToken = node.id	2✔
74	newAlias = text	2✔
75	} else {
76	nodeOrToken = node	9✔
77	if (node.imported && node.imported.name === 'default') {	9✔
78	newAlias = `default as ${text}`	2✔
79	} else {
80	newAlias = text	7✔
81	}
82	}
83
84	return fixer.replaceText(nodeOrToken, newAlias)	11✔
85	}
86	}
87
88	module.exports = {	1✔
89	meta: {
90	docs: {
91	url: docsUrl('rename-default-import'),
92	recommended: false,
93	},
94	schema: [
95	{
96	type: 'object',
97	},
98	],
99	fixable: 'code',
100	},
101	create: function(context) {
102	return {	20✔
103	'ImportDeclaration': function(node) {
104	const {source, specifiers} = node	17✔
105	const {options} = context	17✔
106
107	if (options.length === 0 \|\| Object.keys(options[0]).length === 0) {	17✔
108	return	1✔
109	}
110
111	for (const specifier of specifiers) {	16✔
112	if (!isDefaultImport(specifier)) {	20✔
113	continue	6✔
114	}
115
116	handleImport(context, source, specifier, source.value, specifier.local.name)	14✔
117	}
118	},
119	'VariableDeclaration': function(node) {
120	const {declarations} = node	12✔
121	const {options} = context	12✔
122
123	if (options.length === 0 \|\| Object.keys(options[0]).length === 0) {	12!
124	return	×
125	}
126
127	for (const declaration of declarations) {	12✔
128	if (!isCommonJSImport(declaration)) {	12✔
129	continue	9✔
130	}
131
132	handleImport(	3✔
133	context,
134	node,
135	declaration,
136	declaration.init.arguments[0].value,
137	declaration.id.name
138	)
139	}
140	},
141	}
142	},
143	}

benmosher / eslint-plugin-import / 19512361

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