@wix/origami-lint 1.34.3 → 1.34.4

package/dist/rules/page-structure.js

@@ -6,6 +6,8 @@
 // recognized by import source (rulesApi.getType), so renaming an import doesn't matter.
 // Checked in every file, pages and global components alike:
 // - Structure returns one element, with a string id (tracker CONV-runValidation.ts:9);
+// - every section, wherever it sits (a page's, a global component's top one, one nested lower down), holds exactly one
+//   <InternalContainer> and nothing else: the site's own build refuses anything else (rule S2-SECTION-001, tracker OUR-001);
 // - a <Page> is only ever the top of its own page: one held by another element is refused at save (rule card P1-R16);
 // - the header and footer sit outside every <InternalContainer>: inside one, that container can no longer be deleted in the
 //   editor (rule card P1-R03). Both the HeaderSection / FooterSection tags and a page's reference to the global ones;
@@ -38,6 +40,8 @@ export default defineRule({
             if (isLandmark(input.node, input.rulesApi))
                 hasSectionInLandmark(input);
             hasOnlyElements(input);
+            if (isSection(input.node, input.rulesApi))
+                hasOneInternalContainer(input.node, input);
             hasLayerArrays(input);
             isNotNestedPage(input);
             isOutsideInternalContainers(input);
@@ -50,8 +54,7 @@ export default defineRule({
                 return;
             if (!startsWithPage(input))
                 return;
-            for (const section of getSections(input))
-                hasOneInternalContainer(section, input);
+            checkPageChildren(input);
         },
     },
 });
@@ -94,29 +97,25 @@ function startsWithPage({ node, rulesApi, report }) {
     report({ loc: getLoc(node, rulesApi), message: `A page must start with <Page>, found ${describe(node, rulesApi)}.` });
     return false;
 }
-/** <Page>'s sections. Any other component (the page's <Background>, a pinned element) is accepted, as the import accepts it; reports text and {…} (CONV-parseJsx.ts:1668). */
-function getSections({ node: page, rulesApi, report }) {
-    const sections = [];
+/** Reports text and {…} directly in <Page> (CONV-parseJsx.ts:1668). Any component is accepted there: a section, the page's <Background>, a pinned element, as the import accepts it. */
+function checkPageChildren({ node: page, rulesApi, report }) {
     for (const child of getStructuralChildren(page, rulesApi)) {
-        if (child.type === 'JSXElement') {
-            const type = rulesApi.getType(child);
-            if (type && SECTIONS.includes(type))
-                sections.push(child);
+        if (child.type === 'JSXElement')
             continue;
-        }
         report({ loc: getLoc(page, rulesApi), message: `<Page> has ${describe(child, rulesApi)} as a child. Only elements go directly inside <Page>: a section, or a component pinned to the page (tracker CONV-parseJsx.ts:1668).` });
     }
-    return sections;
 }
-/** Reports a section that doesn't hold exactly one <InternalContainer>, and nothing else. A wrapper in it that holds the wrong number of elements is reported by its own step first. */
+/** Reports a section, anywhere in the file, that doesn't hold exactly one <InternalContainer>, and nothing else (S2-SECTION-001, OUR-001). A wrapper in it
+ * that holds the wrong number of elements is reported by its own step first; text and {…} count only where hasOnlyElements leaves them to this step. */
 function hasOneInternalContainer(section, { rulesApi, report }) {
     if (rulesApi.getChildren(section).some((child) => child.type === 'JSXElement' && isWrapper(child, rulesApi) && !holdsOne(child)))
         return;
-    const inside = getStructuralChildren(section, rulesApi);
+    const reportsText = isRootTreeHolder(section, rulesApi);
+    const inside = getStructuralChildren(section, rulesApi).filter((child) => reportsText || child.type === 'JSXElement');
     if (inside.length === 1 && inside[0].type === 'JSXElement' && rulesApi.getType(inside[0]) === 'innerElement')
         return;
     const name = rulesApi.getId(section) ?? `<${rulesApi.getTagName(section)}>`;
-    report({ loc: getLoc(section, rulesApi), message: `Section ${name} must contain exactly one <InternalContainer>, found: ${inside.map((child) => describe(child, rulesApi)).join(', ') || 'nothing'}.` });
+    report({ loc: getLoc(section, rulesApi), message: `Section ${name} must contain exactly one <InternalContainer>, found: ${inside.map((child) => describe(child, rulesApi)).join(', ') || 'nothing'}. Put the section's content inside its one <InternalContainer> (rule S2-SECTION-001).` });
 }
 /** Reports a <Page> held by another element (P1-R16), unless the root steps above report that placement already (a section's children). */
 function isNotNestedPage({ node, rulesApi, report }) {
@@ -250,6 +249,11 @@ function describe(child, rulesApi) {
         return `<${rulesApi.getTagName(child)}>`;
     return child.type === 'JSXText' ? 'text' : 'a {…} expression';
 }
+/** Section, HeaderSection, FooterSection (by import source); not a page's reference to a global one. */
+function isSection(node, rulesApi) {
+    const type = rulesApi.getType(node);
+    return type !== null && SECTIONS.includes(type);
+}
 function isLandmark(node, rulesApi) {
     const type = rulesApi.getType(node);
     return type === 'headerLandmark' || type === 'footerLandmark';
@@ -259,10 +263,8 @@ function hasSectionInLandmark(input) {
     const { node, rulesApi, report } = input;
     const expected = rulesApi.getType(node) === 'headerLandmark' ? 'header' : 'footer';
     const children = getStructuralChildren(node, rulesApi);
-    if (children.length === 1 && children[0].type === 'JSXElement' && rulesApi.getType(children[0]) === expected) {
-        hasOneInternalContainer(children[0], input);
+    if (children.length === 1 && children[0].type === 'JSXElement' && rulesApi.getType(children[0]) === expected)
         return;
-    }
     report({ loc: getLoc(node, rulesApi), message: `<${rulesApi.getTagName(node)}> must contain exactly one ${expected === 'header' ? 'HeaderSection' : 'FooterSection'}.` });
 }
 function receivesInstanceId(node) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/origami-lint",
-  "version": "1.34.3",
+  "version": "1.34.4",
   "description": "Offline lint for an exported Origami site: lints the pages that changed since the last passing run",
   "type": "module",
   "bin": {
@@ -51,5 +51,5 @@
       ]
     }
   },
-  "falconPackageHash": "162134940d5c0140fe1b81ff9111d25a7f98f0201dfbbc32130245ca"
+  "falconPackageHash": "dae194e28b366afdeb725197b97b0f1659346d4dbe5cea8e1659dab4"
 }