158 lines
22 KiB
JavaScript
158 lines
22 KiB
JavaScript
|
'use strict';var _slicedToArray = function () {function sliceIterator(arr, i) {var _arr = [];var _n = true;var _d = false;var _e = undefined;try {for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {_arr.push(_s.value);if (i && _arr.length === i) break;}} catch (err) {_d = true;_e = err;} finally {try {if (!_n && _i["return"]) _i["return"]();} finally {if (_d) throw _e;}}return _arr;}return function (arr, i) {if (Array.isArray(arr)) {return arr;} else if (Symbol.iterator in Object(arr)) {return sliceIterator(arr, i);} else {throw new TypeError("Invalid attempt to destructure non-iterable instance");}};}(); /**
|
||
|
|
* @fileOverview Ensures that no imported module imports the linted module.
|
||
|
|
* @author Ben Mosher
|
||
|
|
*/
|
||
|
|
|
||
|
|
var _resolve = require('eslint-module-utils/resolve');var _resolve2 = _interopRequireDefault(_resolve);
|
||
|
|
var _ExportMap = require('../ExportMap');var _ExportMap2 = _interopRequireDefault(_ExportMap);
|
||
|
|
var _importType = require('../core/importType');
|
||
|
|
var _moduleVisitor = require('eslint-module-utils/moduleVisitor');var _moduleVisitor2 = _interopRequireDefault(_moduleVisitor);
|
||
|
|
var _docsUrl = require('../docsUrl');var _docsUrl2 = _interopRequireDefault(_docsUrl);function _interopRequireDefault(obj) {return obj && obj.__esModule ? obj : { 'default': obj };}function _toConsumableArray(arr) {if (Array.isArray(arr)) {for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) {arr2[i] = arr[i];}return arr2;} else {return Array.from(arr);}}
|
||
|
|
|
||
|
|
var traversed = new Set();
|
||
|
|
|
||
|
|
module.exports = {
|
||
|
|
meta: {
|
||
|
|
type: 'suggestion',
|
||
|
|
docs: {
|
||
|
|
category: 'Static analysis',
|
||
|
|
description: 'Forbid a module from importing a module with a dependency path back to itself.',
|
||
|
|
url: (0, _docsUrl2['default'])('no-cycle') },
|
||
|
|
|
||
|
|
schema: [(0, _moduleVisitor.makeOptionsSchema)({
|
||
|
|
maxDepth: {
|
||
|
|
anyOf: [
|
||
|
|
{
|
||
|
|
description: 'maximum dependency depth to traverse',
|
||
|
|
type: 'integer',
|
||
|
|
minimum: 1 },
|
||
|
|
|
||
|
|
{
|
||
|
|
'enum': ['∞'],
|
||
|
|
type: 'string' }] },
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
ignoreExternal: {
|
||
|
|
description: 'ignore external modules',
|
||
|
|
type: 'boolean',
|
||
|
|
'default': false },
|
||
|
|
|
||
|
|
allowUnsafeDynamicCyclicDependency: {
|
||
|
|
description: 'Allow cyclic dependency if there is at least one dynamic import in the chain',
|
||
|
|
type: 'boolean',
|
||
|
|
'default': false } })] },
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
create: function () {function create(context) {
|
||
|
|
var myPath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
|
||
|
|
if (myPath === '<text>') {return {};} // can't cycle-check a non-file
|
||
|
|
|
||
|
|
var options = context.options[0] || {};
|
||
|
|
var maxDepth = typeof options.maxDepth === 'number' ? options.maxDepth : Infinity;
|
||
|
|
var ignoreModule = function () {function ignoreModule(name) {return options.ignoreExternal && (0, _importType.isExternalModule)(
|
||
|
|
name,
|
||
|
|
(0, _resolve2['default'])(name, context),
|
||
|
|
context);}return ignoreModule;}();
|
||
|
|
|
||
|
|
|
||
|
|
function checkSourceValue(sourceNode, importer) {
|
||
|
|
if (ignoreModule(sourceNode.value)) {
|
||
|
|
return; // ignore external modules
|
||
|
|
}
|
||
|
|
if (
|
||
|
|
options.allowUnsafeDynamicCyclicDependency && (
|
||
|
|
// Ignore `import()`
|
||
|
|
importer.type === 'ImportExpression'
|
||
|
|
// `require()` calls are always checked (if possible)
|
||
|
|
|| importer.type === 'CallExpression' && importer.callee.name !== 'require'))
|
||
|
|
|
||
|
|
{
|
||
|
|
return; // cycle via dynamic import allowed by config
|
||
|
|
}
|
||
|
|
|
||
|
|
if (
|
||
|
|
importer.type === 'ImportDeclaration' && (
|
||
|
|
// import type { Foo } (TS and Flow)
|
||
|
|
importer.importKind === 'type'
|
||
|
|
// import { type Foo } (Flow)
|
||
|
|
|| importer.specifiers.every(function (_ref) {var importKind = _ref.importKind;return importKind === 'type';})))
|
||
|
|
|
||
|
|
{
|
||
|
|
return; // ignore type imports
|
||
|
|
}
|
||
|
|
|
||
|
|
var imported = _ExportMap2['default'].get(sourceNode.value, context);
|
||
|
|
|
||
|
|
if (imported == null) {
|
||
|
|
return; // no-unresolved territory
|
||
|
|
}
|
||
|
|
|
||
|
|
if (imported.path === myPath) {
|
||
|
|
return; // no-self-import territory
|
||
|
|
}
|
||
|
|
|
||
|
|
var untraversed = [{ mget: function () {function mget() {return imported;}return mget;}(), route: [] }];
|
||
|
|
function detectCycle(_ref2) {var mget = _ref2.mget,route = _ref2.route;
|
||
|
|
var m = mget();
|
||
|
|
if (m == null) {return;}
|
||
|
|
if (traversed.has(m.path)) {return;}
|
||
|
|
traversed.add(m.path);var _iteratorNormalCompletion = true;var _didIteratorError = false;var _iteratorError = undefined;try {
|
||
|
|
|
||
|
|
for (var _iterator = m.imports[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {var _ref3 = _step.value;var _ref4 = _slicedToArray(_ref3, 2);var path = _ref4[0];var _ref4$ = _ref4[1];var getter = _ref4$.getter;var declarations = _ref4$.declarations;
|
||
|
|
if (traversed.has(path)) {continue;}
|
||
|
|
var toTraverse = [].concat(_toConsumableArray(declarations)).filter(function (_ref5) {var source = _ref5.source,isOnlyImportingTypes = _ref5.isOnlyImportingTypes;return !ignoreModule(source.value)
|
||
|
|
// Ignore only type imports
|
||
|
|
&& !isOnlyImportingTypes;});
|
||
|
|
|
||
|
|
|
||
|
|
/*
|
||
|
|
If cyclic dependency is allowed via dynamic import, skip checking if any module is imported dynamically
|
||
|
|
*/
|
||
|
|
if (options.allowUnsafeDynamicCyclicDependency && toTraverse.some(function (d) {return d.dynamic;})) {return;}
|
||
|
|
|
||
|
|
/*
|
||
|
|
Only report as a cycle if there are any import declarations that are considered by
|
||
|
|
the rule. For example:
|
||
|
|
a.ts:
|
||
|
|
import { foo } from './b' // should not be reported as a cycle
|
||
|
|
b.ts:
|
||
|
|
import type { Bar } from './a'
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
if (path === myPath && toTraverse.length > 0) {return true;}
|
||
|
|
if (route.length + 1 < maxDepth) {var _iteratorNormalCompletion2 = true;var _didIteratorError2 = false;var _iteratorError2 = undefined;try {
|
||
|
|
for (var _iterator2 = toTraverse[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {var _ref6 = _step2.value;var source = _ref6.source;
|
||
|
|
untraversed.push({ mget: getter, route: route.concat(source) });
|
||
|
|
}} catch (err) {_didIteratorError2 = true;_iteratorError2 = err;} finally {try {if (!_iteratorNormalCompletion2 && _iterator2['return']) {_iterator2['return']();}} finally {if (_didIteratorError2) {throw _iteratorError2;}}}
|
||
|
|
}
|
||
|
|
}} catch (err) {_didIteratorError = true;_iteratorError = err;} finally {try {if (!_iteratorNormalCompletion && _iterator['return']) {_iterator['return']();}} finally {if (_didIteratorError) {throw _iteratorError;}}}
|
||
|
|
}
|
||
|
|
|
||
|
|
while (untraversed.length > 0) {
|
||
|
|
var next = untraversed.shift(); // bfs!
|
||
|
|
if (detectCycle(next)) {
|
||
|
|
var message = next.route.length > 0 ? 'Dependency cycle via ' + String(
|
||
|
|
routeString(next.route)) :
|
||
|
|
'Dependency cycle detected.';
|
||
|
|
context.report(importer, message);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return Object.assign((0, _moduleVisitor2['default'])(checkSourceValue, context.options[0]), {
|
||
|
|
'Program:exit': function () {function ProgramExit() {
|
||
|
|
traversed.clear();
|
||
|
|
}return ProgramExit;}() });
|
||
|
|
|
||
|
|
}return create;}() };
|
||
|
|
|
||
|
|
|
||
|
|
function routeString(route) {
|
||
|
|
return route.map(function (s) {return String(s.value) + ':' + String(s.loc.start.line);}).join('=>');
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9uby1jeWNsZS5qcyJdLCJuYW1lcyI6WyJ0cmF2ZXJzZWQiLCJTZXQiLCJtb2R1bGUiLCJleHBvcnRzIiwibWV0YSIsInR5cGUiLCJkb2NzIiwiY2F0ZWdvcnkiLCJkZXNjcmlwdGlvbiIsInVybCIsInNjaGVtYSIsIm1heERlcHRoIiwiYW55T2YiLCJtaW5pbXVtIiwiaWdub3JlRXh0ZXJuYWwiLCJhbGxvd1Vuc2FmZUR5bmFtaWNDeWNsaWNEZXBlbmRlbmN5IiwiY3JlYXRlIiwiY29udGV4dCIsIm15UGF0aCIsImdldFBoeXNpY2FsRmlsZW5hbWUiLCJnZXRGaWxlbmFtZSIsIm9wdGlvbnMiLCJJbmZpbml0eSIsImlnbm9yZU1vZHVsZSIsIm5hbWUiLCJjaGVja1NvdXJjZVZhbHVlIiwic291cmNlTm9kZSIsImltcG9ydGVyIiwidmFsdWUiLCJjYWxsZWUiLCJpbXBvcnRLaW5kIiwic3BlY2lmaWVycyIsImV2ZXJ5IiwiaW1wb3J0ZWQiLCJFeHBvcnRzIiwiZ2V0IiwicGF0aCIsInVudHJhdmVyc2VkIiwibWdldCIsInJvdXRlIiwiZGV0ZWN0Q3ljbGUiLCJtIiwiaGFzIiwiYWRkIiwiaW1wb3J0cyIsImdldHRlciIsImRlY2xhcmF0aW9ucyIsInRvVHJhdmVyc2UiLCJmaWx0ZXIiLCJzb3VyY2UiLCJpc09ubHlJbXBvcnRpbmdUeXBlcyIsInNvbWUiLCJkIiwiZHluYW1pYyIsImxlbmd0aCIsInB1c2giLCJjb25jYXQiLCJuZXh0Iiwic2hpZnQiLCJtZXNzYWdlIiwicm91dGVTdHJpbmciLCJyZXBvcnQiLCJPYmplY3QiLCJhc3NpZ24iLCJjbGVhciIsIm1hcCIsInMiLCJsb2MiLCJzdGFydCIsImxpbmUiLCJqb2luIl0sIm1hcHBpbmdzIjoic29CQUFBOzs7OztBQUtBLHNEO0FBQ0EseUM7QUFDQTtBQUNBLGtFO0FBQ0EscUM7O0FBRUEsSUFBTUEsWUFBWSxJQUFJQyxHQUFKLEVBQWxCOztBQUVBQyxPQUFPQyxPQUFQLEdBQWlCO0FBQ2ZDLFFBQU07QUFDSkMsVUFBTSxZQURGO0FBRUpDLFVBQU07QUFDSkMsZ0JBQVUsaUJBRE47QUFFSkMsbUJBQWEsZ0ZBRlQ7QUFHSkMsV0FBSywwQkFBUSxVQUFSLENBSEQsRUFGRjs7QUFPSkMsWUFBUSxDQUFDLHNDQUFrQjtBQUN6QkMsZ0JBQVU7QUFDUkMsZUFBTztBQUNMO0FBQ0VKLHVCQUFhLHNDQURmO0FBRUVILGdCQUFNLFNBRlI7QUFHRVEsbUJBQVMsQ0FIWCxFQURLOztBQU1MO0FBQ0Usa0JBQU0sQ0FBQyxHQUFELENBRFI7QUFFRVIsZ0JBQU0sUUFGUixFQU5LLENBREMsRUFEZTs7OztBQWN6QlMsc0JBQWdCO0FBQ2ROLHFCQUFhLHlCQURDO0FBRWRILGNBQU0sU0FGUTtBQUdkLG1CQUFTLEtBSEssRUFkUzs7QUFtQnpCVSwwQ0FBb0M7QUFDbENQLHFCQUFhLDhFQURxQjtBQUVsQ0gsY0FBTSxTQUY0QjtBQUdsQyxtQkFBUyxLQUh5QixFQW5CWCxFQUFsQixDQUFELENBUEosRUFEUzs7Ozs7QUFtQ2ZXLFFBbkNlLCtCQW1DUkMsT0FuQ1EsRUFtQ0M7QUFDZCxVQUFNQyxTQUFTRCxRQUFRRSxtQkFBUixHQUE4QkYsUUFBUUUsbUJBQVIsRUFBOUIsR0FBOERGLFFBQVFHLFdBQVIsRUFBN0U7QUFDQSxVQUFJRixXQUFXLFFBQWYsRUFBeUIsQ0FBRSxPQUFPLEVBQVAsQ0FBWSxDQUZ6QixDQUUwQjs7QUFFeEMsVUFBTUcsVUFBVUosUUFBUUksT0FBUixDQUFnQixDQUFoQixLQUFzQixFQUF0QztBQUNBLFVBQU1WLFdBQVcsT0FBT1UsUUFBUVYsUUFBZixLQUE0QixRQUE1QixHQUF1Q1UsUUFBUVYsUUFBL0MsR0FBMERXLFFBQTNFO0FBQ0EsVUFBTUMsNEJBQWUsU0FBZkEsWUFBZSxDQUFDQyxJQUFELFVBQVVILFFBQVFQLGNBQVIsSUFBMEI7QUFDdkRVLGNBRHVEO0FBRXZELG9DQUFRQSxJQUFSLEVBQWNQLE9BQWQsQ0FGdUQ7QUFHdkRBLGlCQUh1RCxDQUFwQyxFQUFmLHVCQUFOOzs7QUFNQSxlQUFTUSxnQkFBVCxDQUEwQkMsVUFBMUIsRUFBc0NDLFFBQXRDLEVBQWdEO0FBQzlDLFlBQUlKLGFBQWFHLFdBQVdFLEtBQXhCLENBQUosRUFBb0M7QUFDbEMsaUJBRGtDLENBQzFCO0FBQ1Q7QUFDRDtBQUNFUCxnQkFBUU4sa0NBQVI7QUFDRTtBQUNBWSxpQkFBU3RCLElBQVQsS0FBa0I7QUFDbEI7QUFEQSxXQUVHc0IsU0FBU3RCLElBQVQsS0FBa0IsZ0JBQWxCLElBQXNDc0IsU0FBU0UsTUFBVCxDQUFnQkwsSUFBaEIsS0FBeUIsU0FKcEUsQ0FERjs7QUFPRTtBQUNBLGlCQURBLENBQ1E7QUFDVDs7QUFFRDtBQUNFRyxpQkFBU3RCLElBQVQsS0FBa0IsbUJBQWxCO0FBQ0U7QUFDQXNCLGlCQUFTRyxVQUFULEtBQXdCO0FBQ3hCO0FBREEsV0FFR0gsU0FBU0ksVUFBVCxDQUFvQkMsS0FBcEIsQ0FBMEIscUJBQUdGLFVBQUgsUUFBR0EsVUFBSCxRQUFvQkEsZUFBZSxNQUFuQyxFQUExQixDQUpMLENBREY7O0FBT0U7QUFDQSxpQkFEQSxDQUNRO0FBQ1Q7O0FBRUQsWUFBTUcsV0FBV0MsdUJBQVFDLEdBQVIsQ0FBWVQsV0FBV0UsS0FBdkIsRUFBOEJYLE9BQTlCLENBQWpCOztBQUVBLFlBQUlnQixZQUFZLElBQWhCLEVBQXNCO0FBQ3BCLGlCQURvQixDQUNYO0FBQ1Y7O0FBRUQsWUFBSUEsU0FBU0csSUFBVCxLQUFrQmxCLE1BQXRCLEVBQThCO0FBQzVCLGlCQUQ0QixDQUNuQjtBQUNWOztBQUVELFlBQU1tQixjQUFjLENBQUMsRUFBRUMsbUJBQU0sd0JBQU1MLFFBQU4sRUFBTixlQUFGLEVBQXdCTSxPQUFPLEVBQS9CLEVBQUQsQ0FBcEI7QUFDQSxpQkFBU0MsV0FBVCxRQUFzQyxLQUFmRixJQUFlLFNBQWZBLElBQWUsQ0FBVEMsS0FBUyxTQUFUQSxLQUFTO0FBQ3BDLGNBQU1FLElBQUlILE1BQVY7QUFDQSxjQUFJRyxLQUFLLElBQVQsRUFBZSxDQUFFLE9BQVM7QUFDMUIsY0FBSXpDLFVBQVUwQyxHQUFWLENBQWNELEVBQUVMLElBQWhCLENBQUosRUFBMkIsQ0FBRSxPQUFTO0FBQ3RDcEMsb0JBQVUyQyxHQUFWLENBQWNGLEVBQUVMLElBQWhCLEVBSm9DOztBQU1wQyxpQ0FBK0NLLEVBQUVHLE9BQWpELDhIQUEwRCxrRUFBOUNSLElBQThDLHNDQUF0Q1MsTUFBc0MsVUFBdENBLE1BQXNDLEtBQTlCQyxZQUE4QixVQUE5QkEsWUFBOEI7QUFDeEQsa0JBQUk5QyxVQUFVMEMsR0FBVixDQUFjTixJQUFkLENBQUosRUFBeUIsQ0FBRSxTQUFXO0FBQ3RDLGtCQUFNVyxhQUFhLDZCQUFJRCxZQUFKLEdBQWtCRSxNQUFsQixDQUF5QixzQkFBR0MsTUFBSCxTQUFHQSx
|