170 lines
22 KiB
JavaScript
170 lines
22 KiB
JavaScript
|
'use strict';
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
var _minimatch = require('minimatch');var _minimatch2 = _interopRequireDefault(_minimatch);
|
||
|
|
var _docsUrl = require('../docsUrl');var _docsUrl2 = _interopRequireDefault(_docsUrl);function _interopRequireDefault(obj) {return obj && obj.__esModule ? obj : { 'default': obj };}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param {MemberExpression} memberExpression
|
||
|
|
* @returns {string} the name of the member in the object expression, e.g. the `x` in `namespace.x`
|
||
|
|
*/ /**
|
||
|
|
* @fileoverview Rule to disallow namespace import
|
||
|
|
* @author Radek Benkel
|
||
|
|
*/function getMemberPropertyName(memberExpression) {return memberExpression.property.type === 'Identifier' ? memberExpression.property.name :
|
||
|
|
memberExpression.property.value;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param {ScopeManager} scopeManager
|
||
|
|
* @param {ASTNode} node
|
||
|
|
* @return {Set<string>}
|
||
|
|
*/
|
||
|
|
function getVariableNamesInScope(scopeManager, node) {
|
||
|
|
var currentNode = node;
|
||
|
|
var scope = scopeManager.acquire(currentNode);
|
||
|
|
while (scope == null) {
|
||
|
|
currentNode = currentNode.parent;
|
||
|
|
scope = scopeManager.acquire(currentNode, true);
|
||
|
|
}
|
||
|
|
return new Set(scope.variables.concat(scope.upper.variables).map(function (variable) {return variable.name;}));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @param {*} names
|
||
|
|
* @param {*} nameConflicts
|
||
|
|
* @param {*} namespaceName
|
||
|
|
*/
|
||
|
|
function generateLocalNames(names, nameConflicts, namespaceName) {
|
||
|
|
var localNames = {};
|
||
|
|
names.forEach(function (name) {
|
||
|
|
var localName = void 0;
|
||
|
|
if (!nameConflicts[name].has(name)) {
|
||
|
|
localName = name;
|
||
|
|
} else if (!nameConflicts[name].has(String(namespaceName) + '_' + String(name))) {
|
||
|
|
localName = String(namespaceName) + '_' + String(name);
|
||
|
|
} else {
|
||
|
|
for (var i = 1; i < Infinity; i++) {
|
||
|
|
if (!nameConflicts[name].has(String(namespaceName) + '_' + String(name) + '_' + String(i))) {
|
||
|
|
localName = String(namespaceName) + '_' + String(name) + '_' + String(i);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
localNames[name] = localName;
|
||
|
|
});
|
||
|
|
return localNames;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param {Identifier[]} namespaceIdentifiers
|
||
|
|
* @returns {boolean} `true` if the namespace variable is more than just a glorified constant
|
||
|
|
*/
|
||
|
|
function usesNamespaceAsObject(namespaceIdentifiers) {
|
||
|
|
return !namespaceIdentifiers.every(function (identifier) {
|
||
|
|
var parent = identifier.parent;
|
||
|
|
|
||
|
|
// `namespace.x` or `namespace['x']`
|
||
|
|
return (
|
||
|
|
parent &&
|
||
|
|
parent.type === 'MemberExpression' && (
|
||
|
|
parent.property.type === 'Identifier' || parent.property.type === 'Literal'));
|
||
|
|
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = {
|
||
|
|
meta: {
|
||
|
|
type: 'suggestion',
|
||
|
|
docs: {
|
||
|
|
category: 'Style guide',
|
||
|
|
description: 'Forbid namespace (a.k.a. "wildcard" `*`) imports.',
|
||
|
|
url: (0, _docsUrl2['default'])('no-namespace') },
|
||
|
|
|
||
|
|
fixable: 'code',
|
||
|
|
schema: [{
|
||
|
|
type: 'object',
|
||
|
|
properties: {
|
||
|
|
ignore: {
|
||
|
|
type: 'array',
|
||
|
|
items: {
|
||
|
|
type: 'string' },
|
||
|
|
|
||
|
|
uniqueItems: true } } }] },
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
create: function () {function create(context) {
|
||
|
|
var firstOption = context.options[0] || {};
|
||
|
|
var ignoreGlobs = firstOption.ignore;
|
||
|
|
|
||
|
|
return {
|
||
|
|
ImportNamespaceSpecifier: function () {function ImportNamespaceSpecifier(node) {
|
||
|
|
if (ignoreGlobs && ignoreGlobs.find(function (glob) {return (0, _minimatch2['default'])(node.parent.source.value, glob, { matchBase: true });})) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
var scopeVariables = context.getScope().variables;
|
||
|
|
var namespaceVariable = scopeVariables.find(function (variable) {return variable.defs[0].node === node;});
|
||
|
|
var namespaceReferences = namespaceVariable.references;
|
||
|
|
var namespaceIdentifiers = namespaceReferences.map(function (reference) {return reference.identifier;});
|
||
|
|
var canFix = namespaceIdentifiers.length > 0 && !usesNamespaceAsObject(namespaceIdentifiers);
|
||
|
|
|
||
|
|
context.report({
|
||
|
|
node: node,
|
||
|
|
message: 'Unexpected namespace import.',
|
||
|
|
fix: canFix && function (fixer) {
|
||
|
|
var scopeManager = context.getSourceCode().scopeManager;
|
||
|
|
var fixes = [];
|
||
|
|
|
||
|
|
// Pass 1: Collect variable names that are already in scope for each reference we want
|
||
|
|
// to transform, so that we can be sure that we choose non-conflicting import names
|
||
|
|
var importNameConflicts = {};
|
||
|
|
namespaceIdentifiers.forEach(function (identifier) {
|
||
|
|
var parent = identifier.parent;
|
||
|
|
if (parent && parent.type === 'MemberExpression') {
|
||
|
|
var importName = getMemberPropertyName(parent);
|
||
|
|
var localConflicts = getVariableNamesInScope(scopeManager, parent);
|
||
|
|
if (!importNameConflicts[importName]) {
|
||
|
|
importNameConflicts[importName] = localConflicts;
|
||
|
|
} else {
|
||
|
|
localConflicts.forEach(function (c) {return importNameConflicts[importName].add(c);});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
// Choose new names for each import
|
||
|
|
var importNames = Object.keys(importNameConflicts);
|
||
|
|
var importLocalNames = generateLocalNames(
|
||
|
|
importNames,
|
||
|
|
importNameConflicts,
|
||
|
|
namespaceVariable.name);
|
||
|
|
|
||
|
|
|
||
|
|
// Replace the ImportNamespaceSpecifier with a list of ImportSpecifiers
|
||
|
|
var namedImportSpecifiers = importNames.map(function (importName) {return importName === importLocalNames[importName] ?
|
||
|
|
importName : String(
|
||
|
|
importName) + ' as ' + String(importLocalNames[importName]);});
|
||
|
|
|
||
|
|
fixes.push(fixer.replaceText(node, '{ ' + String(namedImportSpecifiers.join(', ')) + ' }'));
|
||
|
|
|
||
|
|
// Pass 2: Replace references to the namespace with references to the named imports
|
||
|
|
namespaceIdentifiers.forEach(function (identifier) {
|
||
|
|
var parent = identifier.parent;
|
||
|
|
if (parent && parent.type === 'MemberExpression') {
|
||
|
|
var importName = getMemberPropertyName(parent);
|
||
|
|
fixes.push(fixer.replaceText(parent, importLocalNames[importName]));
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
return fixes;
|
||
|
|
} });
|
||
|
|
|
||
|
|
}return ImportNamespaceSpecifier;}() };
|
||
|
|
|
||
|
|
}return create;}() };
|
||
|
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9uby1uYW1lc3BhY2UuanMiXSwibmFtZXMiOlsiZ2V0TWVtYmVyUHJvcGVydHlOYW1lIiwibWVtYmVyRXhwcmVzc2lvbiIsInByb3BlcnR5IiwidHlwZSIsIm5hbWUiLCJ2YWx1ZSIsImdldFZhcmlhYmxlTmFtZXNJblNjb3BlIiwic2NvcGVNYW5hZ2VyIiwibm9kZSIsImN1cnJlbnROb2RlIiwic2NvcGUiLCJhY3F1aXJlIiwicGFyZW50IiwiU2V0IiwidmFyaWFibGVzIiwiY29uY2F0IiwidXBwZXIiLCJtYXAiLCJ2YXJpYWJsZSIsImdlbmVyYXRlTG9jYWxOYW1lcyIsIm5hbWVzIiwibmFtZUNvbmZsaWN0cyIsIm5hbWVzcGFjZU5hbWUiLCJsb2NhbE5hbWVzIiwiZm9yRWFjaCIsImxvY2FsTmFtZSIsImhhcyIsImkiLCJJbmZpbml0eSIsInVzZXNOYW1lc3BhY2VBc09iamVjdCIsIm5hbWVzcGFjZUlkZW50aWZpZXJzIiwiZXZlcnkiLCJpZGVudGlmaWVyIiwibW9kdWxlIiwiZXhwb3J0cyIsIm1ldGEiLCJkb2NzIiwiY2F0ZWdvcnkiLCJkZXNjcmlwdGlvbiIsInVybCIsImZpeGFibGUiLCJzY2hlbWEiLCJwcm9wZXJ0aWVzIiwiaWdub3JlIiwiaXRlbXMiLCJ1bmlxdWVJdGVtcyIsImNyZWF0ZSIsImNvbnRleHQiLCJmaXJzdE9wdGlvbiIsIm9wdGlvbnMiLCJpZ25vcmVHbG9icyIsIkltcG9ydE5hbWVzcGFjZVNwZWNpZmllciIsImZpbmQiLCJnbG9iIiwic291cmNlIiwibWF0Y2hCYXNlIiwic2NvcGVWYXJpYWJsZXMiLCJnZXRTY29wZSIsIm5hbWVzcGFjZVZhcmlhYmxlIiwiZGVmcyIsIm5hbWVzcGFjZVJlZmVyZW5jZXMiLCJyZWZlcmVuY2VzIiwicmVmZXJlbmNlIiwiY2FuRml4IiwibGVuZ3RoIiwicmVwb3J0IiwibWVzc2FnZSIsImZpeCIsImZpeGVyIiwiZ2V0U291cmNlQ29kZSIsImZpeGVzIiwiaW1wb3J0TmFtZUNvbmZsaWN0cyIsImltcG9ydE5hbWUiLCJsb2NhbENvbmZsaWN0cyIsImMiLCJhZGQiLCJpbXBvcnROYW1lcyIsIk9iamVjdCIsImtleXMiLCJpbXBvcnRMb2NhbE5hbWVzIiwibmFtZWRJbXBvcnRTcGVjaWZpZXJzIiwicHVzaCIsInJlcGxhY2VUZXh0Iiwiam9pbiJdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFLQSxzQztBQUNBLHFDOztBQUVBOzs7MExBUkE7Ozs2TEFZQSxTQUFTQSxxQkFBVCxDQUErQkMsZ0JBQS9CLEVBQWlELENBQy9DLE9BQU9BLGlCQUFpQkMsUUFBakIsQ0FBMEJDLElBQTFCLEtBQW1DLFlBQW5DLEdBQ0hGLGlCQUFpQkMsUUFBakIsQ0FBMEJFLElBRHZCO0FBRUhILG1CQUFpQkMsUUFBakIsQ0FBMEJHLEtBRjlCO0FBR0Q7O0FBRUQ7Ozs7O0FBS0EsU0FBU0MsdUJBQVQsQ0FBaUNDLFlBQWpDLEVBQStDQyxJQUEvQyxFQUFxRDtBQUNuRCxNQUFJQyxjQUFjRCxJQUFsQjtBQUNBLE1BQUlFLFFBQVFILGFBQWFJLE9BQWIsQ0FBcUJGLFdBQXJCLENBQVo7QUFDQSxTQUFPQyxTQUFTLElBQWhCLEVBQXNCO0FBQ3BCRCxrQkFBY0EsWUFBWUcsTUFBMUI7QUFDQUYsWUFBUUgsYUFBYUksT0FBYixDQUFxQkYsV0FBckIsRUFBa0MsSUFBbEMsQ0FBUjtBQUNEO0FBQ0QsU0FBTyxJQUFJSSxHQUFKLENBQVFILE1BQU1JLFNBQU4sQ0FBZ0JDLE1BQWhCLENBQXVCTCxNQUFNTSxLQUFOLENBQVlGLFNBQW5DLEVBQThDRyxHQUE5QyxDQUFrRCxVQUFDQyxRQUFELFVBQWNBLFNBQVNkLElBQXZCLEVBQWxELENBQVIsQ0FBUDtBQUNEOztBQUVEOzs7Ozs7QUFNQSxTQUFTZSxrQkFBVCxDQUE0QkMsS0FBNUIsRUFBbUNDLGFBQW5DLEVBQWtEQyxhQUFsRCxFQUFpRTtBQUMvRCxNQUFNQyxhQUFhLEVBQW5CO0FBQ0FILFFBQU1JLE9BQU4sQ0FBYyxVQUFDcEIsSUFBRCxFQUFVO0FBQ3RCLFFBQUlxQixrQkFBSjtBQUNBLFFBQUksQ0FBQ0osY0FBY2pCLElBQWQsRUFBb0JzQixHQUFwQixDQUF3QnRCLElBQXhCLENBQUwsRUFBb0M7QUFDbENxQixrQkFBWXJCLElBQVo7QUFDRCxLQUZELE1BRU8sSUFBSSxDQUFDaUIsY0FBY2pCLElBQWQsRUFBb0JzQixHQUFwQixRQUEyQkosYUFBM0IsaUJBQTRDbEIsSUFBNUMsRUFBTCxFQUEwRDtBQUMvRHFCLHlCQUFlSCxhQUFmLGlCQUFnQ2xCLElBQWhDO0FBQ0QsS0FGTSxNQUVBO0FBQ0wsV0FBSyxJQUFJdUIsSUFBSSxDQUFiLEVBQWdCQSxJQUFJQyxRQUFwQixFQUE4QkQsR0FBOUIsRUFBbUM7QUFDakMsWUFBSSxDQUFDTixjQUFjakIsSUFBZCxFQUFvQnNCLEdBQXBCLFFBQTJCSixhQUEzQixpQkFBNENsQixJQUE1QyxpQkFBb0R1QixDQUFwRCxFQUFMLEVBQStEO0FBQzdERiw2QkFBZUgsYUFBZixpQkFBZ0NsQixJQUFoQyxpQkFBd0N1QixDQUF4QztBQUNBO0FBQ0Q7QUFDRjtBQUNGO0FBQ0RKLGVBQVduQixJQUFYLElBQW1CcUIsU0FBbkI7QUFDRCxHQWZEO0FBZ0JBLFNBQU9GLFVBQVA7QUFDRDs7QUFFRDs7OztBQUlBLFNBQVNNLHFCQUFULENBQStCQyxvQkFBL0IsRUFBcUQ7QUFDbkQsU0FBTyxDQUFDQSxxQkFBcUJDLEtBQXJCLENBQTJCLFVBQUNDLFVBQUQsRUFBZ0I7QUFDakQsUUFBTXBCLFNBQVNvQixXQUFXcEIsTUFBMUI7O0FBRUE7QUFDQTtBQUNFQTtBQUNHQSxhQUFPVCxJQUFQLEtBQWdCLGtCQURuQjtBQUVJUyxhQUFPVixRQUFQLENBQWdCQyxJQUFoQixLQUF5QixZQUF6QixJQUF5Q1MsT0FBT1YsUUFBUCxDQUFnQkMsSUFBaEIsS0FBeUIsU0FGdEUsQ0FERjs7QUFLRCxHQVRPLENBQVI7QUFVRDs7QUFFRDhCLE9BQU9DLE9BQVAsR0FBaUI7QUFDZkMsUUFBTTtBQUNKaEMsVUFBTSxZQURGO0FBRUppQyxVQUFNO0FBQ0pDLGdCQUFVLGFBRE47QUFFSkMsbUJBQWEsbURBRlQ7QUFHSkMsV0FBSywwQkFBUSxjQUFSLENBSEQsRUFGRjs7QUFPSkMsYUFBUyxNQVBMO0FBUUpDLFlBQVEsQ0FBQztBQUNQdEMsWUFBTSxRQURDO0FBRVB1QyxrQkFBWTtBQUNWQyxnQkFBUTtBQUNOeEMsZ0JBQU0sT0FEQTtBQUVOeUMsaUJBQU87QUFDTHpDLGtCQUFNLFFBREQsRUFGRDs7QUFLTjBDLHVCQUFhLElBTFAsRUFERSxFQUZMLEVBQUQsQ0FSSixFQURTOzs7Ozs7QUF1QmZDLFFBdkJlLCtCQXVCUkMsT0F2QlEsRUF1QkM7QUFDZCxVQUFNQyxjQUFjRCxRQUFRRSxPQUFSLENBQWdCLENBQWhCLEtBQXNCLEVBQTFDO0F
|