160 lines
4.9 KiB
JavaScript
160 lines
4.9 KiB
JavaScript
/**
|
|
* @fileoverview Validate props indentation in JSX
|
|
* @author Yannick Croissant
|
|
|
|
* This rule has been ported and modified from eslint and nodeca.
|
|
* @author Vitaly Puzrin
|
|
* @author Gyandeep Singh
|
|
* @copyright 2015 Vitaly Puzrin. All rights reserved.
|
|
* @copyright 2015 Gyandeep Singh. All rights reserved.
|
|
Copyright (C) 2014 by Vitaly Puzrin
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the 'Software'), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const astUtil = require('../util/ast');
|
|
const docsUrl = require('../util/docsUrl');
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Rule Definition
|
|
// ------------------------------------------------------------------------------
|
|
module.exports = {
|
|
meta: {
|
|
docs: {
|
|
description: 'Validate props indentation in JSX',
|
|
category: 'Stylistic Issues',
|
|
recommended: false,
|
|
url: docsUrl('jsx-indent-props')
|
|
},
|
|
fixable: 'code',
|
|
|
|
schema: [{
|
|
oneOf: [{
|
|
enum: ['tab', 'first']
|
|
}, {
|
|
type: 'integer'
|
|
}]
|
|
}]
|
|
},
|
|
|
|
create(context) {
|
|
const MESSAGE = 'Expected indentation of {{needed}} {{type}} {{characters}} but found {{gotten}}.';
|
|
|
|
const extraColumnStart = 0;
|
|
let indentType = 'space';
|
|
/** @type {number|'first'} */
|
|
let indentSize = 4;
|
|
|
|
if (context.options.length) {
|
|
if (context.options[0] === 'first') {
|
|
indentSize = 'first';
|
|
indentType = 'space';
|
|
} else if (context.options[0] === 'tab') {
|
|
indentSize = 1;
|
|
indentType = 'tab';
|
|
} else if (typeof context.options[0] === 'number') {
|
|
indentSize = context.options[0];
|
|
indentType = 'space';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Reports a given indent violation and properly pluralizes the message
|
|
* @param {ASTNode} node Node violating the indent rule
|
|
* @param {Number} needed Expected indentation character count
|
|
* @param {Number} gotten Indentation character count in the actual node/code
|
|
*/
|
|
function report(node, needed, gotten) {
|
|
const msgContext = {
|
|
needed,
|
|
type: indentType,
|
|
characters: needed === 1 ? 'character' : 'characters',
|
|
gotten
|
|
};
|
|
|
|
context.report({
|
|
node,
|
|
message: MESSAGE,
|
|
data: msgContext,
|
|
fix(fixer) {
|
|
return fixer.replaceTextRange([node.range[0] - node.loc.start.column, node.range[0]],
|
|
Array(needed + 1).join(indentType === 'space' ? ' ' : '\t'));
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get node indent
|
|
* @param {ASTNode} node Node to examine
|
|
* @return {Number} Indent
|
|
*/
|
|
function getNodeIndent(node) {
|
|
let src = context.getSourceCode().getText(node, node.loc.start.column + extraColumnStart);
|
|
const lines = src.split('\n');
|
|
src = lines[0];
|
|
|
|
let regExp;
|
|
if (indentType === 'space') {
|
|
regExp = /^[ ]+/;
|
|
} else {
|
|
regExp = /^[\t]+/;
|
|
}
|
|
|
|
const indent = regExp.exec(src);
|
|
return indent ? indent[0].length : 0;
|
|
}
|
|
|
|
/**
|
|
* Check indent for nodes list
|
|
* @param {ASTNode[]} nodes list of node objects
|
|
* @param {Number} indent needed indent
|
|
*/
|
|
function checkNodesIndent(nodes, indent) {
|
|
nodes.forEach((node) => {
|
|
const nodeIndent = getNodeIndent(node);
|
|
if (
|
|
node.type !== 'ArrayExpression' && node.type !== 'ObjectExpression' &&
|
|
nodeIndent !== indent && astUtil.isNodeFirstInLine(context, node)
|
|
) {
|
|
report(node, indent, nodeIndent);
|
|
}
|
|
});
|
|
}
|
|
|
|
return {
|
|
JSXOpeningElement(node) {
|
|
if (!node.attributes.length) {
|
|
return;
|
|
}
|
|
let propIndent;
|
|
if (indentSize === 'first') {
|
|
const firstPropNode = node.attributes[0];
|
|
propIndent = firstPropNode.loc.start.column;
|
|
} else {
|
|
const elementIndent = getNodeIndent(node);
|
|
propIndent = elementIndent + indentSize;
|
|
}
|
|
checkNodesIndent(node.attributes, propIndent);
|
|
}
|
|
};
|
|
}
|
|
};
|