mirror of
https://github.com/antebudimir/eslint-plugin-vanilla-extract.git
synced 2026-06-27 15:10:47 +00:00
Ante Budimir
175ce9aef8
Add comprehensive rule to detect and prevent empty CSS style blocks: - Identify style objects with no properties - Flag empty style blocks as potential code quality issues - Provide auto-fix capability to remove empty blocks - Handle edge cases like comments-only blocks This rule helps maintain cleaner codebases by eliminating empty style definitions that often result from incomplete refactoring or forgotten implementations, reducing confusion and unnecessary code.
72 lines
3.4 KiB
TypeScript
72 lines
3.4 KiB
TypeScript
import type { Rule } from 'eslint';
|
|
import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
|
|
import { concentricGroups } from '../concentric-order/concentric-groups.js';
|
|
import { createCSSPropertyPriorityMap } from '../shared-utils/css-property-priority-map.js';
|
|
import { isSelectorsObject, processNestedSelectors } from '../shared-utils/nested-selectors-processor.js';
|
|
import { getPropertyNameForSorting, separateProperties } from '../shared-utils/property-separator.js';
|
|
import { enforceCustomGroupOrder } from './property-order-enforcer.js';
|
|
import type { CSSPropertyInfo, SortRemainingProperties } from '../concentric-order/types.js';
|
|
|
|
/**
|
|
* Enforces a custom ordering of CSS properties based on user-defined groups in a given style object.
|
|
*
|
|
* @param context The ESLint rule context for reporting and fixing issues.
|
|
* @param styleObject The ObjectExpression node representing the style object to be processed.
|
|
* @param userDefinedGroups An array of property groups in the desired order.
|
|
* @param sortRemainingProperties Strategy for sorting properties not in user-defined groups ('alphabetical' or 'concentric'). Defaults to 'concentric'.
|
|
*
|
|
* This function:
|
|
* 1. Validates the input styleObject.
|
|
* 2. Handles 'selectors' objects separately, processing their nested style objects.
|
|
* 3. Creates a priority map based on user-defined groups.
|
|
* 4. Processes regular properties, creating a list of CSSPropertyInfo objects.
|
|
* 5. Enforces custom group ordering on the properties.
|
|
* 6. Recursively processes nested selectors and style objects.
|
|
*/
|
|
export const enforceUserDefinedGroupOrderInStyleObject = (
|
|
ruleContext: Rule.RuleContext,
|
|
styleObject: TSESTree.ObjectExpression,
|
|
userDefinedGroups: string[],
|
|
sortRemainingProperties: SortRemainingProperties = 'concentric',
|
|
): void => {
|
|
if (styleObject?.type === AST_NODE_TYPES.ObjectExpression) {
|
|
if (isSelectorsObject(styleObject)) {
|
|
styleObject.properties.forEach((property) => {
|
|
if (property.type === AST_NODE_TYPES.Property && property.value.type === AST_NODE_TYPES.ObjectExpression) {
|
|
enforceUserDefinedGroupOrderInStyleObject(
|
|
ruleContext,
|
|
property.value,
|
|
userDefinedGroups,
|
|
sortRemainingProperties,
|
|
);
|
|
}
|
|
});
|
|
return;
|
|
}
|
|
|
|
const cssPropertyPriorityMap = createCSSPropertyPriorityMap(userDefinedGroups);
|
|
|
|
const { regularProperties } = separateProperties(styleObject.properties);
|
|
const cssPropertyInfoList: CSSPropertyInfo[] = regularProperties.map((property) => {
|
|
const propertyName = getPropertyNameForSorting(property);
|
|
const propertyInfo = cssPropertyPriorityMap.get(propertyName);
|
|
const group =
|
|
userDefinedGroups.find((groupName) => concentricGroups[groupName]?.includes(propertyName)) || 'remaining';
|
|
|
|
return {
|
|
name: propertyName,
|
|
node: property,
|
|
priority: propertyInfo?.groupIndex ?? Number.MAX_SAFE_INTEGER,
|
|
positionInGroup: propertyInfo?.positionInGroup ?? Number.MAX_SAFE_INTEGER,
|
|
group,
|
|
inUserGroup: propertyInfo?.inUserGroup ?? false,
|
|
};
|
|
});
|
|
|
|
enforceCustomGroupOrder(ruleContext, cssPropertyInfoList, userDefinedGroups, sortRemainingProperties);
|
|
|
|
processNestedSelectors(ruleContext, styleObject, (nestedContext, nestedNode) =>
|
|
enforceUserDefinedGroupOrderInStyleObject(nestedContext, nestedNode, userDefinedGroups, sortRemainingProperties),
|
|
);
|
|
}
|
|
};
|