File size: 2,335 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | /**
* @file Ensure JSX className adheres to BEM CSS naming conventions.
* @author Automattic
* @copyright 2022 Automattic. All rights reserved.
* See LICENSE.md file in root directory for full license.
*/
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const namePattern = new RegExp( `^[a-z0-9-]+(__[a-z0-9-]+)?$` );
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
const rule = ( module.exports = function ( context ) {
function isRenderCallExpression( node ) {
if ( 'CallExpression' !== node.type ) {
return false;
}
let calleeName;
if ( 'MemberExpression' === node.callee.type ) {
calleeName = node.callee.property.name;
} else if ( 'Identifier' === node.callee.type ) {
calleeName = node.callee.name;
}
return calleeName && 'render' === calleeName;
}
function isInRenderCallExpession( node ) {
for ( let parent = node; parent; parent = parent.parent ) {
if ( isRenderCallExpression( parent ) ) {
return true;
}
}
return false;
}
return {
JSXAttribute: function ( node ) {
if ( 'className' !== node.name.name ) {
return;
}
let rawClassName;
if ( 'JSXExpressionContainer' === node.value.type ) {
rawClassName = node.value.expression;
} else {
rawClassName = node.value;
}
if ( 'Literal' !== rawClassName.type || 'string' !== typeof rawClassName.value ) {
return;
}
// we don't validate elements inside `ReactDOM.render` expressions
if ( isInRenderCallExpession( node ) ) {
return;
}
// Extract class names into an array.
const classNames = rawClassName.value.split( ' ' );
const isError = ! classNames.some( ( className ) => namePattern.test( className ) );
if ( ! isError ) {
return;
}
context.report( {
node,
message: rule.ERROR_MESSAGE,
} );
},
};
} );
rule.ERROR_MESSAGE = 'className should adhere to BEM convention';
rule.schema = [
{
type: 'object',
properties: {
rootFiles: {
type: 'array',
minItems: 1,
items: {
type: 'string',
},
},
},
additionalProperties: false,
},
];
|