123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 |
- /**
- * @fileoverview Validate JSX maximum depth
- * @author Chris<wfsr@foxmail.com>
- */
- 'use strict';
- const has = require('has');
- const includes = require('array-includes');
- const variableUtil = require('../util/variable');
- const jsxUtil = require('../util/jsx');
- const docsUrl = require('../util/docsUrl');
- // ------------------------------------------------------------------------------
- // Rule Definition
- // ------------------------------------------------------------------------------
- module.exports = {
- meta: {
- docs: {
- description: 'Validate JSX maximum depth',
- category: 'Stylistic Issues',
- recommended: false,
- url: docsUrl('jsx-max-depth')
- },
- messages: {
- wrongDepth: 'Expected the depth of nested jsx elements to be <= {{needed}}, but found {{found}}.'
- },
- schema: [
- {
- type: 'object',
- properties: {
- max: {
- type: 'integer',
- minimum: 0
- }
- },
- additionalProperties: false
- }
- ]
- },
- create(context) {
- const DEFAULT_DEPTH = 2;
- const option = context.options[0] || {};
- const maxDepth = has(option, 'max') ? option.max : DEFAULT_DEPTH;
- function isExpression(node) {
- return node.type === 'JSXExpressionContainer';
- }
- function hasJSX(node) {
- return jsxUtil.isJSX(node) || (isExpression(node) && jsxUtil.isJSX(node.expression));
- }
- function isLeaf(node) {
- const children = node.children;
- return !children || children.length === 0 || !children.some(hasJSX);
- }
- function getDepth(node) {
- let count = 0;
- while (jsxUtil.isJSX(node.parent) || isExpression(node.parent)) {
- node = node.parent;
- if (jsxUtil.isJSX(node)) {
- count++;
- }
- }
- return count;
- }
- function report(node, depth) {
- context.report({
- node,
- messageId: 'wrongDepth',
- data: {
- found: depth,
- needed: maxDepth
- }
- });
- }
- function findJSXElementOrFragment(variables, name, previousReferences) {
- function find(refs, prevRefs) {
- let i = refs.length;
- while (--i >= 0) {
- if (has(refs[i], 'writeExpr')) {
- const writeExpr = refs[i].writeExpr;
- return (jsxUtil.isJSX(writeExpr)
- && writeExpr)
- || ((writeExpr && writeExpr.type === 'Identifier')
- && findJSXElementOrFragment(variables, writeExpr.name, prevRefs));
- }
- }
- return null;
- }
- const variable = variableUtil.getVariable(variables, name);
- if (variable && variable.references) {
- const containDuplicates = previousReferences.some((ref) => includes(variable.references, ref));
- // Prevent getting stuck in circular references
- if (containDuplicates) {
- return false;
- }
- return find(variable.references, previousReferences.concat(variable.references));
- }
- return false;
- }
- function checkDescendant(baseDepth, children) {
- baseDepth++;
- (children || []).forEach((node) => {
- if (!hasJSX(node)) {
- return;
- }
- if (baseDepth > maxDepth) {
- report(node, baseDepth);
- } else if (!isLeaf(node)) {
- checkDescendant(baseDepth, node.children);
- }
- });
- }
- function handleJSX(node) {
- if (!isLeaf(node)) {
- return;
- }
- const depth = getDepth(node);
- if (depth > maxDepth) {
- report(node, depth);
- }
- }
- return {
- JSXElement: handleJSX,
- JSXFragment: handleJSX,
- JSXExpressionContainer(node) {
- if (node.expression.type !== 'Identifier') {
- return;
- }
- const variables = variableUtil.variablesInScope(context);
- const element = findJSXElementOrFragment(variables, node.expression.name, []);
- if (element) {
- const baseDepth = getDepth(node);
- checkDescendant(baseDepth, element.children);
- }
- }
- };
- }
- };
|