170 lines
17 KiB
JavaScript
170 lines
17 KiB
JavaScript
|
'use strict';
|
||
|
|
||
|
var _staticRequire = require('../core/staticRequire');
|
||
|
|
||
|
var _staticRequire2 = _interopRequireDefault(_staticRequire);
|
||
|
|
||
|
var _docsUrl = require('../docsUrl');
|
||
|
|
||
|
var _docsUrl2 = _interopRequireDefault(_docsUrl);
|
||
|
|
||
|
var _debug = require('debug');
|
||
|
|
||
|
var _debug2 = _interopRequireDefault(_debug);
|
||
|
|
||
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
||
|
|
||
|
const log = (0, _debug2.default)('eslint-plugin-import:rules:newline-after-import');
|
||
|
|
||
|
//------------------------------------------------------------------------------
|
||
|
// 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;
|
||
|
}
|
||
|
|
||
|
const body = scope.block.body;
|
||
|
|
||
|
if (body && body.type === 'BlockStatement') {
|
||
|
return body.body;
|
||
|
}
|
||
|
|
||
|
return body;
|
||
|
}
|
||
|
|
||
|
function findNodeIndexInScopeBody(body, nodeToFind) {
|
||
|
return body.findIndex(node => containsNodeOrEqual(node, nodeToFind));
|
||
|
}
|
||
|
|
||
|
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;
|
||
|
}
|
||
|
|
||
|
module.exports = {
|
||
|
meta: {
|
||
|
type: 'layout',
|
||
|
docs: {
|
||
|
url: (0, _docsUrl2.default)('newline-after-import')
|
||
|
},
|
||
|
schema: [{
|
||
|
'type': 'object',
|
||
|
'properties': {
|
||
|
'count': {
|
||
|
'type': 'integer',
|
||
|
'minimum': 1
|
||
|
}
|
||
|
},
|
||
|
'additionalProperties': false
|
||
|
}],
|
||
|
fixable: 'whitespace'
|
||
|
},
|
||
|
create: function (context) {
|
||
|
let level = 0;
|
||
|
const requireCalls = [];
|
||
|
|
||
|
function checkForNewLine(node, nextNode, type) {
|
||
|
if (isClassWithDecorator(nextNode)) {
|
||
|
nextNode = nextNode.decorators[0];
|
||
|
}
|
||
|
|
||
|
const options = context.options[0] || { count: 1 };
|
||
|
const lineDifference = getLineDifference(node, nextNode);
|
||
|
const EXPECTED_LINE_DIFFERENCE = options.count + 1;
|
||
|
|
||
|
if (lineDifference < EXPECTED_LINE_DIFFERENCE) {
|
||
|
let column = node.loc.start.column;
|
||
|
|
||
|
if (node.loc.start.line !== node.loc.end.line) {
|
||
|
column = 0;
|
||
|
}
|
||
|
|
||
|
context.report({
|
||
|
loc: {
|
||
|
line: node.loc.end.line,
|
||
|
column
|
||
|
},
|
||
|
message: `Expected ${options.count} empty line${options.count > 1 ? 's' : ''} \
|
||
|
after ${type} statement not followed by another ${type}.`,
|
||
|
fix: fixer => fixer.insertTextAfter(node, '\n'.repeat(EXPECTED_LINE_DIFFERENCE - lineDifference))
|
||
|
});
|
||
|
}
|
||
|
}
|
||
|
|
||
|
function incrementLevel() {
|
||
|
level++;
|
||
|
}
|
||
|
function decrementLevel() {
|
||
|
level--;
|
||
|
}
|
||
|
|
||
|
return {
|
||
|
ImportDeclaration: function (node) {
|
||
|
const parent = node.parent;
|
||
|
|
||
|
const nodePosition = parent.body.indexOf(node);
|
||
|
const nextNode = parent.body[nodePosition + 1];
|
||
|
|
||
|
if (nextNode && nextNode.type !== 'ImportDeclaration') {
|
||
|
checkForNewLine(node, nextNode, 'import');
|
||
|
}
|
||
|
},
|
||
|
CallExpression: function (node) {
|
||
|
if ((0, _staticRequire2.default)(node) && level === 0) {
|
||
|
requireCalls.push(node);
|
||
|
}
|
||
|
},
|
||
|
'Program:exit': function () {
|
||
|
log('exit processing for', context.getFilename());
|
||
|
const scopeBody = getScopeBody(context.getScope());
|
||
|
log('got scope:', scopeBody);
|
||
|
|
||
|
requireCalls.forEach(function (node, index) {
|
||
|
const nodePosition = findNodeIndexInScopeBody(scopeBody, node);
|
||
|
log('node position in scope:', nodePosition);
|
||
|
|
||
|
const statementWithRequireCall = scopeBody[nodePosition];
|
||
|
const nextStatement = scopeBody[nodePosition + 1];
|
||
|
const nextRequireCall = requireCalls[index + 1];
|
||
|
|
||
|
if (nextRequireCall && containsNodeOrEqual(statementWithRequireCall, nextRequireCall)) {
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
if (nextStatement && (!nextRequireCall || !containsNodeOrEqual(nextStatement, nextRequireCall))) {
|
||
|
|
||
|
checkForNewLine(statementWithRequireCall, nextStatement, 'require');
|
||
|
}
|
||
|
});
|
||
|
},
|
||
|
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
|
||
|
};
|
||
|
}
|
||
|
};
|
||
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ydWxlcy9uZXdsaW5lLWFmdGVyLWltcG9ydC5qcyJdLCJuYW1lcyI6WyJsb2ciLCJjb250YWluc05vZGVPckVxdWFsIiwib3V0ZXJOb2RlIiwiaW5uZXJOb2RlIiwicmFuZ2UiLCJnZXRTY29wZUJvZHkiLCJzY29wZSIsImJsb2NrIiwidHlwZSIsImJvZHkiLCJmaW5kTm9kZUluZGV4SW5TY29wZUJvZHkiLCJub2RlVG9GaW5kIiwiZmluZEluZGV4Iiwibm9kZSIsImdldExpbmVEaWZmZXJlbmNlIiwibmV4dE5vZGUiLCJsb2MiLCJzdGFydCIsImxpbmUiLCJlbmQiLCJpc0NsYXNzV2l0aERlY29yYXRvciIsImRlY29yYXRvcnMiLCJsZW5ndGgiLCJtb2R1bGUiLCJleHBvcnRzIiwibWV0YSIsImRvY3MiLCJ1cmwiLCJzY2hlbWEiLCJmaXhhYmxlIiwiY3JlYXRlIiwiY29udGV4dCIsImxldmVsIiwicmVxdWlyZUNhbGxzIiwiY2hlY2tGb3JOZXdMaW5lIiwib3B0aW9ucyIsImNvdW50IiwibGluZURpZmZlcmVuY2UiLCJFWFBFQ1RFRF9MSU5FX0RJRkZFUkVOQ0UiLCJjb2x1bW4iLCJyZXBvcnQiLCJtZXNzYWdlIiwiZml4IiwiZml4ZXIiLCJpbnNlcnRUZXh0QWZ0ZXIiLCJyZXBlYXQiLCJpbmNyZW1lbnRMZXZlbCIsImRlY3JlbWVudExldmVsIiwiSW1wb3J0RGVjbGFyYXRpb24iLCJwYXJlbnQiLCJub2RlUG9zaXRpb24iLCJpbmRleE9mIiwiQ2FsbEV4cHJlc3Npb24iLCJwdXNoIiwiZ2V0RmlsZW5hbWUiLCJzY29wZUJvZHkiLCJnZXRTY29wZSIsImZvckVhY2giLCJpbmRleCIsInN0YXRlbWVudFdpdGhSZXF1aXJlQ2FsbCIsIm5leHRTdGF0ZW1lbnQiLCJuZXh0UmVxdWlyZUNhbGwiLCJGdW5jdGlvbkRlY2xhcmF0aW9uIiwiRnVuY3Rpb25FeHByZXNzaW9uIiwiQXJyb3dGdW5jdGlvbkV4cHJlc3Npb24iLCJCbG9ja1N0YXRlbWVudCIsIk9iamVjdEV4cHJlc3Npb24iLCJEZWNvcmF0b3IiXSwibWFwcGluZ3MiOiI7O0FBS0E7Ozs7QUFDQTs7OztBQUVBOzs7Ozs7QUFDQSxNQUFNQSxNQUFNLHFCQUFNLGlEQUFOLENBQVo7O0FBRUE7QUFDQTtBQUNBOztBQWJBOzs7OztBQWVBLFNBQVNDLG1CQUFULENBQTZCQyxTQUE3QixFQUF3Q0MsU0FBeEMsRUFBbUQ7QUFDL0MsU0FBT0QsVUFBVUUsS0FBVixDQUFnQixDQUFoQixLQUFzQkQsVUFBVUMsS0FBVixDQUFnQixDQUFoQixDQUF0QixJQUE0Q0YsVUFBVUUsS0FBVixDQUFnQixDQUFoQixLQUFzQkQsVUFBVUMsS0FBVixDQUFnQixDQUFoQixDQUF6RTtBQUNIOztBQUVELFNBQVNDLFlBQVQsQ0FBc0JDLEtBQXRCLEVBQTZCO0FBQ3pCLE1BQUlBLE1BQU1DLEtBQU4sQ0FBWUMsSUFBWixLQUFxQixpQkFBekIsRUFBNEM7QUFDMUNSLFFBQUksc0NBQUo7QUFDQSxXQUFPLElBQVA7QUFDRDs7QUFKd0IsUUFNakJTLElBTmlCLEdBTVJILE1BQU1DLEtBTkUsQ0FNakJFLElBTmlCOztBQU96QixNQUFJQSxRQUFRQSxLQUFLRCxJQUFMLEtBQWMsZ0JBQTFCLEVBQTRDO0FBQ3hDLFdBQU9DLEtBQUtBLElBQVo7QUFDSDs7QUFFRCxTQUFPQSxJQUFQO0FBQ0g7O0FBRUQsU0FBU0Msd0JBQVQsQ0FBa0NELElBQWxDLEVBQXdDRSxVQUF4QyxFQUFvRDtBQUNoRCxTQUFPRixLQUFLRyxTQUFMLENBQWdCQyxJQUFELElBQVVaLG9CQUFvQlksSUFBcEIsRUFBMEJGLFVBQTFCLENBQXpCLENBQVA7QUFDSDs7QUFFRCxTQUFTRyxpQkFBVCxDQUEyQkQsSUFBM0IsRUFBaUNFLFFBQWpDLEVBQTJDO0FBQ3pDLFNBQU9BLFNBQVNDLEdBQVQsQ0FBYUMsS0FBYixDQUFtQkMsSUFBbkIsR0FBMEJMLEtBQUtHLEdBQUwsQ0FBU0csR0FBVCxDQUFhRCxJQUE5QztBQUNEOztBQUVELFNBQVNFLG9CQUFULENBQThCUCxJQUE5QixFQUFvQztBQUNsQyxTQUFPQSxLQUFLTCxJQUFMLEtBQWMsa0JBQWQsSUFBb0NLLEtBQUtRLFVBQXpDLElBQXVEUixLQUFLUSxVQUFMLENBQWdCQyxNQUE5RTtBQUNEOztBQUVEQyxPQUFPQyxPQUFQLEdBQWlCO0FBQ2ZDLFFBQU07QUFDSmpCLFVBQU0sUUFERjtBQUVKa0IsVUFBTTtBQUNKQyxXQUFLLHVCQUFRLHNCQUFSO0FBREQsS0FGRjtBQUtKQyxZQUFRLENBQ047QUFDRSxjQUFRLFFBRFY7QUFFRSxvQkFBYztBQUNaLGlCQUFTO0FBQ1Asa0JBQVEsU0FERDtBQUVQLHFCQUFXO0FBRko7QUFERyxPQUZoQjtBQVFFLDhCQUF3QjtBQVIxQixLQURNLENBTEo7QUFpQkpDLGFBQVM7QUFqQkwsR0FEUztBQW9CZkMsVUFBUSxVQUFVQyxPQUFWLEVBQW1CO0FBQ3pCLFFBQUlDLFFBQVEsQ0FBWjtBQUNBLFVBQU1DLGVBQWUsRUFBckI7O0FBRUEsYUFBU0MsZUFBVCxDQUF5QnJCLElBQXpCLEVBQStCRSxRQUEvQixFQUF5Q1AsSUFBekMsRUFBK0M7QUFDN0MsVUFBSVkscUJBQXFCTCxRQUFyQixDQUFKLEVBQW9DO0FBQ2xDQSxtQkFBV0EsU0FBU00sVUFBVCxDQUFvQixDQUFwQixDQUFYO0FBQ0Q7O0FBRUQsWUFBTWMsVUFBVUosUUFBUUksT0FBUixDQUFnQixDQUFoQixLQUFzQixFQUFFQyxPQUFPLENBQVQsRUFBdEM7QUFDQSxZQUFNQyxpQkFBaUJ2QixrQkFBa0JELElBQWxCLEVBQXdCRSxRQUF4QixDQUF2QjtBQUNBLFlBQU11QiwyQkFBMkJILFFBQVFDLEtBQVIsR0FBZ0IsQ0FBakQ7O0FBRUEsVUFBSUMsaUJBQWlCQyx3QkFBckIsRUFBK0M7QUFDN0MsWUFBSUMsU0FBUzFCLEtBQUtHLEdBQUwsQ0FBU0MsS0FBVCxDQUFlc0IsTUFBNUI7O0FBRUEsWUFBSTFCLEtBQUtHLEdBQUwsQ0FBU0MsS0FBVCxDQUFlQyxJQUFmLEtBQXdCTCxLQUFLRyxHQUFMLENBQVNHLEdBQVQsQ0FBYUQsSUFBekMsRUFBK0M7QUFDN0NxQixtQkFBUyxDQUFUO0FBQ0Q7O0FBRURSLGdCQUFRUyxNQUFSLENBQWU7QUFDYnhCLGVBQUs7QUFDSEUsa0JBQU1MLEtBQUtHLEdBQUwsQ0FBU0csR0FBVCxDQUFhRCxJQURoQjtBQUVIcUI7QUFGRyxXQURRO0FBS2JFLG1CQUFVLFlBQVdOLFFBQVFDLEtBQU0sY0FBYUQsUUFBUUMsS0FBUixHQUFnQixDQUFoQixHQUFvQixHQUFwQixHQUEwQixFQUFHO1FBQy9FNUIsSUFBSyxzQ0FBcUNBLElBQUssR0FOaEM7QUFPYmtDLGVBQUtDLFNBQVNBLE1BQU1DLGVBQU4sQ0FDWi9CLElBRFksRUFFWixLQUFLZ0MsTUFBTCxDQUFZUCwyQkFBMkJ
|