eslint-config-chain-able
Version:
an opinionated ESLint configuration
104 lines (91 loc) • 2.83 kB
JavaScript
/**
* @fileoverview Limit maximum of props on a single line in JSX
* @author Yannick Croissant
*/
;
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: 'Limit maximum of props on a single line in JSX',
category: 'Stylistic Issues',
recommended: false
},
fixable: 'code',
schema: [{
type: 'object',
properties: {
maximum: {
type: 'integer',
minimum: 1
},
when: {
type: 'string',
enum: ['always', 'multiline']
}
}
}]
},
create: function (context) {
var sourceCode = context.getSourceCode();
var configuration = context.options[0] || {};
var maximum = configuration.maximum || 1;
var when = configuration.when || 'always';
function getPropName(propNode) {
if (propNode.type === 'JSXSpreadAttribute') {
return sourceCode.getText(propNode.argument);
}
return propNode.name.name;
}
function generateFixFunction(line, max) {
var output = [];
var front = line[0].start;
var back = line[line.length - 1].end;
for (var i = 0; i < line.length; i += max) {
var nodes = line.slice(i, i + max);
output.push(nodes.reduce(function(prev, curr) {
if (prev === '') {
return sourceCode.getText(curr);
}
return `${prev} ${sourceCode.getText(curr)}`;
}, ''));
}
var code = output.join('\n');
return function(fixer) {
return fixer.replaceTextRange([front, back], code);
};
}
return {
JSXOpeningElement: function (node) {
if (!node.attributes.length) {
return;
}
if (when === 'multiline' && node.loc.start.line === node.loc.end.line) {
return;
}
var firstProp = node.attributes[0];
var linePartitionedProps = [[firstProp]];
node.attributes.reduce(function (last, decl) {
if (last.loc.end.line === decl.loc.start.line) {
linePartitionedProps[linePartitionedProps.length - 1].push(decl);
} else {
linePartitionedProps.push([decl]);
}
return decl;
});
linePartitionedProps.forEach(function (propsInLine) {
if (propsInLine.length > maximum) {
var name = getPropName(propsInLine[maximum]);
context.report({
node: propsInLine[maximum],
message: `Prop \`${name}\` must be placed on a new line`,
fix: generateFixFunction(propsInLine, maximum)
});
}
});
}
};
}
};