123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113 |
- /**
- * @fileoverview Limit maximum of props on a single line in JSX
- * @author Yannick Croissant
- */
- 'use strict';
- const docsUrl = require('../util/docsUrl');
- // ------------------------------------------------------------------------------
- // Rule Definition
- // ------------------------------------------------------------------------------
- module.exports = {
- meta: {
- docs: {
- description: 'Limit maximum of props on a single line in JSX',
- category: 'Stylistic Issues',
- recommended: false,
- url: docsUrl('jsx-max-props-per-line')
- },
- fixable: 'code',
- messages: {
- newLine: 'Prop `{{prop}}` must be placed on a new line'
- },
- schema: [{
- type: 'object',
- properties: {
- maximum: {
- type: 'integer',
- minimum: 1
- },
- when: {
- type: 'string',
- enum: ['always', 'multiline']
- }
- }
- }]
- },
- create(context) {
- const configuration = context.options[0] || {};
- const maximum = configuration.maximum || 1;
- const when = configuration.when || 'always';
- function getPropName(propNode) {
- if (propNode.type === 'JSXSpreadAttribute') {
- return context.getSourceCode().getText(propNode.argument);
- }
- return propNode.name.name;
- }
- function generateFixFunction(line, max) {
- const sourceCode = context.getSourceCode();
- const output = [];
- const front = line[0].range[0];
- const back = line[line.length - 1].range[1];
- for (let i = 0; i < line.length; i += max) {
- const nodes = line.slice(i, i + max);
- output.push(nodes.reduce((prev, curr) => {
- if (prev === '') {
- return sourceCode.getText(curr);
- }
- return `${prev} ${sourceCode.getText(curr)}`;
- }, ''));
- }
- const code = output.join('\n');
- return function fix(fixer) {
- return fixer.replaceTextRange([front, back], code);
- };
- }
- return {
- JSXOpeningElement(node) {
- if (!node.attributes.length) {
- return;
- }
- if (when === 'multiline' && node.loc.start.line === node.loc.end.line) {
- return;
- }
- const firstProp = node.attributes[0];
- const linePartitionedProps = [[firstProp]];
- node.attributes.reduce((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((propsInLine) => {
- if (propsInLine.length > maximum) {
- const name = getPropName(propsInLine[maximum]);
- context.report({
- node: propsInLine[maximum],
- messageId: 'newLine',
- data: {
- prop: name
- },
- fix: generateFixFunction(propsInLine, maximum)
- });
- }
- });
- }
- };
- }
- };
|