@wix/origami-lint 1.34.25 → 1.34.27

package/dist/rules/site-app/global-styles.js

@@ -1,6 +1,6 @@
 import { BREAKPOINT_AT_RULES, createCssFileReporter, describeAtRule, getCssChildren, getDashedId, getMixinId, getSegmentClass, getSelectorSegments, isCssIdentifier, isSafeCssIdentifier } from "../../rules-api/index.js";
 import { defineRule } from "./define-rule.js";
-const CHECKS = ['invalid_mixin_id', 'invalid_mixin_result', 'missing_parent_selector', 'bare_parent_selector', 'nested_style_rule', 'apply_at_result_root', 'nested_mixin', 'invalid_result_at_rule', 'invalid_parent_selector', 'conditional_global_style_link', 'invalid_linked_style_id', 'missing_linked_style', 'duplicate_global_style_link', 'link_with_values', 'missing_global_style_link'];
+const CHECKS = ['invalid_mixin_id', 'invalid_mixin_result', 'missing_parent_selector', 'bare_parent_selector', 'nested_style_rule', 'apply_at_result_root', 'nested_mixin', 'invalid_result_at_rule', 'invalid_parent_selector', 'conditional_global_style_link', 'invalid_linked_style_id', 'missing_linked_style', 'duplicate_global_style_link', 'link_with_values', 'missing_global_style_link', 'mixin_link_cycle'];
 export default defineRule({
     name: 'global-styles',
     checks: CHECKS,
@@ -22,9 +22,12 @@ function checkMixinsAndLinks(root, file, report) {
     const mixins = getCssChildren(root).filter((node) => node.type === 'atrule' && node.name === 'mixin');
     const rules = mixins.flatMap((mixin) => checkMixin(mixin, reportInFile));
     const declaredIds = new Set(mixins.flatMap((mixin) => getMixinId(mixin) ?? []));
-    const linkedParts = checkLinks(rules.filter((rule) => rule.apply), declaredIds, reportInFile);
+    const { linkedParts, validLinks } = checkLinks(rules.filter((rule) => rule.apply), declaredIds, reportInFile);
     for (const group of groupBySelector(rules))
         checkLinkOrValues(group, linkedParts, reportInFile);
+    // the build keeps the last `@mixin` of an id (mixins.js bodies.set): its links are the ones it follows
+    const lastMixinById = new Map(mixins.flatMap((mixin) => { const id = getMixinId(mixin); return id === null ? [] : [[id, mixin]]; }));
+    checkLinkCycles(validLinks.filter((link) => getEnclosingMixin(link.node) === lastMixinById.get(link.mixin)), reportInFile);
 }
 /** `@mixin --id { @result { … } }` (CONV-astParser.ts:287, :293), then its `@result`; returns its `&` rules that pass. */
 function checkMixin(mixin, reportInFile) {
@@ -107,6 +110,7 @@ function checkSelector(rule, reportInFile) {
 function checkLinks(links, declaredIds, reportInFile) {
     const linkedParts = new Set();
     const validLinkParts = new Set();
+    const validLinks = [];
     for (const link of links) {
         const child = link.apply.params.trim();
         const linkDescription = `\`@mixin --${link.mixin}\`'s link \`@apply ${child}\``;
@@ -135,8 +139,43 @@ function checkLinks(links, declaredIds, reportInFile) {
             continue;
         }
         validLinkParts.add(part);
+        validLinks.push(link);
     }
-    return linkedParts;
+    return { linkedParts, validLinks };
+}
+/** Reports each link that closes a cycle (OUR-007): a walk from each mixin in the file's order, depth first, visiting each mixin once; a link
+ * to a mixin still on the walk's path leads back to it. Every cycle holds such a link, so removing the reported ones breaks them all. */
+function checkLinkCycles(validLinks, reportInFile) {
+    const linksByMixin = new Map();
+    for (const link of validLinks)
+        linksByMixin.set(link.mixin, [...(linksByMixin.get(link.mixin) ?? []), link]);
+    const visited = new Set();
+    for (const start of linksByMixin.keys()) {
+        if (visited.has(start))
+            continue;
+        visited.add(start);
+        // the walk's path: each mixin on it, and how many of its links were followed
+        const path = [{ mixin: start, next: 0 }];
+        while (path.length > 0) {
+            const step = path.at(-1);
+            const link = linksByMixin.get(step.mixin)?.[step.next++];
+            if (!link) {
+                path.pop();
+                continue;
+            }
+            const child = getDashedId(link.apply.params);
+            const onPath = path.findIndex(({ mixin }) => mixin === child);
+            if (onPath !== -1)
+                reportCycle(link, child, [...path.slice(onPath).map(({ mixin }) => mixin), child], reportInFile);
+            else if (!visited.has(child)) {
+                visited.add(child);
+                path.push({ mixin: child, next: 0 });
+            }
+        }
+    }
+}
+function reportCycle(link, child, chain, reportInFile) {
+    reportInFile(link.apply, 'mixin_link_cycle', `\`@mixin --${link.mixin}\` links \`--${child}\`, which leads back to it: ${chain.map((id) => `--${id}`).join(' → ')}. A global style can't contain itself: remove this link, or link a style that doesn't lead back to \`--${child}\` (tracker OUR-007).`);
 }
 /** One selector of a mixin (across its breakpoints): a link alone, or values; values on an inner part where a link names it (CONV-styleParser.ts:803, :698). */
 function checkLinkOrValues(group, linkedParts, reportInFile) {
@@ -152,6 +191,13 @@ function checkLinkOrValues(group, linkedParts, reportInFile) {
     reportInFile(first.node, 'missing_global_style_link', `\`@mixin --${first.mixin}\` styles \`${part}\` but links no global style there: add \`& ${part} { @apply --<child> }\` and move the values to that child's @mixin (tracker CONV-styleParser.ts:698).`);
 }
 // ── reading a mixin ──
+/** The `@mixin` a rule of its `@result` sits in. */
+function getEnclosingMixin(rule) {
+    for (let node = rule.parent; node; node = node.parent)
+        if (node.type === 'atrule' && node.name === 'mixin')
+            return node;
+    return undefined;
+}
 /** The mixin's one `@result` with no params and a block, beside nothing; undefined otherwise. */
 function getResult(mixin) {
     if (mixin.nodes === undefined)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/origami-lint",
-  "version": "1.34.25",
+  "version": "1.34.27",
   "description": "Offline lint for an exported Origami site: lints the pages that changed since the last passing run",
   "type": "module",
   "bin": {
@@ -25,7 +25,7 @@
     "oxc-parser": "^0.151.0",
     "oxlint": "^1.39.0",
     "postcss": "^8.5.3",
-    "@wix/origami-bi": "0.12.0"
+    "@wix/origami-bi": "0.13.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
@@ -52,5 +52,5 @@
       ]
     }
   },
-  "falconPackageHash": "e4031adeef0d38fd736d432532a85f648531c1c89cff31aa089a0fad"
+  "falconPackageHash": "b4ea23b3bf64c300ff406d11fcb377f370fb48f7fdf2e92f3a66f7c9"
 }