2020-08-26 01:57:08 +02:00
|
|
|
'use strict';
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
var _staticRequire = require('../core/staticRequire');var _staticRequire2 = _interopRequireDefault(_staticRequire);
|
|
|
|
var _docsUrl = require('../docsUrl');var _docsUrl2 = _interopRequireDefault(_docsUrl);
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
var _debug = require('debug');var _debug2 = _interopRequireDefault(_debug);function _interopRequireDefault(obj) {return obj && obj.__esModule ? obj : { 'default': obj };}
|
|
|
|
var log = (0, _debug2['default'])('eslint-plugin-import:rules:newline-after-import');
|
2020-08-26 01:57:08 +02:00
|
|
|
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
// Rule Definition
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/**
|
|
|
|
* @fileoverview Rule to enforce new line after import not followed by another import.
|
|
|
|
* @author Radek Benkel
|
|
|
|
*/function containsNodeOrEqual(outerNode, innerNode) {return outerNode.range[0] <= innerNode.range[0] && outerNode.range[1] >= innerNode.range[1];}
|
|
|
|
|
|
|
|
function getScopeBody(scope) {
|
|
|
|
if (scope.block.type === 'SwitchStatement') {
|
|
|
|
log('SwitchStatement scopes not supported');
|
|
|
|
return null;
|
2022-11-10 11:43:16 +01:00
|
|
|
}var
|
2020-08-26 01:57:08 +02:00
|
|
|
|
|
|
|
body = scope.block.body;
|
|
|
|
if (body && body.type === 'BlockStatement') {
|
|
|
|
return body.body;
|
|
|
|
}
|
|
|
|
|
|
|
|
return body;
|
|
|
|
}
|
|
|
|
|
|
|
|
function findNodeIndexInScopeBody(body, nodeToFind) {
|
2022-11-10 11:43:16 +01:00
|
|
|
return body.findIndex(function (node) {return containsNodeOrEqual(node, nodeToFind);});
|
2020-08-26 01:57:08 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
function getLineDifference(node, nextNode) {
|
|
|
|
return nextNode.loc.start.line - node.loc.end.line;
|
|
|
|
}
|
|
|
|
|
|
|
|
function isClassWithDecorator(node) {
|
|
|
|
return node.type === 'ClassDeclaration' && node.decorators && node.decorators.length;
|
|
|
|
}
|
|
|
|
|
|
|
|
function isExportDefaultClass(node) {
|
|
|
|
return node.type === 'ExportDefaultDeclaration' && node.declaration.type === 'ClassDeclaration';
|
|
|
|
}
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
function isExportNameClass(node) {
|
|
|
|
|
|
|
|
return node.type === 'ExportNamedDeclaration' && node.declaration && node.declaration.type === 'ClassDeclaration';
|
|
|
|
}
|
|
|
|
|
2020-08-26 01:57:08 +02:00
|
|
|
module.exports = {
|
|
|
|
meta: {
|
|
|
|
type: 'layout',
|
|
|
|
docs: {
|
2022-11-10 11:43:16 +01:00
|
|
|
url: (0, _docsUrl2['default'])('newline-after-import') },
|
2020-08-26 01:57:08 +02:00
|
|
|
|
|
|
|
fixable: 'whitespace',
|
|
|
|
schema: [
|
|
|
|
{
|
|
|
|
'type': 'object',
|
|
|
|
'properties': {
|
|
|
|
'count': {
|
|
|
|
'type': 'integer',
|
|
|
|
'minimum': 1 } },
|
|
|
|
|
|
|
|
|
|
|
|
'additionalProperties': false }] },
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
create: function () {function create(context) {
|
|
|
|
var level = 0;
|
|
|
|
var requireCalls = [];
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
function checkForNewLine(node, nextNode, type) {
|
|
|
|
if (isExportDefaultClass(nextNode) || isExportNameClass(nextNode)) {
|
|
|
|
var classNode = nextNode.declaration;
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
if (isClassWithDecorator(classNode)) {
|
|
|
|
nextNode = classNode.decorators[0];
|
|
|
|
}
|
|
|
|
} else if (isClassWithDecorator(nextNode)) {
|
|
|
|
nextNode = nextNode.decorators[0];
|
2020-08-26 01:57:08 +02:00
|
|
|
}
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
var options = context.options[0] || { count: 1 };
|
|
|
|
var lineDifference = getLineDifference(node, nextNode);
|
|
|
|
var EXPECTED_LINE_DIFFERENCE = options.count + 1;
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
if (lineDifference < EXPECTED_LINE_DIFFERENCE) {
|
|
|
|
var column = node.loc.start.column;
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
if (node.loc.start.line !== node.loc.end.line) {
|
|
|
|
column = 0;
|
|
|
|
}
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
context.report({
|
|
|
|
loc: {
|
|
|
|
line: node.loc.end.line,
|
|
|
|
column: column },
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
message: 'Expected ' + String(options.count) + ' empty line' + (options.count > 1 ? 's' : '') + ' after ' + String(
|
|
|
|
type) + ' statement not followed by another ' + String(type) + '.',
|
|
|
|
fix: function () {function fix(fixer) {return fixer.insertTextAfter(
|
|
|
|
node,
|
|
|
|
'\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference));}return fix;}() });
|
2020-08-26 01:57:08 +02:00
|
|
|
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
}
|
2020-08-26 01:57:08 +02:00
|
|
|
}
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
function incrementLevel() {
|
|
|
|
level++;
|
|
|
|
}
|
|
|
|
function decrementLevel() {
|
|
|
|
level--;
|
2020-08-26 01:57:08 +02:00
|
|
|
}
|
2022-11-10 11:43:16 +01:00
|
|
|
|
|
|
|
function checkImport(node) {var
|
|
|
|
parent = node.parent;
|
|
|
|
var nodePosition = parent.body.indexOf(node);
|
|
|
|
var nextNode = parent.body[nodePosition + 1];
|
|
|
|
|
|
|
|
// skip "export import"s
|
|
|
|
if (node.type === 'TSImportEqualsDeclaration' && node.isExport) {
|
|
|
|
return;
|
2020-08-26 01:57:08 +02:00
|
|
|
}
|
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
if (nextNode && nextNode.type !== 'ImportDeclaration' && (nextNode.type !== 'TSImportEqualsDeclaration' || nextNode.isExport)) {
|
|
|
|
checkForNewLine(node, nextNode, 'import');
|
|
|
|
}
|
|
|
|
}
|
2020-08-26 01:57:08 +02:00
|
|
|
|
2022-11-10 11:43:16 +01:00
|
|
|
return {
|
|
|
|
ImportDeclaration: checkImport,
|
|
|
|
TSImportEqualsDeclaration: checkImport,
|
|
|
|
CallExpression: function () {function CallExpression(node) {
|
|
|
|
if ((0, _staticRequire2['default'])(node) && level === 0) {
|
|
|
|
requireCalls.push(node);
|
|
|
|
}
|
|
|
|
}return CallExpression;}(),
|
|
|
|
'Program:exit': function () {function ProgramExit() {
|
|
|
|
log('exit processing for', context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename());
|
|
|
|
var scopeBody = getScopeBody(context.getScope());
|
|
|
|
log('got scope:', scopeBody);
|
|
|
|
|
|
|
|
requireCalls.forEach(function (node, index) {
|
|
|
|
var nodePosition = findNodeIndexInScopeBody(scopeBody, node);
|
|
|
|
log('node position in scope:', nodePosition);
|
|
|
|
|
|
|
|
var statementWithRequireCall = scopeBody[nodePosition];
|
|
|
|
var nextStatement = scopeBody[nodePosition + 1];
|
|
|
|
var nextRequireCall = requireCalls[index + 1];
|
|
|
|
|
|
|
|
if (nextRequireCall && containsNodeOrEqual(statementWithRequireCall, nextRequireCall)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (nextStatement && (
|
|
|
|
!nextRequireCall || !containsNodeOrEqual(nextStatement, nextRequireCall))) {
|
|
|
|
|
|
|
|
checkForNewLine(statementWithRequireCall, nextStatement, 'require');
|
|
|
|
}
|
|
|
|
});
|
|
|
|
}return ProgramExit;}(),
|
|
|
|
FunctionDeclaration: incrementLevel,
|
|
|
|
FunctionExpression: incrementLevel,
|
|
|
|
ArrowFunctionExpression: incrementLevel,
|
|
|
|
BlockStatement: incrementLevel,
|
|
|
|
ObjectExpression: incrementLevel,
|
|
|
|
Decorator: incrementLevel,
|
|
|
|
'FunctionDeclaration:exit': decrementLevel,
|
|
|
|
'FunctionExpression:exit': decrementLevel,
|
|
|
|
'ArrowFunctionExpression:exit': decrementLevel,
|
|
|
|
'BlockStatement:exit': decrementLevel,
|
|
|
|
'ObjectExpression:exit': decrementLevel,
|
|
|
|
'Decorator:exit': decrementLevel };
|
|
|
|
|
|
|
|
}return create;}() };
|
|
|
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9uZXdsaW5lLWFmdGVyLWltcG9ydC5qcyJdLCJuYW1lcyI6WyJsb2ciLCJjb250YWluc05vZGVPckVxdWFsIiwib3V0ZXJOb2RlIiwiaW5uZXJOb2RlIiwicmFuZ2UiLCJnZXRTY29wZUJvZHkiLCJzY29wZSIsImJsb2NrIiwidHlwZSIsImJvZHkiLCJmaW5kTm9kZUluZGV4SW5TY29wZUJvZHkiLCJub2RlVG9GaW5kIiwiZmluZEluZGV4Iiwibm9kZSIsImdldExpbmVEaWZmZXJlbmNlIiwibmV4dE5vZGUiLCJsb2MiLCJzdGFydCIsImxpbmUiLCJlbmQiLCJpc0NsYXNzV2l0aERlY29yYXRvciIsImRlY29yYXRvcnMiLCJsZW5ndGgiLCJpc0V4cG9ydERlZmF1bHRDbGFzcyIsImRlY2xhcmF0aW9uIiwiaXNFeHBvcnROYW1lQ2xhc3MiLCJtb2R1bGUiLCJleHBvcnRzIiwibWV0YSIsImRvY3MiLCJ1cmwiLCJmaXhhYmxlIiwic2NoZW1hIiwiY3JlYXRlIiwiY29udGV4dCIsImxldmVsIiwicmVxdWlyZUNhbGxzIiwiY2hlY2tGb3JOZXdMaW5lIiwiY2xhc3NOb2RlIiwib3B0aW9ucyIsImNvdW50IiwibGluZURpZmZlcmVuY2UiLCJFWFBFQ1RFRF9MSU5FX0RJRkZFUkVOQ0UiLCJjb2x1bW4iLCJyZXBvcnQiLCJtZXNzYWdlIiwiZml4IiwiZml4ZXIiLCJpbnNlcnRUZXh0QWZ0ZXIiLCJyZXBlYXQiLCJpbmNyZW1lbnRMZXZlbCIsImRlY3JlbWVudExldmVsIiwiY2hlY2tJbXBvcnQiLCJwYXJlbnQiLCJub2RlUG9zaXRpb24iLCJpbmRleE9mIiwiaXNFeHBvcnQiLCJJbXBvcnREZWNsYXJhdGlvbiIsIlRTSW1wb3J0RXF1YWxzRGVjbGFyYXRpb24iLCJDYWxsRXhwcmVzc2lvbiIsInB1c2giLCJnZXRQaHlzaWNhbEZpbGVuYW1lIiwiZ2V0RmlsZW5hbWUiLCJzY29wZUJvZHkiLCJnZXRTY29wZSIsImZvckVhY2giLCJpbmRleCIsInN0YXRlbWVudFdpdGhSZXF1aXJlQ2FsbCIsIm5leHRTdGF0ZW1lbnQiLCJuZXh0UmVxdWlyZUNhbGwiLCJGdW5jdGlvbkRlY2xhcmF0aW9uIiwiRnVuY3Rpb25FeHByZXNzaW9uIiwiQXJyb3dGdW5jdGlvbkV4cHJlc3Npb24iLCJCbG9ja1N0YXRlbWVudCIsIk9iamVjdEV4cHJlc3Npb24iLCJEZWNvcmF0b3IiXSwibWFwcGluZ3MiOiI7Ozs7O0FBS0Esc0Q7QUFDQSxxQzs7QUFFQSw4QjtBQUNBLElBQU1BLE1BQU0sd0JBQU0saURBQU4sQ0FBWjs7QUFFQTtBQUNBO0FBQ0E7QUFiQTs7O0dBZUEsU0FBU0MsbUJBQVQsQ0FBNkJDLFNBQTdCLEVBQXdDQyxTQUF4QyxFQUFtRCxDQUNqRCxPQUFPRCxVQUFVRSxLQUFWLENBQWdCLENBQWhCLEtBQXNCRCxVQUFVQyxLQUFWLENBQWdCLENBQWhCLENBQXRCLElBQTRDRixVQUFVRSxLQUFWLENBQWdCLENBQWhCLEtBQXNCRCxVQUFVQyxLQUFWLENBQWdCLENBQWhCLENBQXpFLENBQ0Q7O0FBRUQsU0FBU0MsWUFBVCxDQUFzQkMsS0FBdEIsRUFBNkI7QUFDM0IsTUFBSUEsTUFBTUMsS0FBTixDQUFZQyxJQUFaLEtBQXFCLGlCQUF6QixFQUE0QztBQUMxQ1IsUUFBSSxzQ0FBSjtBQUNBLFdBQU8sSUFBUDtBQUNELEdBSjBCOztBQU1uQlMsTUFObUIsR0FNVkgsTUFBTUMsS0FOSSxDQU1uQkUsSUFObUI7QUFPM0IsTUFBSUEsUUFBUUEsS0FBS0QsSUFBTCxLQUFjLGdCQUExQixFQUE0QztBQUMxQyxXQUFPQyxLQUFLQSxJQUFaO0FBQ0Q7O0FBRUQsU0FBT0EsSUFBUDtBQUNEOztBQUVELFNBQVNDLHdCQUFULENBQWtDRCxJQUFsQyxFQUF3Q0UsVUFBeEMsRUFBb0Q7QUFDbEQsU0FBT0YsS0FBS0csU0FBTCxDQUFlLFVBQUNDLElBQUQsVUFBVVosb0JBQW9CWSxJQUFwQixFQUEwQkYsVUFBMUIsQ0FBVixFQUFmLENBQVA7QUFDRDs7QUFFRCxTQUFTRyxpQkFBVCxDQUEyQkQsSUFBM0IsRUFBaUNFLFFBQWpDLEVBQTJDO0FBQ3pDLFNBQU9BLFNBQVNDLEdBQVQsQ0FBYUMsS0FBYixDQUFtQkMsSUFBbkIsR0FBMEJMLEtBQUtHLEdBQUwsQ0FBU0csR0FBVCxDQUFhRCxJQUE5QztBQUNEOztBQUVELFNBQVNFLG9CQUFULENBQThCUCxJQUE5QixFQUFvQztBQUNsQyxTQUFPQSxLQUFLTCxJQUFMLEtBQWMsa0JBQWQsSUFBb0NLLEtBQUtRLFVBQXpDLElBQXVEUixLQUFLUSxVQUFMLENBQWdCQyxNQUE5RTtBQUNEOztBQUVELFNBQVNDLG9CQUFULENBQThCVixJQUE5QixFQUFvQztBQUNsQyxTQUFPQSxLQUFLTCxJQUFMLEtBQWMsMEJBQWQsSUFBNENLLEtBQUtXLFdBQUwsQ0FBaUJoQixJQUFqQixLQUEwQixrQkFBN0U7QUFDRDs7QUFFRCxTQUFTaUIsaUJBQVQsQ0FBMkJaLElBQTNCLEVBQWlDOztBQUUvQixTQUFPQSxLQUFLTCxJQUFMLEtBQWMsd0JBQWQsSUFBMENLLEtBQUtXLFdBQS9DLElBQThEWCxLQUFLVyxXQUFMLENBQWlCaEIsSUFBakIsS0FBMEIsa0JBQS9GO0FBQ0Q7O0FBRURrQixPQUFPQyxPQUFQLEdBQWlCO0FBQ2ZDLFFBQU07QUFDSnBCLFVBQU0sUUFERjtBQUVKcUIsVUFBTTtBQUNKQyxXQUFLLDBCQUFRLHNCQUFSLENBREQsRUFGRjs7QUFLSkMsYUFBUyxZQUxMO0FBTUpDLFlBQVE7QUFDTjtBQUNFLGNBQVEsUUFEVjtBQUVFLG9CQUFjO0FBQ1osaUJBQVM7QUFDUCxrQkFBUSxTQUREO0FBRVAscUJBQVcsQ0FGSixFQURHLEVBRmhCOzs7QUFRRSw4QkFBd0IsS0FSMUIsRUFETSxDQU5KLEVBRFM7Ozs7QUFvQmZDLFFBcEJlLCtCQW9CUkMsT0FwQlEsRUFvQkM7QUFDZCxVQUFJQyxRQUFRLENBQVo7QUFDQSxVQUFNQyxlQUFlLEVBQXJCOztBQUVBLGVBQVNDLGVBQVQsQ0FBeUJ4QixJQUF6QixFQUErQkUsUUFBL0IsRUFBeUNQLElBQXpDLEVBQStDO0FBQzdDLFlBQUllLHFCQUFxQlIsUUFBckIsS0FBa0NVLGtCQUFrQlYsUUFBbEIsQ0FBdEMsRUFBbUU7QUFDakUsY0FBTXVCLFlBQVl2QixTQUFTUyxXQUEzQjs7QUFFQSxjQUFJSixxQkFBcUJrQixTQUFyQixDQUFKLEVBQXFDO0FBQ25DdkIsdUJBQVd1QixVQUFVakIsVUFBVixDQUFxQixDQUFyQixDQUFYO0FBQ0Q7QUFDRixTQU5ELE1BTU8sSUFBSUQscUJBQXFCTCxRQUFyQixDQUFKLEVBQW9DO0FBQ3pDQSxxQkFBV0EsU0FBU00sVUFBVCxDQUFvQixDQUFwQixDQUFYO0FBQ0Q7O0FBRUQsWUFBTWtCLFVBQVVMLFFBQVFLLE9BQVIsQ0FBZ0IsQ0FBaEIsS0F
|